Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Ibm Provider
  3. API Docs
  4. SatelliteLocation
ibm 1.77.1 published on Monday, Apr 14, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm

ibm.SatelliteLocation

Explore with Pulumi AI

ibm logo
ibm 1.77.1 published on Monday, Apr 14, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm

    Create, update, or delete IBM Cloud Satellite Location. Set up an IBM Cloud Satellite location to represent a data center that you fill with your own infrastructure resources, and start running IBM Cloud services on your own infrastructure. Create, update, or delete IBM Cloud Satellite Host. Set up an IBM Cloud Satellite location to represent a data center in your infrastructure resources, and start running IBM Cloud services on your own infrastructure.

    Example Usage

    Sample to create location

    import * as pulumi from "@pulumi/pulumi";
import * as ibm from "@pulumi/ibm";

const group = ibm.getResourceGroup({
    name: "Default",
});
const createLocation = new ibm.SatelliteLocation("createLocation", {
    location: _var.location,
    physicalAddress: "Example-road 10, 11011 Example-place, Example-country",
    capabilities: ["on-prem"],
    zones: _var.location_zones,
    managedFrom: _var.managed_from,
    resourceGroupId: group.then(group => group.id),
});

    import pulumi
import pulumi_ibm as ibm

group = ibm.get_resource_group(name="Default")
create_location = ibm.SatelliteLocation("createLocation",
    location=var["location"],
    physical_address="Example-road 10, 11011 Example-place, Example-country",
    capabilities=["on-prem"],
    zones=var["location_zones"],
    managed_from=var["managed_from"],
    resource_group_id=group.id)

    package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/ibm/ibm"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		group, err := ibm.LookupResourceGroup(ctx, &ibm.LookupResourceGroupArgs{
			Name: pulumi.StringRef("Default"),
		}, nil)
		if err != nil {
			return err
		}
		_, err = ibm.NewSatelliteLocation(ctx, "createLocation", &ibm.SatelliteLocationArgs{
			Location:        pulumi.Any(_var.Location),
			PhysicalAddress: pulumi.String("Example-road 10, 11011 Example-place, Example-country"),
			Capabilities: pulumi.StringArray{
				pulumi.String("on-prem"),
			},
			Zones:           pulumi.Any(_var.Location_zones),
			ManagedFrom:     pulumi.Any(_var.Managed_from),
			ResourceGroupId: pulumi.String(group.Id),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Ibm = Pulumi.Ibm;

return await Deployment.RunAsync(() => 
{
    var @group = Ibm.GetResourceGroup.Invoke(new()
    {
        Name = "Default",
    });

    var createLocation = new Ibm.SatelliteLocation("createLocation", new()
    {
        Location = @var.Location,
        PhysicalAddress = "Example-road 10, 11011 Example-place, Example-country",
        Capabilities = new[]
        {
            "on-prem",
        },
        Zones = @var.Location_zones,
        ManagedFrom = @var.Managed_from,
        ResourceGroupId = @group.Apply(@group => @group.Apply(getResourceGroupResult => getResourceGroupResult.Id)),
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ibm.IbmFunctions;
import com.pulumi.ibm.inputs.GetResourceGroupArgs;
import com.pulumi.ibm.SatelliteLocation;
import com.pulumi.ibm.SatelliteLocationArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var group = IbmFunctions.getResourceGroup(GetResourceGroupArgs.builder()
            .name("Default")
            .build());

        var createLocation = new SatelliteLocation("createLocation", SatelliteLocationArgs.builder()
            .location(var_.location())
            .physicalAddress("Example-road 10, 11011 Example-place, Example-country")
            .capabilities("on-prem")
            .zones(var_.location_zones())
            .managedFrom(var_.managed_from())
            .resourceGroupId(group.applyValue(getResourceGroupResult -> getResourceGroupResult.id()))
            .build());

    }
}

    resources:
  createLocation:
    type: ibm:SatelliteLocation
    properties:
      location: ${var.location}
      physicalAddress: Example-road 10, 11011 Example-place, Example-country
      capabilities:
        - on-prem
      zones: ${var.location_zones}
      managedFrom: ${var.managed_from}
      resourceGroupId: ${group.id}
variables:
  group:
    fn::invoke:
      function: ibm:getResourceGroup
      arguments:
        name: Default

    Sample to create location by using COS bucket

    import * as pulumi from "@pulumi/pulumi";
import * as ibm from "@pulumi/ibm";

const createLocation = new ibm.SatelliteLocation("createLocation", {
    location: _var.location,
    zones: _var.location_zones,
    managedFrom: _var.managed_from,
    cosConfig: {
        bucket: _var.cos_bucket,
    },
});

    import pulumi
import pulumi_ibm as ibm

create_location = ibm.SatelliteLocation("createLocation",
    location=var["location"],
    zones=var["location_zones"],
    managed_from=var["managed_from"],
    cos_config={
        "bucket": var["cos_bucket"],
    })

    package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/ibm/ibm"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ibm.NewSatelliteLocation(ctx, "createLocation", &ibm.SatelliteLocationArgs{
			Location:    pulumi.Any(_var.Location),
			Zones:       pulumi.Any(_var.Location_zones),
			ManagedFrom: pulumi.Any(_var.Managed_from),
			CosConfig: &ibm.SatelliteLocationCosConfigArgs{
				Bucket: pulumi.Any(_var.Cos_bucket),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Ibm = Pulumi.Ibm;

return await Deployment.RunAsync(() => 
{
    var createLocation = new Ibm.SatelliteLocation("createLocation", new()
    {
        Location = @var.Location,
        Zones = @var.Location_zones,
        ManagedFrom = @var.Managed_from,
        CosConfig = new Ibm.Inputs.SatelliteLocationCosConfigArgs
        {
            Bucket = @var.Cos_bucket,
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ibm.SatelliteLocation;
import com.pulumi.ibm.SatelliteLocationArgs;
import com.pulumi.ibm.inputs.SatelliteLocationCosConfigArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var createLocation = new SatelliteLocation("createLocation", SatelliteLocationArgs.builder()
            .location(var_.location())
            .zones(var_.location_zones())
            .managedFrom(var_.managed_from())
            .cosConfig(SatelliteLocationCosConfigArgs.builder()
                .bucket(var_.cos_bucket())
                .build())
            .build());

    }
}

    resources:
  createLocation:
    type: ibm:SatelliteLocation
    properties:
      location: ${var.location}
      zones: ${var.location_zones}
      managedFrom: ${var.managed_from}
      cosConfig:
        bucket: ${var.cos_bucket}

    Sample to create location and specify pod- and service subnet

    import * as pulumi from "@pulumi/pulumi";
import * as ibm from "@pulumi/ibm";

const group = ibm.getResourceGroup({
    name: "Default",
});
const createLocation = new ibm.SatelliteLocation("createLocation", {
    location: _var.location,
    zones: _var.location_zones,
    managedFrom: _var.managed_from,
    resourceGroupId: group.then(group => group.id),
    podSubnet: _var.pod_subnet,
    serviceSubnet: _var.service_subnet,
});
// "192.168.42.0/24"

    import pulumi
import pulumi_ibm as ibm

group = ibm.get_resource_group(name="Default")
create_location = ibm.SatelliteLocation("createLocation",
    location=var["location"],
    zones=var["location_zones"],
    managed_from=var["managed_from"],
    resource_group_id=group.id,
    pod_subnet=var["pod_subnet"],
    service_subnet=var["service_subnet"])
# "192.168.42.0/24"

    package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/ibm/ibm"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		group, err := ibm.LookupResourceGroup(ctx, &ibm.LookupResourceGroupArgs{
			Name: pulumi.StringRef("Default"),
		}, nil)
		if err != nil {
			return err
		}
		_, err = ibm.NewSatelliteLocation(ctx, "createLocation", &ibm.SatelliteLocationArgs{
			Location:        pulumi.Any(_var.Location),
			Zones:           pulumi.Any(_var.Location_zones),
			ManagedFrom:     pulumi.Any(_var.Managed_from),
			ResourceGroupId: pulumi.String(group.Id),
			PodSubnet:       pulumi.Any(_var.Pod_subnet),
			ServiceSubnet:   pulumi.Any(_var.Service_subnet),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Ibm = Pulumi.Ibm;

return await Deployment.RunAsync(() => 
{
    var @group = Ibm.GetResourceGroup.Invoke(new()
    {
        Name = "Default",
    });

    var createLocation = new Ibm.SatelliteLocation("createLocation", new()
    {
        Location = @var.Location,
        Zones = @var.Location_zones,
        ManagedFrom = @var.Managed_from,
        ResourceGroupId = @group.Apply(@group => @group.Apply(getResourceGroupResult => getResourceGroupResult.Id)),
        PodSubnet = @var.Pod_subnet,
        ServiceSubnet = @var.Service_subnet,
    });

    // "192.168.42.0/24"
});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ibm.IbmFunctions;
import com.pulumi.ibm.inputs.GetResourceGroupArgs;
import com.pulumi.ibm.SatelliteLocation;
import com.pulumi.ibm.SatelliteLocationArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var group = IbmFunctions.getResourceGroup(GetResourceGroupArgs.builder()
            .name("Default")
            .build());

        var createLocation = new SatelliteLocation("createLocation", SatelliteLocationArgs.builder()
            .location(var_.location())
            .zones(var_.location_zones())
            .managedFrom(var_.managed_from())
            .resourceGroupId(group.applyValue(getResourceGroupResult -> getResourceGroupResult.id()))
            .podSubnet(var_.pod_subnet())
            .serviceSubnet(var_.service_subnet())
            .build());

        // "192.168.42.0/24"
    }
}

    resources:
  createLocation:
    type: ibm:SatelliteLocation
    properties:
      location: ${var.location}
      zones: ${var.location_zones}
      managedFrom: ${var.managed_from}
      resourceGroupId: ${group.id}
      podSubnet: ${var.pod_subnet}
      # "10.42.0.0/16"
      serviceSubnet: ${var.service_subnet}
variables:
  group:
    fn::invoke:
      function: ibm:getResourceGroup
      arguments:
        name: Default

    Create SatelliteLocation Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new SatelliteLocation(name: string, args: SatelliteLocationArgs, opts?: CustomResourceOptions);
    @overload
def SatelliteLocation(resource_name: str,
                      args: SatelliteLocationArgs,
                      opts: Optional[ResourceOptions] = None)

@overload
def SatelliteLocation(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      location: Optional[str] = None,
                      managed_from: Optional[str] = None,
                      physical_address: Optional[str] = None,
                      pod_subnet: Optional[str] = None,
                      description: Optional[str] = None,
                      cos_config: Optional[SatelliteLocationCosConfigArgs] = None,
                      logging_account_id: Optional[str] = None,
                      coreos_enabled: Optional[bool] = None,
                      capabilities: Optional[Sequence[str]] = None,
                      cos_credentials: Optional[SatelliteLocationCosCredentialsArgs] = None,
                      resource_group_id: Optional[str] = None,
                      satellite_location_id: Optional[str] = None,
                      service_subnet: Optional[str] = None,
                      tags: Optional[Sequence[str]] = None,
                      timeouts: Optional[SatelliteLocationTimeoutsArgs] = None,
                      zones: Optional[Sequence[str]] = None)
    func NewSatelliteLocation(ctx *Context, name string, args SatelliteLocationArgs, opts ...ResourceOption) (*SatelliteLocation, error)
    public SatelliteLocation(string name, SatelliteLocationArgs args, CustomResourceOptions? opts = null)
    public SatelliteLocation(String name, SatelliteLocationArgs args)
public SatelliteLocation(String name, SatelliteLocationArgs args, CustomResourceOptions options)

    type: ibm:SatelliteLocation
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args SatelliteLocationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args SatelliteLocationArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args SatelliteLocationArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SatelliteLocationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SatelliteLocationArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var satelliteLocationResource = new Ibm.SatelliteLocation("satelliteLocationResource", new()
{
    Location = "string",
    ManagedFrom = "string",
    PhysicalAddress = "string",
    PodSubnet = "string",
    Description = "string",
    CosConfig = new Ibm.Inputs.SatelliteLocationCosConfigArgs
    {
        Bucket = "string",
        Endpoint = "string",
        Region = "string",
    },
    LoggingAccountId = "string",
    CoreosEnabled = false,
    Capabilities = new[]
    {
        "string",
    },
    CosCredentials = new Ibm.Inputs.SatelliteLocationCosCredentialsArgs
    {
        AccessKeyId = "string",
        SecretAccessKey = "string",
    },
    ResourceGroupId = "string",
    SatelliteLocationId = "string",
    ServiceSubnet = "string",
    Tags = new[]
    {
        "string",
    },
    Timeouts = new Ibm.Inputs.SatelliteLocationTimeoutsArgs
    {
        Create = "string",
        Delete = "string",
        Update = "string",
    },
    Zones = new[]
    {
        "string",
    },
});

    example, err := ibm.NewSatelliteLocation(ctx, "satelliteLocationResource", &ibm.SatelliteLocationArgs{
Location: pulumi.String("string"),
ManagedFrom: pulumi.String("string"),
PhysicalAddress: pulumi.String("string"),
PodSubnet: pulumi.String("string"),
Description: pulumi.String("string"),
CosConfig: &.SatelliteLocationCosConfigArgs{
Bucket: pulumi.String("string"),
Endpoint: pulumi.String("string"),
Region: pulumi.String("string"),
},
LoggingAccountId: pulumi.String("string"),
CoreosEnabled: pulumi.Bool(false),
Capabilities: pulumi.StringArray{
pulumi.String("string"),
},
CosCredentials: &.SatelliteLocationCosCredentialsArgs{
AccessKeyId: pulumi.String("string"),
SecretAccessKey: pulumi.String("string"),
},
ResourceGroupId: pulumi.String("string"),
SatelliteLocationId: pulumi.String("string"),
ServiceSubnet: pulumi.String("string"),
Tags: pulumi.StringArray{
pulumi.String("string"),
},
Timeouts: &.SatelliteLocationTimeoutsArgs{
Create: pulumi.String("string"),
Delete: pulumi.String("string"),
Update: pulumi.String("string"),
},
Zones: pulumi.StringArray{
pulumi.String("string"),
},
})

    var satelliteLocationResource = new SatelliteLocation("satelliteLocationResource", SatelliteLocationArgs.builder()
    .location("string")
    .managedFrom("string")
    .physicalAddress("string")
    .podSubnet("string")
    .description("string")
    .cosConfig(SatelliteLocationCosConfigArgs.builder()
        .bucket("string")
        .endpoint("string")
        .region("string")
        .build())
    .loggingAccountId("string")
    .coreosEnabled(false)
    .capabilities("string")
    .cosCredentials(SatelliteLocationCosCredentialsArgs.builder()
        .accessKeyId("string")
        .secretAccessKey("string")
        .build())
    .resourceGroupId("string")
    .satelliteLocationId("string")
    .serviceSubnet("string")
    .tags("string")
    .timeouts(SatelliteLocationTimeoutsArgs.builder()
        .create("string")
        .delete("string")
        .update("string")
        .build())
    .zones("string")
    .build());

    satellite_location_resource = ibm.SatelliteLocation("satelliteLocationResource",
    location="string",
    managed_from="string",
    physical_address="string",
    pod_subnet="string",
    description="string",
    cos_config={
        "bucket": "string",
        "endpoint": "string",
        "region": "string",
    },
    logging_account_id="string",
    coreos_enabled=False,
    capabilities=["string"],
    cos_credentials={
        "access_key_id": "string",
        "secret_access_key": "string",
    },
    resource_group_id="string",
    satellite_location_id="string",
    service_subnet="string",
    tags=["string"],
    timeouts={
        "create": "string",
        "delete": "string",
        "update": "string",
    },
    zones=["string"])

    const satelliteLocationResource = new ibm.SatelliteLocation("satelliteLocationResource", {
    location: "string",
    managedFrom: "string",
    physicalAddress: "string",
    podSubnet: "string",
    description: "string",
    cosConfig: {
        bucket: "string",
        endpoint: "string",
        region: "string",
    },
    loggingAccountId: "string",
    coreosEnabled: false,
    capabilities: ["string"],
    cosCredentials: {
        accessKeyId: "string",
        secretAccessKey: "string",
    },
    resourceGroupId: "string",
    satelliteLocationId: "string",
    serviceSubnet: "string",
    tags: ["string"],
    timeouts: {
        create: "string",
        "delete": "string",
        update: "string",
    },
    zones: ["string"],
});

    type: ibm:SatelliteLocation
properties:
    capabilities:
        - string
    coreosEnabled: false
    cosConfig:
        bucket: string
        endpoint: string
        region: string
    cosCredentials:
        accessKeyId: string
        secretAccessKey: string
    description: string
    location: string
    loggingAccountId: string
    managedFrom: string
    physicalAddress: string
    podSubnet: string
    resourceGroupId: string
    satelliteLocationId: string
    serviceSubnet: string
    tags:
        - string
    timeouts:
        create: string
        delete: string
        update: string
    zones:
        - string

    SatelliteLocation Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The SatelliteLocation resource accepts the following input properties:

    Location string
    The name of the location to be created or pass existing location name.
    ManagedFrom string
    The IBM Cloud regions that you can choose from to manage your Satellite location. To list available multizone regions, run ibmcloud ks locations. For more information, refer to supported IBM Cloud locations.
    Capabilities List<string>
    Satellite capabilities attached to the location. It is mandatory to add the value 'on-prem' to 'capabilities' (in the Kubernetes Service API, the parameter 'capabilities' is called'capabilitiesManagedBySatellite'), if a value has been set for 'physicalAddress'. On the other hand, value can be added to 'capabilitiesManagedBySatellite' without setting any value to 'physicalAddress'. In other words, 'capabilitiesManagedBySatellite' is optional, unless 'physicalAddress' gets set.
    CoreosEnabled bool
    Enable Red Hat CoreOS features within the Satellite location.
    CosConfig SatelliteLocationCosConfig

    The IBM Cloud Object Storage bucket configuration details. Nested cos_config blocks have the following structure.

    Nested scheme for cos_config:

    CosCredentials SatelliteLocationCosCredentials

    The IBM Cloud Object Storage authorization keys. Nested cos_credentials blocks have the following structure.

    Nested scheme for cos_credentials:

    • access_key-id - (Required, String)The HMAC secret access key ID.
    Description string
    A description of the new Satellite location.
    LoggingAccountId string
    The account ID for IBM Log Analysis with LogDNA log forwarding.
    PhysicalAddress string
    The physical address of the new Satellite location which is deployed on premise.
    PodSubnet string
    Custom subnet CIDR to provide private IP addresses for pods
    ResourceGroupId string
    ID of the resource group.
    SatelliteLocationId string
    (String) The unique identifier of the location.
    ServiceSubnet string
    Custom subnet CIDR to provide private IP addresses for services
    Tags List<string>
    List of tags associated with resource instance
    Timeouts SatelliteLocationTimeouts
    Zones List<string>
    Array of Strings - Optional- The names for the host zones. For high availability, allocate your hosts across these three zones based on your infrastructure provider zones. For example, us-east-1, us-east-2, us-east-3 .
    Location string
    The name of the location to be created or pass existing location name.
    ManagedFrom string
    The IBM Cloud regions that you can choose from to manage your Satellite location. To list available multizone regions, run ibmcloud ks locations. For more information, refer to supported IBM Cloud locations.
    Capabilities []string
    Satellite capabilities attached to the location. It is mandatory to add the value 'on-prem' to 'capabilities' (in the Kubernetes Service API, the parameter 'capabilities' is called'capabilitiesManagedBySatellite'), if a value has been set for 'physicalAddress'. On the other hand, value can be added to 'capabilitiesManagedBySatellite' without setting any value to 'physicalAddress'. In other words, 'capabilitiesManagedBySatellite' is optional, unless 'physicalAddress' gets set.
    CoreosEnabled bool
    Enable Red Hat CoreOS features within the Satellite location.
    CosConfig SatelliteLocationCosConfigArgs

    The IBM Cloud Object Storage bucket configuration details. Nested cos_config blocks have the following structure.

    Nested scheme for cos_config:

    CosCredentials SatelliteLocationCosCredentialsArgs

    The IBM Cloud Object Storage authorization keys. Nested cos_credentials blocks have the following structure.

    Nested scheme for cos_credentials:

    • access_key-id - (Required, String)The HMAC secret access key ID.
    Description string
    A description of the new Satellite location.
    LoggingAccountId string
    The account ID for IBM Log Analysis with LogDNA log forwarding.
    PhysicalAddress string
    The physical address of the new Satellite location which is deployed on premise.
    PodSubnet string
    Custom subnet CIDR to provide private IP addresses for pods
    ResourceGroupId string
    ID of the resource group.
    SatelliteLocationId string
    (String) The unique identifier of the location.
    ServiceSubnet string
    Custom subnet CIDR to provide private IP addresses for services
    Tags []string
    List of tags associated with resource instance
    Timeouts SatelliteLocationTimeoutsArgs
    Zones []string
    Array of Strings - Optional- The names for the host zones. For high availability, allocate your hosts across these three zones based on your infrastructure provider zones. For example, us-east-1, us-east-2, us-east-3 .
    location String
    The name of the location to be created or pass existing location name.
    managedFrom String
    The IBM Cloud regions that you can choose from to manage your Satellite location. To list available multizone regions, run ibmcloud ks locations. For more information, refer to supported IBM Cloud locations.
    capabilities List<String>
    Satellite capabilities attached to the location. It is mandatory to add the value 'on-prem' to 'capabilities' (in the Kubernetes Service API, the parameter 'capabilities' is called'capabilitiesManagedBySatellite'), if a value has been set for 'physicalAddress'. On the other hand, value can be added to 'capabilitiesManagedBySatellite' without setting any value to 'physicalAddress'. In other words, 'capabilitiesManagedBySatellite' is optional, unless 'physicalAddress' gets set.
    coreosEnabled Boolean
    Enable Red Hat CoreOS features within the Satellite location.
    cosConfig SatelliteLocationCosConfig

    The IBM Cloud Object Storage bucket configuration details. Nested cos_config blocks have the following structure.

    Nested scheme for cos_config:

    cosCredentials SatelliteLocationCosCredentials

    The IBM Cloud Object Storage authorization keys. Nested cos_credentials blocks have the following structure.

    Nested scheme for cos_credentials:

    • access_key-id - (Required, String)The HMAC secret access key ID.
    description String
    A description of the new Satellite location.
    loggingAccountId String
    The account ID for IBM Log Analysis with LogDNA log forwarding.
    physicalAddress String
    The physical address of the new Satellite location which is deployed on premise.
    podSubnet String
    Custom subnet CIDR to provide private IP addresses for pods
    resourceGroupId String
    ID of the resource group.
    satelliteLocationId String
    (String) The unique identifier of the location.
    serviceSubnet String
    Custom subnet CIDR to provide private IP addresses for services
    tags List<String>
    List of tags associated with resource instance
    timeouts SatelliteLocationTimeouts
    zones List<String>
    Array of Strings - Optional- The names for the host zones. For high availability, allocate your hosts across these three zones based on your infrastructure provider zones. For example, us-east-1, us-east-2, us-east-3 .
    location string
    The name of the location to be created or pass existing location name.
    managedFrom string
    The IBM Cloud regions that you can choose from to manage your Satellite location. To list available multizone regions, run ibmcloud ks locations. For more information, refer to supported IBM Cloud locations.
    capabilities string[]
    Satellite capabilities attached to the location. It is mandatory to add the value 'on-prem' to 'capabilities' (in the Kubernetes Service API, the parameter 'capabilities' is called'capabilitiesManagedBySatellite'), if a value has been set for 'physicalAddress'. On the other hand, value can be added to 'capabilitiesManagedBySatellite' without setting any value to 'physicalAddress'. In other words, 'capabilitiesManagedBySatellite' is optional, unless 'physicalAddress' gets set.
    coreosEnabled boolean
    Enable Red Hat CoreOS features within the Satellite location.
    cosConfig SatelliteLocationCosConfig

    The IBM Cloud Object Storage bucket configuration details. Nested cos_config blocks have the following structure.

    Nested scheme for cos_config:

    cosCredentials SatelliteLocationCosCredentials

    The IBM Cloud Object Storage authorization keys. Nested cos_credentials blocks have the following structure.

    Nested scheme for cos_credentials:

    • access_key-id - (Required, String)The HMAC secret access key ID.
    description string
    A description of the new Satellite location.
    loggingAccountId string
    The account ID for IBM Log Analysis with LogDNA log forwarding.
    physicalAddress string
    The physical address of the new Satellite location which is deployed on premise.
    podSubnet string
    Custom subnet CIDR to provide private IP addresses for pods
    resourceGroupId string
    ID of the resource group.
    satelliteLocationId string
    (String) The unique identifier of the location.
    serviceSubnet string
    Custom subnet CIDR to provide private IP addresses for services
    tags string[]
    List of tags associated with resource instance
    timeouts SatelliteLocationTimeouts
    zones string[]
    Array of Strings - Optional- The names for the host zones. For high availability, allocate your hosts across these three zones based on your infrastructure provider zones. For example, us-east-1, us-east-2, us-east-3 .
    location str
    The name of the location to be created or pass existing location name.
    managed_from str
    The IBM Cloud regions that you can choose from to manage your Satellite location. To list available multizone regions, run ibmcloud ks locations. For more information, refer to supported IBM Cloud locations.
    capabilities Sequence[str]
    Satellite capabilities attached to the location. It is mandatory to add the value 'on-prem' to 'capabilities' (in the Kubernetes Service API, the parameter 'capabilities' is called'capabilitiesManagedBySatellite'), if a value has been set for 'physicalAddress'. On the other hand, value can be added to 'capabilitiesManagedBySatellite' without setting any value to 'physicalAddress'. In other words, 'capabilitiesManagedBySatellite' is optional, unless 'physicalAddress' gets set.
    coreos_enabled bool
    Enable Red Hat CoreOS features within the Satellite location.
    cos_config SatelliteLocationCosConfigArgs

    The IBM Cloud Object Storage bucket configuration details. Nested cos_config blocks have the following structure.

    Nested scheme for cos_config:

    cos_credentials SatelliteLocationCosCredentialsArgs

    The IBM Cloud Object Storage authorization keys. Nested cos_credentials blocks have the following structure.

    Nested scheme for cos_credentials:

    • access_key-id - (Required, String)The HMAC secret access key ID.
    description str
    A description of the new Satellite location.
    logging_account_id str
    The account ID for IBM Log Analysis with LogDNA log forwarding.
    physical_address str
    The physical address of the new Satellite location which is deployed on premise.
    pod_subnet str
    Custom subnet CIDR to provide private IP addresses for pods
    resource_group_id str
    ID of the resource group.
    satellite_location_id str
    (String) The unique identifier of the location.
    service_subnet str
    Custom subnet CIDR to provide private IP addresses for services
    tags Sequence[str]
    List of tags associated with resource instance
    timeouts SatelliteLocationTimeoutsArgs
    zones Sequence[str]
    Array of Strings - Optional- The names for the host zones. For high availability, allocate your hosts across these three zones based on your infrastructure provider zones. For example, us-east-1, us-east-2, us-east-3 .
    location String
    The name of the location to be created or pass existing location name.
    managedFrom String
    The IBM Cloud regions that you can choose from to manage your Satellite location. To list available multizone regions, run ibmcloud ks locations. For more information, refer to supported IBM Cloud locations.
    capabilities List<String>
    Satellite capabilities attached to the location. It is mandatory to add the value 'on-prem' to 'capabilities' (in the Kubernetes Service API, the parameter 'capabilities' is called'capabilitiesManagedBySatellite'), if a value has been set for 'physicalAddress'. On the other hand, value can be added to 'capabilitiesManagedBySatellite' without setting any value to 'physicalAddress'. In other words, 'capabilitiesManagedBySatellite' is optional, unless 'physicalAddress' gets set.
    coreosEnabled Boolean
    Enable Red Hat CoreOS features within the Satellite location.
    cosConfig Property Map

    The IBM Cloud Object Storage bucket configuration details. Nested cos_config blocks have the following structure.

    Nested scheme for cos_config:

    cosCredentials Property Map

    The IBM Cloud Object Storage authorization keys. Nested cos_credentials blocks have the following structure.

    Nested scheme for cos_credentials:

    • access_key-id - (Required, String)The HMAC secret access key ID.
    description String
    A description of the new Satellite location.
    loggingAccountId String
    The account ID for IBM Log Analysis with LogDNA log forwarding.
    physicalAddress String
    The physical address of the new Satellite location which is deployed on premise.
    podSubnet String
    Custom subnet CIDR to provide private IP addresses for pods
    resourceGroupId String
    ID of the resource group.
    satelliteLocationId String
    (String) The unique identifier of the location.
    serviceSubnet String
    Custom subnet CIDR to provide private IP addresses for services
    tags List<String>
    List of tags associated with resource instance
    timeouts Property Map
    zones List<String>
    Array of Strings - Optional- The names for the host zones. For high availability, allocate your hosts across these three zones based on your infrastructure provider zones. For example, us-east-1, us-east-2, us-east-3 .

    Outputs

    All input properties are implicitly available as output properties. Additionally, the SatelliteLocation resource produces the following output properties:

    CreatedOn string
    (Timestamp) The created time of the satellite location.
    Crn string
    (String) The CRN for this satellite location.
    HostAttachedCount double
    (Timestamp) The total number of hosts that are attached to the Satellite location.
    HostAvailableCount double
    (Timestamp) The available number of hosts that can be assigned to a cluster resource in the Satellite location.
    Id string
    The provider-assigned unique ID for this managed resource.
    IngressHostname string
    (String) The Ingress hostname.
    IngressSecret string
    (String) The Ingress secret.
    ResourceGroupName string
    (String) The name of the resource group.
    CreatedOn string
    (Timestamp) The created time of the satellite location.
    Crn string
    (String) The CRN for this satellite location.
    HostAttachedCount float64
    (Timestamp) The total number of hosts that are attached to the Satellite location.
    HostAvailableCount float64
    (Timestamp) The available number of hosts that can be assigned to a cluster resource in the Satellite location.
    Id string
    The provider-assigned unique ID for this managed resource.
    IngressHostname string
    (String) The Ingress hostname.
    IngressSecret string
    (String) The Ingress secret.
    ResourceGroupName string
    (String) The name of the resource group.
    createdOn String
    (Timestamp) The created time of the satellite location.
    crn String
    (String) The CRN for this satellite location.
    hostAttachedCount Double
    (Timestamp) The total number of hosts that are attached to the Satellite location.
    hostAvailableCount Double
    (Timestamp) The available number of hosts that can be assigned to a cluster resource in the Satellite location.
    id String
    The provider-assigned unique ID for this managed resource.
    ingressHostname String
    (String) The Ingress hostname.
    ingressSecret String
    (String) The Ingress secret.
    resourceGroupName String
    (String) The name of the resource group.
    createdOn string
    (Timestamp) The created time of the satellite location.
    crn string
    (String) The CRN for this satellite location.
    hostAttachedCount number
    (Timestamp) The total number of hosts that are attached to the Satellite location.
    hostAvailableCount number
    (Timestamp) The available number of hosts that can be assigned to a cluster resource in the Satellite location.
    id string
    The provider-assigned unique ID for this managed resource.
    ingressHostname string
    (String) The Ingress hostname.
    ingressSecret string
    (String) The Ingress secret.
    resourceGroupName string
    (String) The name of the resource group.
    created_on str
    (Timestamp) The created time of the satellite location.
    crn str
    (String) The CRN for this satellite location.
    host_attached_count float
    (Timestamp) The total number of hosts that are attached to the Satellite location.
    host_available_count float
    (Timestamp) The available number of hosts that can be assigned to a cluster resource in the Satellite location.
    id str
    The provider-assigned unique ID for this managed resource.
    ingress_hostname str
    (String) The Ingress hostname.
    ingress_secret str
    (String) The Ingress secret.
    resource_group_name str
    (String) The name of the resource group.
    createdOn String
    (Timestamp) The created time of the satellite location.
    crn String
    (String) The CRN for this satellite location.
    hostAttachedCount Number
    (Timestamp) The total number of hosts that are attached to the Satellite location.
    hostAvailableCount Number
    (Timestamp) The available number of hosts that can be assigned to a cluster resource in the Satellite location.
    id String
    The provider-assigned unique ID for this managed resource.
    ingressHostname String
    (String) The Ingress hostname.
    ingressSecret String
    (String) The Ingress secret.
    resourceGroupName String
    (String) The name of the resource group.

    Look up Existing SatelliteLocation Resource

    Get an existing SatelliteLocation resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: SatelliteLocationState, opts?: CustomResourceOptions): SatelliteLocation
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        capabilities: Optional[Sequence[str]] = None,
        coreos_enabled: Optional[bool] = None,
        cos_config: Optional[SatelliteLocationCosConfigArgs] = None,
        cos_credentials: Optional[SatelliteLocationCosCredentialsArgs] = None,
        created_on: Optional[str] = None,
        crn: Optional[str] = None,
        description: Optional[str] = None,
        host_attached_count: Optional[float] = None,
        host_available_count: Optional[float] = None,
        ingress_hostname: Optional[str] = None,
        ingress_secret: Optional[str] = None,
        location: Optional[str] = None,
        logging_account_id: Optional[str] = None,
        managed_from: Optional[str] = None,
        physical_address: Optional[str] = None,
        pod_subnet: Optional[str] = None,
        resource_group_id: Optional[str] = None,
        resource_group_name: Optional[str] = None,
        satellite_location_id: Optional[str] = None,
        service_subnet: Optional[str] = None,
        tags: Optional[Sequence[str]] = None,
        timeouts: Optional[SatelliteLocationTimeoutsArgs] = None,
        zones: Optional[Sequence[str]] = None) -> SatelliteLocation
    func GetSatelliteLocation(ctx *Context, name string, id IDInput, state *SatelliteLocationState, opts ...ResourceOption) (*SatelliteLocation, error)
    public static SatelliteLocation Get(string name, Input<string> id, SatelliteLocationState? state, CustomResourceOptions? opts = null)
    public static SatelliteLocation get(String name, Output<String> id, SatelliteLocationState state, CustomResourceOptions options)
    resources:  _:    type: ibm:SatelliteLocation    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Capabilities List<string>
    Satellite capabilities attached to the location. It is mandatory to add the value 'on-prem' to 'capabilities' (in the Kubernetes Service API, the parameter 'capabilities' is called'capabilitiesManagedBySatellite'), if a value has been set for 'physicalAddress'. On the other hand, value can be added to 'capabilitiesManagedBySatellite' without setting any value to 'physicalAddress'. In other words, 'capabilitiesManagedBySatellite' is optional, unless 'physicalAddress' gets set.
    CoreosEnabled bool
    Enable Red Hat CoreOS features within the Satellite location.
    CosConfig SatelliteLocationCosConfig

    The IBM Cloud Object Storage bucket configuration details. Nested cos_config blocks have the following structure.

    Nested scheme for cos_config:

    CosCredentials SatelliteLocationCosCredentials

    The IBM Cloud Object Storage authorization keys. Nested cos_credentials blocks have the following structure.

    Nested scheme for cos_credentials:

    • access_key-id - (Required, String)The HMAC secret access key ID.
    CreatedOn string
    (Timestamp) The created time of the satellite location.
    Crn string
    (String) The CRN for this satellite location.
    Description string
    A description of the new Satellite location.
    HostAttachedCount double
    (Timestamp) The total number of hosts that are attached to the Satellite location.
    HostAvailableCount double
    (Timestamp) The available number of hosts that can be assigned to a cluster resource in the Satellite location.
    IngressHostname string
    (String) The Ingress hostname.
    IngressSecret string
    (String) The Ingress secret.
    Location string
    The name of the location to be created or pass existing location name.
    LoggingAccountId string
    The account ID for IBM Log Analysis with LogDNA log forwarding.
    ManagedFrom string
    The IBM Cloud regions that you can choose from to manage your Satellite location. To list available multizone regions, run ibmcloud ks locations. For more information, refer to supported IBM Cloud locations.
    PhysicalAddress string
    The physical address of the new Satellite location which is deployed on premise.
    PodSubnet string
    Custom subnet CIDR to provide private IP addresses for pods
    ResourceGroupId string
    ID of the resource group.
    ResourceGroupName string
    (String) The name of the resource group.
    SatelliteLocationId string
    (String) The unique identifier of the location.
    ServiceSubnet string
    Custom subnet CIDR to provide private IP addresses for services
    Tags List<string>
    List of tags associated with resource instance
    Timeouts SatelliteLocationTimeouts
    Zones List<string>
    Array of Strings - Optional- The names for the host zones. For high availability, allocate your hosts across these three zones based on your infrastructure provider zones. For example, us-east-1, us-east-2, us-east-3 .
    Capabilities []string
    Satellite capabilities attached to the location. It is mandatory to add the value 'on-prem' to 'capabilities' (in the Kubernetes Service API, the parameter 'capabilities' is called'capabilitiesManagedBySatellite'), if a value has been set for 'physicalAddress'. On the other hand, value can be added to 'capabilitiesManagedBySatellite' without setting any value to 'physicalAddress'. In other words, 'capabilitiesManagedBySatellite' is optional, unless 'physicalAddress' gets set.
    CoreosEnabled bool
    Enable Red Hat CoreOS features within the Satellite location.
    CosConfig SatelliteLocationCosConfigArgs

    The IBM Cloud Object Storage bucket configuration details. Nested cos_config blocks have the following structure.

    Nested scheme for cos_config:

    CosCredentials SatelliteLocationCosCredentialsArgs

    The IBM Cloud Object Storage authorization keys. Nested cos_credentials blocks have the following structure.

    Nested scheme for cos_credentials:

    • access_key-id - (Required, String)The HMAC secret access key ID.
    CreatedOn string
    (Timestamp) The created time of the satellite location.
    Crn string
    (String) The CRN for this satellite location.
    Description string
    A description of the new Satellite location.
    HostAttachedCount float64
    (Timestamp) The total number of hosts that are attached to the Satellite location.
    HostAvailableCount float64
    (Timestamp) The available number of hosts that can be assigned to a cluster resource in the Satellite location.
    IngressHostname string
    (String) The Ingress hostname.
    IngressSecret string
    (String) The Ingress secret.
    Location string
    The name of the location to be created or pass existing location name.
    LoggingAccountId string
    The account ID for IBM Log Analysis with LogDNA log forwarding.
    ManagedFrom string
    The IBM Cloud regions that you can choose from to manage your Satellite location. To list available multizone regions, run ibmcloud ks locations. For more information, refer to supported IBM Cloud locations.
    PhysicalAddress string
    The physical address of the new Satellite location which is deployed on premise.
    PodSubnet string
    Custom subnet CIDR to provide private IP addresses for pods
    ResourceGroupId string
    ID of the resource group.
    ResourceGroupName string
    (String) The name of the resource group.
    SatelliteLocationId string
    (String) The unique identifier of the location.
    ServiceSubnet string
    Custom subnet CIDR to provide private IP addresses for services
    Tags []string
    List of tags associated with resource instance
    Timeouts SatelliteLocationTimeoutsArgs
    Zones []string
    Array of Strings - Optional- The names for the host zones. For high availability, allocate your hosts across these three zones based on your infrastructure provider zones. For example, us-east-1, us-east-2, us-east-3 .
    capabilities List<String>
    Satellite capabilities attached to the location. It is mandatory to add the value 'on-prem' to 'capabilities' (in the Kubernetes Service API, the parameter 'capabilities' is called'capabilitiesManagedBySatellite'), if a value has been set for 'physicalAddress'. On the other hand, value can be added to 'capabilitiesManagedBySatellite' without setting any value to 'physicalAddress'. In other words, 'capabilitiesManagedBySatellite' is optional, unless 'physicalAddress' gets set.
    coreosEnabled Boolean
    Enable Red Hat CoreOS features within the Satellite location.
    cosConfig SatelliteLocationCosConfig

    The IBM Cloud Object Storage bucket configuration details. Nested cos_config blocks have the following structure.

    Nested scheme for cos_config:

    cosCredentials SatelliteLocationCosCredentials

    The IBM Cloud Object Storage authorization keys. Nested cos_credentials blocks have the following structure.

    Nested scheme for cos_credentials:

    • access_key-id - (Required, String)The HMAC secret access key ID.
    createdOn String
    (Timestamp) The created time of the satellite location.
    crn String
    (String) The CRN for this satellite location.
    description String
    A description of the new Satellite location.
    hostAttachedCount Double
    (Timestamp) The total number of hosts that are attached to the Satellite location.
    hostAvailableCount Double
    (Timestamp) The available number of hosts that can be assigned to a cluster resource in the Satellite location.
    ingressHostname String
    (String) The Ingress hostname.
    ingressSecret String
    (String) The Ingress secret.
    location String
    The name of the location to be created or pass existing location name.
    loggingAccountId String
    The account ID for IBM Log Analysis with LogDNA log forwarding.
    managedFrom String
    The IBM Cloud regions that you can choose from to manage your Satellite location. To list available multizone regions, run ibmcloud ks locations. For more information, refer to supported IBM Cloud locations.
    physicalAddress String
    The physical address of the new Satellite location which is deployed on premise.
    podSubnet String
    Custom subnet CIDR to provide private IP addresses for pods
    resourceGroupId String
    ID of the resource group.
    resourceGroupName String
    (String) The name of the resource group.
    satelliteLocationId String
    (String) The unique identifier of the location.
    serviceSubnet String
    Custom subnet CIDR to provide private IP addresses for services
    tags List<String>
    List of tags associated with resource instance
    timeouts SatelliteLocationTimeouts
    zones List<String>
    Array of Strings - Optional- The names for the host zones. For high availability, allocate your hosts across these three zones based on your infrastructure provider zones. For example, us-east-1, us-east-2, us-east-3 .
    capabilities string[]
    Satellite capabilities attached to the location. It is mandatory to add the value 'on-prem' to 'capabilities' (in the Kubernetes Service API, the parameter 'capabilities' is called'capabilitiesManagedBySatellite'), if a value has been set for 'physicalAddress'. On the other hand, value can be added to 'capabilitiesManagedBySatellite' without setting any value to 'physicalAddress'. In other words, 'capabilitiesManagedBySatellite' is optional, unless 'physicalAddress' gets set.
    coreosEnabled boolean
    Enable Red Hat CoreOS features within the Satellite location.
    cosConfig SatelliteLocationCosConfig

    The IBM Cloud Object Storage bucket configuration details. Nested cos_config blocks have the following structure.

    Nested scheme for cos_config:

    cosCredentials SatelliteLocationCosCredentials

    The IBM Cloud Object Storage authorization keys. Nested cos_credentials blocks have the following structure.

    Nested scheme for cos_credentials:

    • access_key-id - (Required, String)The HMAC secret access key ID.
    createdOn string
    (Timestamp) The created time of the satellite location.
    crn string
    (String) The CRN for this satellite location.
    description string
    A description of the new Satellite location.
    hostAttachedCount number
    (Timestamp) The total number of hosts that are attached to the Satellite location.
    hostAvailableCount number
    (Timestamp) The available number of hosts that can be assigned to a cluster resource in the Satellite location.
    ingressHostname string
    (String) The Ingress hostname.
    ingressSecret string
    (String) The Ingress secret.
    location string
    The name of the location to be created or pass existing location name.
    loggingAccountId string
    The account ID for IBM Log Analysis with LogDNA log forwarding.
    managedFrom string
    The IBM Cloud regions that you can choose from to manage your Satellite location. To list available multizone regions, run ibmcloud ks locations. For more information, refer to supported IBM Cloud locations.
    physicalAddress string
    The physical address of the new Satellite location which is deployed on premise.
    podSubnet string
    Custom subnet CIDR to provide private IP addresses for pods
    resourceGroupId string
    ID of the resource group.
    resourceGroupName string
    (String) The name of the resource group.
    satelliteLocationId string
    (String) The unique identifier of the location.
    serviceSubnet string
    Custom subnet CIDR to provide private IP addresses for services
    tags string[]
    List of tags associated with resource instance
    timeouts SatelliteLocationTimeouts
    zones string[]
    Array of Strings - Optional- The names for the host zones. For high availability, allocate your hosts across these three zones based on your infrastructure provider zones. For example, us-east-1, us-east-2, us-east-3 .
    capabilities Sequence[str]
    Satellite capabilities attached to the location. It is mandatory to add the value 'on-prem' to 'capabilities' (in the Kubernetes Service API, the parameter 'capabilities' is called'capabilitiesManagedBySatellite'), if a value has been set for 'physicalAddress'. On the other hand, value can be added to 'capabilitiesManagedBySatellite' without setting any value to 'physicalAddress'. In other words, 'capabilitiesManagedBySatellite' is optional, unless 'physicalAddress' gets set.
    coreos_enabled bool
    Enable Red Hat CoreOS features within the Satellite location.
    cos_config SatelliteLocationCosConfigArgs

    The IBM Cloud Object Storage bucket configuration details. Nested cos_config blocks have the following structure.

    Nested scheme for cos_config:

    cos_credentials SatelliteLocationCosCredentialsArgs

    The IBM Cloud Object Storage authorization keys. Nested cos_credentials blocks have the following structure.

    Nested scheme for cos_credentials:

    • access_key-id - (Required, String)The HMAC secret access key ID.
    created_on str
    (Timestamp) The created time of the satellite location.
    crn str
    (String) The CRN for this satellite location.
    description str
    A description of the new Satellite location.
    host_attached_count float
    (Timestamp) The total number of hosts that are attached to the Satellite location.
    host_available_count float
    (Timestamp) The available number of hosts that can be assigned to a cluster resource in the Satellite location.
    ingress_hostname str
    (String) The Ingress hostname.
    ingress_secret str
    (String) The Ingress secret.
    location str
    The name of the location to be created or pass existing location name.
    logging_account_id str
    The account ID for IBM Log Analysis with LogDNA log forwarding.
    managed_from str
    The IBM Cloud regions that you can choose from to manage your Satellite location. To list available multizone regions, run ibmcloud ks locations. For more information, refer to supported IBM Cloud locations.
    physical_address str
    The physical address of the new Satellite location which is deployed on premise.
    pod_subnet str
    Custom subnet CIDR to provide private IP addresses for pods
    resource_group_id str
    ID of the resource group.
    resource_group_name str
    (String) The name of the resource group.
    satellite_location_id str
    (String) The unique identifier of the location.
    service_subnet str
    Custom subnet CIDR to provide private IP addresses for services
    tags Sequence[str]
    List of tags associated with resource instance
    timeouts SatelliteLocationTimeoutsArgs
    zones Sequence[str]
    Array of Strings - Optional- The names for the host zones. For high availability, allocate your hosts across these three zones based on your infrastructure provider zones. For example, us-east-1, us-east-2, us-east-3 .
    capabilities List<String>
    Satellite capabilities attached to the location. It is mandatory to add the value 'on-prem' to 'capabilities' (in the Kubernetes Service API, the parameter 'capabilities' is called'capabilitiesManagedBySatellite'), if a value has been set for 'physicalAddress'. On the other hand, value can be added to 'capabilitiesManagedBySatellite' without setting any value to 'physicalAddress'. In other words, 'capabilitiesManagedBySatellite' is optional, unless 'physicalAddress' gets set.
    coreosEnabled Boolean
    Enable Red Hat CoreOS features within the Satellite location.
    cosConfig Property Map

    The IBM Cloud Object Storage bucket configuration details. Nested cos_config blocks have the following structure.

    Nested scheme for cos_config:

    cosCredentials Property Map

    The IBM Cloud Object Storage authorization keys. Nested cos_credentials blocks have the following structure.

    Nested scheme for cos_credentials:

    • access_key-id - (Required, String)The HMAC secret access key ID.
    createdOn String
    (Timestamp) The created time of the satellite location.
    crn String
    (String) The CRN for this satellite location.
    description String
    A description of the new Satellite location.
    hostAttachedCount Number
    (Timestamp) The total number of hosts that are attached to the Satellite location.
    hostAvailableCount Number
    (Timestamp) The available number of hosts that can be assigned to a cluster resource in the Satellite location.
    ingressHostname String
    (String) The Ingress hostname.
    ingressSecret String
    (String) The Ingress secret.
    location String
    The name of the location to be created or pass existing location name.
    loggingAccountId String
    The account ID for IBM Log Analysis with LogDNA log forwarding.
    managedFrom String
    The IBM Cloud regions that you can choose from to manage your Satellite location. To list available multizone regions, run ibmcloud ks locations. For more information, refer to supported IBM Cloud locations.
    physicalAddress String
    The physical address of the new Satellite location which is deployed on premise.
    podSubnet String
    Custom subnet CIDR to provide private IP addresses for pods
    resourceGroupId String
    ID of the resource group.
    resourceGroupName String
    (String) The name of the resource group.
    satelliteLocationId String
    (String) The unique identifier of the location.
    serviceSubnet String
    Custom subnet CIDR to provide private IP addresses for services
    tags List<String>
    List of tags associated with resource instance
    timeouts Property Map
    zones List<String>
    Array of Strings - Optional- The names for the host zones. For high availability, allocate your hosts across these three zones based on your infrastructure provider zones. For example, us-east-1, us-east-2, us-east-3 .

    Supporting Types

    SatelliteLocationCosConfig, SatelliteLocationCosConfigArgs

    Bucket string
    The name of the IBM Cloud Object Storage bucket that you want to use to back up the control plane data.
    Endpoint string
    The IBM Cloud Object Storage bucket endpoint.
    Region string
    The name of a region, such as us-south or eu-gb.
    Bucket string
    The name of the IBM Cloud Object Storage bucket that you want to use to back up the control plane data.
    Endpoint string
    The IBM Cloud Object Storage bucket endpoint.
    Region string
    The name of a region, such as us-south or eu-gb.
    bucket String
    The name of the IBM Cloud Object Storage bucket that you want to use to back up the control plane data.
    endpoint String
    The IBM Cloud Object Storage bucket endpoint.
    region String
    The name of a region, such as us-south or eu-gb.
    bucket string
    The name of the IBM Cloud Object Storage bucket that you want to use to back up the control plane data.
    endpoint string
    The IBM Cloud Object Storage bucket endpoint.
    region string
    The name of a region, such as us-south or eu-gb.
    bucket str
    The name of the IBM Cloud Object Storage bucket that you want to use to back up the control plane data.
    endpoint str
    The IBM Cloud Object Storage bucket endpoint.
    region str
    The name of a region, such as us-south or eu-gb.
    bucket String
    The name of the IBM Cloud Object Storage bucket that you want to use to back up the control plane data.
    endpoint String
    The IBM Cloud Object Storage bucket endpoint.
    region String
    The name of a region, such as us-south or eu-gb.

    SatelliteLocationCosCredentials, SatelliteLocationCosCredentialsArgs

    AccessKeyId string
    The HMAC secret access key ID
    SecretAccessKey string
    The HMAC secret access key.
    AccessKeyId string
    The HMAC secret access key ID
    SecretAccessKey string
    The HMAC secret access key.
    accessKeyId String
    The HMAC secret access key ID
    secretAccessKey String
    The HMAC secret access key.
    accessKeyId string
    The HMAC secret access key ID
    secretAccessKey string
    The HMAC secret access key.
    access_key_id str
    The HMAC secret access key ID
    secret_access_key str
    The HMAC secret access key.
    accessKeyId String
    The HMAC secret access key ID
    secretAccessKey String
    The HMAC secret access key.

    SatelliteLocationTimeouts, SatelliteLocationTimeoutsArgs

    Create string
    Delete string
    Update string
    Create string
    Delete string
    Update string
    create String
    delete String
    update String
    create string
    delete string
    update string
    create str
    delete str
    update str
    create String
    delete String
    update String

    Import

    The ibm_satellite_location resource can be imported by using the location ID or name.

    Syntax

    $ pulumi import ibm:index/satelliteLocation:SatelliteLocation location location

    Example

    $ pulumi import ibm:index/satelliteLocation:SatelliteLocation location satellite-location

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    ibm ibm-cloud/terraform-provider-ibm
    License
    Notes
    This Pulumi package is based on the ibm Terraform Provider.
    ibm logo
    ibm 1.77.1 published on Monday, Apr 14, 2025 by ibm-cloud
    ibm-cloud/terraform-provider-ibm