Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Ibm Provider
  3. API Docs
  4. SatelliteHost
ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm

ibm.SatelliteHost

Explore with Pulumi AI

ibm logo
ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm

    Create, update, or delete IBM Cloud Satellite Host. Assign a host to an IBM Cloud Satellite location or cluster. Before you can assign hosts to clusters, first assign at least three hosts to the Satellite location, to run control plane operations. Then, when you have Satellite clusters, you can assign hosts as needed to provide compute resources for your workloads. You can assign hosts by specifying a host ID or by providing labels to match hosts to your request.

    Example Usage

    Create SatelliteHost Resource

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

    Constructor syntax

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

@overload
def SatelliteHost(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  host_id: Optional[str] = None,
                  location: Optional[str] = None,
                  cluster: Optional[str] = None,
                  host_provider: Optional[str] = None,
                  labels: Optional[Sequence[str]] = None,
                  satellite_host_id: Optional[str] = None,
                  timeouts: Optional[SatelliteHostTimeoutsArgs] = None,
                  wait_till: Optional[str] = None,
                  worker_pool: Optional[str] = None,
                  zone: Optional[str] = None)
    func NewSatelliteHost(ctx *Context, name string, args SatelliteHostArgs, opts ...ResourceOption) (*SatelliteHost, error)
    public SatelliteHost(string name, SatelliteHostArgs args, CustomResourceOptions? opts = null)
    public SatelliteHost(String name, SatelliteHostArgs args)
public SatelliteHost(String name, SatelliteHostArgs args, CustomResourceOptions options)

    type: ibm:SatelliteHost
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 SatelliteHostArgs
    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 SatelliteHostArgs
    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 SatelliteHostArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SatelliteHostArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SatelliteHostArgs
    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 satelliteHostResource = new Ibm.SatelliteHost("satelliteHostResource", new()
{
    HostId = "string",
    Location = "string",
    Cluster = "string",
    HostProvider = "string",
    Labels = new[]
    {
        "string",
    },
    SatelliteHostId = "string",
    Timeouts = new Ibm.Inputs.SatelliteHostTimeoutsArgs
    {
        Create = "string",
        Delete = "string",
        Read = "string",
        Update = "string",
    },
    WaitTill = "string",
    WorkerPool = "string",
    Zone = "string",
});

    example, err := ibm.NewSatelliteHost(ctx, "satelliteHostResource", &ibm.SatelliteHostArgs{
	HostId:       pulumi.String("string"),
	Location:     pulumi.String("string"),
	Cluster:      pulumi.String("string"),
	HostProvider: pulumi.String("string"),
	Labels: pulumi.StringArray{
		pulumi.String("string"),
	},
	SatelliteHostId: pulumi.String("string"),
	Timeouts: &ibm.SatelliteHostTimeoutsArgs{
		Create: pulumi.String("string"),
		Delete: pulumi.String("string"),
		Read:   pulumi.String("string"),
		Update: pulumi.String("string"),
	},
	WaitTill:   pulumi.String("string"),
	WorkerPool: pulumi.String("string"),
	Zone:       pulumi.String("string"),
})

    var satelliteHostResource = new SatelliteHost("satelliteHostResource", SatelliteHostArgs.builder()
    .hostId("string")
    .location("string")
    .cluster("string")
    .hostProvider("string")
    .labels("string")
    .satelliteHostId("string")
    .timeouts(SatelliteHostTimeoutsArgs.builder()
        .create("string")
        .delete("string")
        .read("string")
        .update("string")
        .build())
    .waitTill("string")
    .workerPool("string")
    .zone("string")
    .build());

    satellite_host_resource = ibm.SatelliteHost("satelliteHostResource",
    host_id="string",
    location="string",
    cluster="string",
    host_provider="string",
    labels=["string"],
    satellite_host_id="string",
    timeouts={
        "create": "string",
        "delete": "string",
        "read": "string",
        "update": "string",
    },
    wait_till="string",
    worker_pool="string",
    zone="string")

    const satelliteHostResource = new ibm.SatelliteHost("satelliteHostResource", {
    hostId: "string",
    location: "string",
    cluster: "string",
    hostProvider: "string",
    labels: ["string"],
    satelliteHostId: "string",
    timeouts: {
        create: "string",
        "delete": "string",
        read: "string",
        update: "string",
    },
    waitTill: "string",
    workerPool: "string",
    zone: "string",
});

    type: ibm:SatelliteHost
properties:
    cluster: string
    hostId: string
    hostProvider: string
    labels:
        - string
    location: string
    satelliteHostId: string
    timeouts:
        create: string
        delete: string
        read: string
        update: string
    waitTill: string
    workerPool: string
    zone: string

    SatelliteHost 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 SatelliteHost resource accepts the following input properties:

    HostId string
    The name or ID of the specific host to assign to a Satellite location or cluster
    Location string
    The name or ID of the Satellite location
    Cluster string
    The name or ID of a Satellite location or cluster to assign the host to.
    HostProvider string
    The name of host provider, such as ibm, aws or azure.
    Labels List<string>
    The key value pairs to label the host, such as cpu=4 to describe the host capabilities.
    SatelliteHostId string
    (String) The unique identifier of the location. The ID is combination of location and host_id delimited by /.
    Timeouts SatelliteHostTimeouts
    WaitTill string
    Wait until location is normal
    WorkerPool string
    The name or ID of the worker pool within the cluster to assign the host to. wait_till - (Optional, String) If this argument is provided this resource will wait until location is normal. Allowed values: location_normal
    Zone string
    (String) The zone within the cluster to assign the host to.
    HostId string
    The name or ID of the specific host to assign to a Satellite location or cluster
    Location string
    The name or ID of the Satellite location
    Cluster string
    The name or ID of a Satellite location or cluster to assign the host to.
    HostProvider string
    The name of host provider, such as ibm, aws or azure.
    Labels []string
    The key value pairs to label the host, such as cpu=4 to describe the host capabilities.
    SatelliteHostId string
    (String) The unique identifier of the location. The ID is combination of location and host_id delimited by /.
    Timeouts SatelliteHostTimeoutsArgs
    WaitTill string
    Wait until location is normal
    WorkerPool string
    The name or ID of the worker pool within the cluster to assign the host to. wait_till - (Optional, String) If this argument is provided this resource will wait until location is normal. Allowed values: location_normal
    Zone string
    (String) The zone within the cluster to assign the host to.
    hostId String
    The name or ID of the specific host to assign to a Satellite location or cluster
    location String
    The name or ID of the Satellite location
    cluster String
    The name or ID of a Satellite location or cluster to assign the host to.
    hostProvider String
    The name of host provider, such as ibm, aws or azure.
    labels List<String>
    The key value pairs to label the host, such as cpu=4 to describe the host capabilities.
    satelliteHostId String
    (String) The unique identifier of the location. The ID is combination of location and host_id delimited by /.
    timeouts SatelliteHostTimeouts
    waitTill String
    Wait until location is normal
    workerPool String
    The name or ID of the worker pool within the cluster to assign the host to. wait_till - (Optional, String) If this argument is provided this resource will wait until location is normal. Allowed values: location_normal
    zone String
    (String) The zone within the cluster to assign the host to.
    hostId string
    The name or ID of the specific host to assign to a Satellite location or cluster
    location string
    The name or ID of the Satellite location
    cluster string
    The name or ID of a Satellite location or cluster to assign the host to.
    hostProvider string
    The name of host provider, such as ibm, aws or azure.
    labels string[]
    The key value pairs to label the host, such as cpu=4 to describe the host capabilities.
    satelliteHostId string
    (String) The unique identifier of the location. The ID is combination of location and host_id delimited by /.
    timeouts SatelliteHostTimeouts
    waitTill string
    Wait until location is normal
    workerPool string
    The name or ID of the worker pool within the cluster to assign the host to. wait_till - (Optional, String) If this argument is provided this resource will wait until location is normal. Allowed values: location_normal
    zone string
    (String) The zone within the cluster to assign the host to.
    host_id str
    The name or ID of the specific host to assign to a Satellite location or cluster
    location str
    The name or ID of the Satellite location
    cluster str
    The name or ID of a Satellite location or cluster to assign the host to.
    host_provider str
    The name of host provider, such as ibm, aws or azure.
    labels Sequence[str]
    The key value pairs to label the host, such as cpu=4 to describe the host capabilities.
    satellite_host_id str
    (String) The unique identifier of the location. The ID is combination of location and host_id delimited by /.
    timeouts SatelliteHostTimeoutsArgs
    wait_till str
    Wait until location is normal
    worker_pool str
    The name or ID of the worker pool within the cluster to assign the host to. wait_till - (Optional, String) If this argument is provided this resource will wait until location is normal. Allowed values: location_normal
    zone str
    (String) The zone within the cluster to assign the host to.
    hostId String
    The name or ID of the specific host to assign to a Satellite location or cluster
    location String
    The name or ID of the Satellite location
    cluster String
    The name or ID of a Satellite location or cluster to assign the host to.
    hostProvider String
    The name of host provider, such as ibm, aws or azure.
    labels List<String>
    The key value pairs to label the host, such as cpu=4 to describe the host capabilities.
    satelliteHostId String
    (String) The unique identifier of the location. The ID is combination of location and host_id delimited by /.
    timeouts Property Map
    waitTill String
    Wait until location is normal
    workerPool String
    The name or ID of the worker pool within the cluster to assign the host to. wait_till - (Optional, String) If this argument is provided this resource will wait until location is normal. Allowed values: location_normal
    zone String
    (String) The zone within the cluster to assign the host to.

    Outputs

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

    HostState string
    (String) Health status of the host.
    Id string
    The provider-assigned unique ID for this managed resource.
    HostState string
    (String) Health status of the host.
    Id string
    The provider-assigned unique ID for this managed resource.
    hostState String
    (String) Health status of the host.
    id String
    The provider-assigned unique ID for this managed resource.
    hostState string
    (String) Health status of the host.
    id string
    The provider-assigned unique ID for this managed resource.
    host_state str
    (String) Health status of the host.
    id str
    The provider-assigned unique ID for this managed resource.
    hostState String
    (String) Health status of the host.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing SatelliteHost Resource

    Get an existing SatelliteHost 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?: SatelliteHostState, opts?: CustomResourceOptions): SatelliteHost
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        cluster: Optional[str] = None,
        host_id: Optional[str] = None,
        host_provider: Optional[str] = None,
        host_state: Optional[str] = None,
        labels: Optional[Sequence[str]] = None,
        location: Optional[str] = None,
        satellite_host_id: Optional[str] = None,
        timeouts: Optional[SatelliteHostTimeoutsArgs] = None,
        wait_till: Optional[str] = None,
        worker_pool: Optional[str] = None,
        zone: Optional[str] = None) -> SatelliteHost
    func GetSatelliteHost(ctx *Context, name string, id IDInput, state *SatelliteHostState, opts ...ResourceOption) (*SatelliteHost, error)
    public static SatelliteHost Get(string name, Input<string> id, SatelliteHostState? state, CustomResourceOptions? opts = null)
    public static SatelliteHost get(String name, Output<String> id, SatelliteHostState state, CustomResourceOptions options)
    resources:  _:    type: ibm:SatelliteHost    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:
    Cluster string
    The name or ID of a Satellite location or cluster to assign the host to.
    HostId string
    The name or ID of the specific host to assign to a Satellite location or cluster
    HostProvider string
    The name of host provider, such as ibm, aws or azure.
    HostState string
    (String) Health status of the host.
    Labels List<string>
    The key value pairs to label the host, such as cpu=4 to describe the host capabilities.
    Location string
    The name or ID of the Satellite location
    SatelliteHostId string
    (String) The unique identifier of the location. The ID is combination of location and host_id delimited by /.
    Timeouts SatelliteHostTimeouts
    WaitTill string
    Wait until location is normal
    WorkerPool string
    The name or ID of the worker pool within the cluster to assign the host to. wait_till - (Optional, String) If this argument is provided this resource will wait until location is normal. Allowed values: location_normal
    Zone string
    (String) The zone within the cluster to assign the host to.
    Cluster string
    The name or ID of a Satellite location or cluster to assign the host to.
    HostId string
    The name or ID of the specific host to assign to a Satellite location or cluster
    HostProvider string
    The name of host provider, such as ibm, aws or azure.
    HostState string
    (String) Health status of the host.
    Labels []string
    The key value pairs to label the host, such as cpu=4 to describe the host capabilities.
    Location string
    The name or ID of the Satellite location
    SatelliteHostId string
    (String) The unique identifier of the location. The ID is combination of location and host_id delimited by /.
    Timeouts SatelliteHostTimeoutsArgs
    WaitTill string
    Wait until location is normal
    WorkerPool string
    The name or ID of the worker pool within the cluster to assign the host to. wait_till - (Optional, String) If this argument is provided this resource will wait until location is normal. Allowed values: location_normal
    Zone string
    (String) The zone within the cluster to assign the host to.
    cluster String
    The name or ID of a Satellite location or cluster to assign the host to.
    hostId String
    The name or ID of the specific host to assign to a Satellite location or cluster
    hostProvider String
    The name of host provider, such as ibm, aws or azure.
    hostState String
    (String) Health status of the host.
    labels List<String>
    The key value pairs to label the host, such as cpu=4 to describe the host capabilities.
    location String
    The name or ID of the Satellite location
    satelliteHostId String
    (String) The unique identifier of the location. The ID is combination of location and host_id delimited by /.
    timeouts SatelliteHostTimeouts
    waitTill String
    Wait until location is normal
    workerPool String
    The name or ID of the worker pool within the cluster to assign the host to. wait_till - (Optional, String) If this argument is provided this resource will wait until location is normal. Allowed values: location_normal
    zone String
    (String) The zone within the cluster to assign the host to.
    cluster string
    The name or ID of a Satellite location or cluster to assign the host to.
    hostId string
    The name or ID of the specific host to assign to a Satellite location or cluster
    hostProvider string
    The name of host provider, such as ibm, aws or azure.
    hostState string
    (String) Health status of the host.
    labels string[]
    The key value pairs to label the host, such as cpu=4 to describe the host capabilities.
    location string
    The name or ID of the Satellite location
    satelliteHostId string
    (String) The unique identifier of the location. The ID is combination of location and host_id delimited by /.
    timeouts SatelliteHostTimeouts
    waitTill string
    Wait until location is normal
    workerPool string
    The name or ID of the worker pool within the cluster to assign the host to. wait_till - (Optional, String) If this argument is provided this resource will wait until location is normal. Allowed values: location_normal
    zone string
    (String) The zone within the cluster to assign the host to.
    cluster str
    The name or ID of a Satellite location or cluster to assign the host to.
    host_id str
    The name or ID of the specific host to assign to a Satellite location or cluster
    host_provider str
    The name of host provider, such as ibm, aws or azure.
    host_state str
    (String) Health status of the host.
    labels Sequence[str]
    The key value pairs to label the host, such as cpu=4 to describe the host capabilities.
    location str
    The name or ID of the Satellite location
    satellite_host_id str
    (String) The unique identifier of the location. The ID is combination of location and host_id delimited by /.
    timeouts SatelliteHostTimeoutsArgs
    wait_till str
    Wait until location is normal
    worker_pool str
    The name or ID of the worker pool within the cluster to assign the host to. wait_till - (Optional, String) If this argument is provided this resource will wait until location is normal. Allowed values: location_normal
    zone str
    (String) The zone within the cluster to assign the host to.
    cluster String
    The name or ID of a Satellite location or cluster to assign the host to.
    hostId String
    The name or ID of the specific host to assign to a Satellite location or cluster
    hostProvider String
    The name of host provider, such as ibm, aws or azure.
    hostState String
    (String) Health status of the host.
    labels List<String>
    The key value pairs to label the host, such as cpu=4 to describe the host capabilities.
    location String
    The name or ID of the Satellite location
    satelliteHostId String
    (String) The unique identifier of the location. The ID is combination of location and host_id delimited by /.
    timeouts Property Map
    waitTill String
    Wait until location is normal
    workerPool String
    The name or ID of the worker pool within the cluster to assign the host to. wait_till - (Optional, String) If this argument is provided this resource will wait until location is normal. Allowed values: location_normal
    zone String
    (String) The zone within the cluster to assign the host to.

    Supporting Types

    SatelliteHostTimeouts, SatelliteHostTimeoutsArgs

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

    Import

    The ibm_satellite_host resource can be imported by using the location and host ID.

    Syntax

    $ pulumi import ibm:index/satelliteHost:SatelliteHost host location/host_id

    Example

    $ pulumi import ibm:index/satelliteHost:SatelliteHost host satellite-ibm/c0kinbr12312312

    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.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud
    ibm-cloud/terraform-provider-ibm