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

ibm.getSatelliteLocation

Explore with Pulumi AI

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

    Retrieve information of an existing Satellite location. You can then reference the fields of the data source in other resources within the same configuration by using interpolation syntax. For more information, about IBM Cloud regions for Satellite see Satellite regions.

    Example Usage

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

const location = ibm.getSatelliteLocation({
    location: _var.location,
});

    import pulumi
import pulumi_ibm as ibm

location = ibm.get_satellite_location(location=var["location"])

    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.LookupSatelliteLocation(ctx, &ibm.LookupSatelliteLocationArgs{
			Location: _var.Location,
		}, nil)
		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 location = Ibm.GetSatelliteLocation.Invoke(new()
    {
        Location = @var.Location,
    });

});

    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.GetSatelliteLocationArgs;
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 location = IbmFunctions.getSatelliteLocation(GetSatelliteLocationArgs.builder()
            .location(var_.location())
            .build());

    }
}

    variables:
  location:
    fn::invoke:
      function: ibm:getSatelliteLocation
      arguments:
        location: ${var.location}

    Using getSatelliteLocation

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getSatelliteLocation(args: GetSatelliteLocationArgs, opts?: InvokeOptions): Promise<GetSatelliteLocationResult>
function getSatelliteLocationOutput(args: GetSatelliteLocationOutputArgs, opts?: InvokeOptions): Output<GetSatelliteLocationResult>
    def get_satellite_location(id: Optional[str] = None,
                           location: Optional[str] = None,
                           opts: Optional[InvokeOptions] = None) -> GetSatelliteLocationResult
def get_satellite_location_output(id: Optional[pulumi.Input[str]] = None,
                           location: Optional[pulumi.Input[str]] = None,
                           opts: Optional[InvokeOptions] = None) -> Output[GetSatelliteLocationResult]
    func LookupSatelliteLocation(ctx *Context, args *LookupSatelliteLocationArgs, opts ...InvokeOption) (*LookupSatelliteLocationResult, error)
func LookupSatelliteLocationOutput(ctx *Context, args *LookupSatelliteLocationOutputArgs, opts ...InvokeOption) LookupSatelliteLocationResultOutput

    > Note: This function is named LookupSatelliteLocation in the Go SDK.

    public static class GetSatelliteLocation 
{
    public static Task<GetSatelliteLocationResult> InvokeAsync(GetSatelliteLocationArgs args, InvokeOptions? opts = null)
    public static Output<GetSatelliteLocationResult> Invoke(GetSatelliteLocationInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetSatelliteLocationResult> getSatelliteLocation(GetSatelliteLocationArgs args, InvokeOptions options)
public static Output<GetSatelliteLocationResult> getSatelliteLocation(GetSatelliteLocationArgs args, InvokeOptions options)

    fn::invoke:
  function: ibm:index/getSatelliteLocation:getSatelliteLocation
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Location string
    The name or ID of the Satellite location to be created or pass existing location.
    Id string
    (String) The unique identifier of the location.
    Location string
    The name or ID of the Satellite location to be created or pass existing location.
    Id string
    (String) The unique identifier of the location.
    location String
    The name or ID of the Satellite location to be created or pass existing location.
    id String
    (String) The unique identifier of the location.
    location string
    The name or ID of the Satellite location to be created or pass existing location.
    id string
    (String) The unique identifier of the location.
    location str
    The name or ID of the Satellite location to be created or pass existing location.
    id str
    (String) The unique identifier of the location.
    location String
    The name or ID of the Satellite location to be created or pass existing location.
    id String
    (String) The unique identifier of the location.

    getSatelliteLocation Result

    The following output properties are available:

    Capabilities List<string>
    (Array of Strings) Satellite capabilities(in the Kubernetes Service API, the parameter 'capabilities' is called'capabilitiesManagedBySatellite') attached to the Satellite location.
    CoreosEnabled bool
    (Bool) If Red Hat CoreOS features are enabled within the Satellite location.
    CreatedOn string
    (Timestamp) The created time of the satellite location.
    Crn string
    (String) The CRN for this satellite location.
    Description string
    (String) Description of the new Satellite location.
    HostAttachedCount double
    (Integer) The total number of hosts that are attached to the Satellite location.
    HostAvailableCount double
    (Integer) The available number of hosts that can be assigned to a cluster resource in the Satellite location.
    Hosts List<GetSatelliteLocationHost>
    Collection of hosts in a location
    Id string
    (String) The unique identifier of the location.
    IngressHostname string
    (String) The Ingress hostname.
    IngressSecret string
    (String) The Ingress secret.
    Location string
    LoggingAccountId string
    (String) The account ID for IBM Cloud Log Analysis with IBM Cloud Log Analysis log forwarding.
    ManagedFrom string
    (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
    (String) The physical address of the Satellite location which is deployed on premise.
    PodSubnet string
    ResourceGroupId string
    (String) The ID of the resource group.
    ResourceGroupName string
    (String) The name of the resource group.
    ServiceSubnet string
    Tags List<string>
    (String) List of tags associated with resource instance.
    Zones List<string>
    (String) 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
    (Array of Strings) Satellite capabilities(in the Kubernetes Service API, the parameter 'capabilities' is called'capabilitiesManagedBySatellite') attached to the Satellite location.
    CoreosEnabled bool
    (Bool) If Red Hat CoreOS features are enabled within the Satellite location.
    CreatedOn string
    (Timestamp) The created time of the satellite location.
    Crn string
    (String) The CRN for this satellite location.
    Description string
    (String) Description of the new Satellite location.
    HostAttachedCount float64
    (Integer) The total number of hosts that are attached to the Satellite location.
    HostAvailableCount float64
    (Integer) The available number of hosts that can be assigned to a cluster resource in the Satellite location.
    Hosts []GetSatelliteLocationHost
    Collection of hosts in a location
    Id string
    (String) The unique identifier of the location.
    IngressHostname string
    (String) The Ingress hostname.
    IngressSecret string
    (String) The Ingress secret.
    Location string
    LoggingAccountId string
    (String) The account ID for IBM Cloud Log Analysis with IBM Cloud Log Analysis log forwarding.
    ManagedFrom string
    (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
    (String) The physical address of the Satellite location which is deployed on premise.
    PodSubnet string
    ResourceGroupId string
    (String) The ID of the resource group.
    ResourceGroupName string
    (String) The name of the resource group.
    ServiceSubnet string
    Tags []string
    (String) List of tags associated with resource instance.
    Zones []string
    (String) 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>
    (Array of Strings) Satellite capabilities(in the Kubernetes Service API, the parameter 'capabilities' is called'capabilitiesManagedBySatellite') attached to the Satellite location.
    coreosEnabled Boolean
    (Bool) If Red Hat CoreOS features are enabled within the Satellite location.
    createdOn String
    (Timestamp) The created time of the satellite location.
    crn String
    (String) The CRN for this satellite location.
    description String
    (String) Description of the new Satellite location.
    hostAttachedCount Double
    (Integer) The total number of hosts that are attached to the Satellite location.
    hostAvailableCount Double
    (Integer) The available number of hosts that can be assigned to a cluster resource in the Satellite location.
    hosts List<GetSatelliteLocationHost>
    Collection of hosts in a location
    id String
    (String) The unique identifier of the location.
    ingressHostname String
    (String) The Ingress hostname.
    ingressSecret String
    (String) The Ingress secret.
    location String
    loggingAccountId String
    (String) The account ID for IBM Cloud Log Analysis with IBM Cloud Log Analysis log forwarding.
    managedFrom String
    (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
    (String) The physical address of the Satellite location which is deployed on premise.
    podSubnet String
    resourceGroupId String
    (String) The ID of the resource group.
    resourceGroupName String
    (String) The name of the resource group.
    serviceSubnet String
    tags List<String>
    (String) List of tags associated with resource instance.
    zones List<String>
    (String) 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[]
    (Array of Strings) Satellite capabilities(in the Kubernetes Service API, the parameter 'capabilities' is called'capabilitiesManagedBySatellite') attached to the Satellite location.
    coreosEnabled boolean
    (Bool) If Red Hat CoreOS features are enabled within the Satellite location.
    createdOn string
    (Timestamp) The created time of the satellite location.
    crn string
    (String) The CRN for this satellite location.
    description string
    (String) Description of the new Satellite location.
    hostAttachedCount number
    (Integer) The total number of hosts that are attached to the Satellite location.
    hostAvailableCount number
    (Integer) The available number of hosts that can be assigned to a cluster resource in the Satellite location.
    hosts GetSatelliteLocationHost[]
    Collection of hosts in a location
    id string
    (String) The unique identifier of the location.
    ingressHostname string
    (String) The Ingress hostname.
    ingressSecret string
    (String) The Ingress secret.
    location string
    loggingAccountId string
    (String) The account ID for IBM Cloud Log Analysis with IBM Cloud Log Analysis log forwarding.
    managedFrom string
    (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
    (String) The physical address of the Satellite location which is deployed on premise.
    podSubnet string
    resourceGroupId string
    (String) The ID of the resource group.
    resourceGroupName string
    (String) The name of the resource group.
    serviceSubnet string
    tags string[]
    (String) List of tags associated with resource instance.
    zones string[]
    (String) 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]
    (Array of Strings) Satellite capabilities(in the Kubernetes Service API, the parameter 'capabilities' is called'capabilitiesManagedBySatellite') attached to the Satellite location.
    coreos_enabled bool
    (Bool) If Red Hat CoreOS features are enabled within the Satellite location.
    created_on str
    (Timestamp) The created time of the satellite location.
    crn str
    (String) The CRN for this satellite location.
    description str
    (String) Description of the new Satellite location.
    host_attached_count float
    (Integer) The total number of hosts that are attached to the Satellite location.
    host_available_count float
    (Integer) The available number of hosts that can be assigned to a cluster resource in the Satellite location.
    hosts Sequence[GetSatelliteLocationHost]
    Collection of hosts in a location
    id str
    (String) The unique identifier of the location.
    ingress_hostname str
    (String) The Ingress hostname.
    ingress_secret str
    (String) The Ingress secret.
    location str
    logging_account_id str
    (String) The account ID for IBM Cloud Log Analysis with IBM Cloud Log Analysis log forwarding.
    managed_from str
    (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.
    physical_address str
    (String) The physical address of the Satellite location which is deployed on premise.
    pod_subnet str
    resource_group_id str
    (String) The ID of the resource group.
    resource_group_name str
    (String) The name of the resource group.
    service_subnet str
    tags Sequence[str]
    (String) List of tags associated with resource instance.
    zones Sequence[str]
    (String) 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>
    (Array of Strings) Satellite capabilities(in the Kubernetes Service API, the parameter 'capabilities' is called'capabilitiesManagedBySatellite') attached to the Satellite location.
    coreosEnabled Boolean
    (Bool) If Red Hat CoreOS features are enabled within the Satellite location.
    createdOn String
    (Timestamp) The created time of the satellite location.
    crn String
    (String) The CRN for this satellite location.
    description String
    (String) Description of the new Satellite location.
    hostAttachedCount Number
    (Integer) The total number of hosts that are attached to the Satellite location.
    hostAvailableCount Number
    (Integer) The available number of hosts that can be assigned to a cluster resource in the Satellite location.
    hosts List<Property Map>
    Collection of hosts in a location
    id String
    (String) The unique identifier of the location.
    ingressHostname String
    (String) The Ingress hostname.
    ingressSecret String
    (String) The Ingress secret.
    location String
    loggingAccountId String
    (String) The account ID for IBM Cloud Log Analysis with IBM Cloud Log Analysis log forwarding.
    managedFrom String
    (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
    (String) The physical address of the Satellite location which is deployed on premise.
    podSubnet String
    resourceGroupId String
    (String) The ID of the resource group.
    resourceGroupName String
    (String) The name of the resource group.
    serviceSubnet String
    tags List<String>
    (String) List of tags associated with resource instance.
    zones List<String>
    (String) 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

    GetSatelliteLocationHost

    ClusterName string
    Host are used for control plane or ROKS satellite cluster
    HostId string
    ID of the host
    HostLabels Dictionary<string, string>
    Host Labels
    HostName string
    Name of the host
    IpAddress string
    Status string
    Status of the host
    Zone string
    The name of the zone
    ClusterName string
    Host are used for control plane or ROKS satellite cluster
    HostId string
    ID of the host
    HostLabels map[string]string
    Host Labels
    HostName string
    Name of the host
    IpAddress string
    Status string
    Status of the host
    Zone string
    The name of the zone
    clusterName String
    Host are used for control plane or ROKS satellite cluster
    hostId String
    ID of the host
    hostLabels Map<String,String>
    Host Labels
    hostName String
    Name of the host
    ipAddress String
    status String
    Status of the host
    zone String
    The name of the zone
    clusterName string
    Host are used for control plane or ROKS satellite cluster
    hostId string
    ID of the host
    hostLabels {[key: string]: string}
    Host Labels
    hostName string
    Name of the host
    ipAddress string
    status string
    Status of the host
    zone string
    The name of the zone
    cluster_name str
    Host are used for control plane or ROKS satellite cluster
    host_id str
    ID of the host
    host_labels Mapping[str, str]
    Host Labels
    host_name str
    Name of the host
    ip_address str
    status str
    Status of the host
    zone str
    The name of the zone
    clusterName String
    Host are used for control plane or ROKS satellite cluster
    hostId String
    ID of the host
    hostLabels Map<String>
    Host Labels
    hostName String
    Name of the host
    ipAddress String
    status String
    Status of the host
    zone String
    The name of the zone

    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