ibm 1.77.1, Apr 14 25

ibm 1.77.1 published on Monday, Apr 14, 2025 by ibm-cloud

ibm.getSatelliteCluster

Explore with Pulumi AI

ibm 1.77.1 published on Monday, Apr 14, 2025 by ibm-cloud

Example Usage

TypeScript
Python
Go
C#
Java
YAML

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

const cluster = ibm.getSatelliteCluster({
    name: _var.cluster,
});

import pulumi
import pulumi_ibm as ibm

cluster = ibm.get_satellite_cluster(name=var["cluster"])

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.LookupSatelliteCluster(ctx, &ibm.LookupSatelliteClusterArgs{
			Name: _var.Cluster,
		}, 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 cluster = Ibm.GetSatelliteCluster.Invoke(new()
    {
        Name = @var.Cluster,
    });

});

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.GetSatelliteClusterArgs;
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 cluster = IbmFunctions.getSatelliteCluster(GetSatelliteClusterArgs.builder()
            .name(var_.cluster())
            .build());

    }
}

variables:
  cluster:
    fn::invoke:
      function: ibm:getSatelliteCluster
      arguments:
        name: ${var.cluster}

Attributes reference

In addition to all argument references list, you can access the following attribute references after your resource is created.

id - (String) The unique identifier of the location.
location - (String) The name or ID of the location.
state - (String) The state of cluster.
status - (String) The status of cluster.
server_url - (String) The URL of the master.
health - (String) The health of cluster master.
crn - (String) The CRN for this satellite cluster.
kube_version - (String) The Kubernetes version, including at least the major.minor version. To see available versions, run ibmcloud ks versions.
worker_count - (String) The number of workers that are attached to the cluster.
workers - (String) The IDs of the workers that are attached to the cluster.
worker_pools- (List) The collection of worker nodes in a cluster.
infrastructure_topology - (String) The infrastructure topology status for this cluster.
Nested scheme for worker_pools:
- name- (String) The name of the worker pool.
- flavor- (String) The flavor of the worker node.
- worker_count- (String) The total number of workers.
- isolation- (String) The isolation for the worker node.
- id- (String) The ID of the cluster.
- default_worker_pool_labels- (String) The labels on the default workerpool.
- host_labels- (String) The host labels of the workers.
- zones- (List) A nested block describing the zones of this worker_pool.
  Nested scheme for zones:
  - zone- (String) The name of the zone.
  - workercount- (String) The number of worker nodes in the current worker pool.
ingress_hostname - (String) The Ingress hostname.
ingress_secret - (String) The Ingress secret.
private_service_endpoint_url - (String) The private service endpoint URL.
public_service_endpoint_url - (String) The public service endpoint URL.
public_service_endpoint - (Bool) Is public service endpoint enabled to make the master publicly accessible.
private_service_endpoint - (Bool) Is private service endpoint enabled to make the master privately accessible.
resource_group_id - (String) The ID of the resource group.
resource_group_name - (String) The name of the resource group.
tags - (String) The tags associated with cluster.

Using getSatelliteCluster

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.

TypeScript
Python
Go
C#
Java
YAML

function getSatelliteCluster(args: GetSatelliteClusterArgs, opts?: InvokeOptions): Promise<GetSatelliteClusterResult>
function getSatelliteClusterOutput(args: GetSatelliteClusterOutputArgs, opts?: InvokeOptions): Output<GetSatelliteClusterResult>

def get_satellite_cluster(id: Optional[str] = None,
                          name: Optional[str] = None,
                          resource_group_id: Optional[str] = None,
                          opts: Optional[InvokeOptions] = None) -> GetSatelliteClusterResult
def get_satellite_cluster_output(id: Optional[pulumi.Input[str]] = None,
                          name: Optional[pulumi.Input[str]] = None,
                          resource_group_id: Optional[pulumi.Input[str]] = None,
                          opts: Optional[InvokeOptions] = None) -> Output[GetSatelliteClusterResult]

func LookupSatelliteCluster(ctx *Context, args *LookupSatelliteClusterArgs, opts ...InvokeOption) (*LookupSatelliteClusterResult, error)
func LookupSatelliteClusterOutput(ctx *Context, args *LookupSatelliteClusterOutputArgs, opts ...InvokeOption) LookupSatelliteClusterResultOutput

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

public static class GetSatelliteCluster 
{
    public static Task<GetSatelliteClusterResult> InvokeAsync(GetSatelliteClusterArgs args, InvokeOptions? opts = null)
    public static Output<GetSatelliteClusterResult> Invoke(GetSatelliteClusterInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetSatelliteClusterResult> getSatelliteCluster(GetSatelliteClusterArgs args, InvokeOptions options)
public static Output<GetSatelliteClusterResult> getSatelliteCluster(GetSatelliteClusterArgs args, InvokeOptions options)

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

The following arguments are supported:

Name string: The name or ID of the Satellite cluster.
Id string
ResourceGroupId string

Name string: The name or ID of the Satellite cluster.
Id string
ResourceGroupId string

name String: The name or ID of the Satellite cluster.
id String
resourceGroupId String

name string: The name or ID of the Satellite cluster.
id string
resourceGroupId string

name str: The name or ID of the Satellite cluster.
id str
resource_group_id str

name String: The name or ID of the Satellite cluster.
id String
resourceGroupId String

getSatelliteCluster Result

The following output properties are available:

Crn string
Health string
Id string
InfrastructureTopology string
IngressHostname string
IngressSecret string
KubeVersion string
Location string
Name string
PrivateServiceEndpoint bool
PrivateServiceEndpointUrl string
PublicServiceEndpoint bool
PublicServiceEndpointUrl string
ResourceGroupId string
ResourceGroupName string
ServerUrl string
State string
Status string
Tags List<string>
WorkerCount double
WorkerPools List<GetSatelliteClusterWorkerPool>
Workers List<string>

Crn string
Health string
Id string
InfrastructureTopology string
IngressHostname string
IngressSecret string
KubeVersion string
Location string
Name string
PrivateServiceEndpoint bool
PrivateServiceEndpointUrl string
PublicServiceEndpoint bool
PublicServiceEndpointUrl string
ResourceGroupId string
ResourceGroupName string
ServerUrl string
State string
Status string
Tags []string
WorkerCount float64
WorkerPools []GetSatelliteClusterWorkerPoolType
Workers []string

crn String
health String
id String
infrastructureTopology String
ingressHostname String
ingressSecret String
kubeVersion String
location String
name String
privateServiceEndpoint Boolean
privateServiceEndpointUrl String
publicServiceEndpoint Boolean
publicServiceEndpointUrl String
resourceGroupId String
resourceGroupName String
serverUrl String
state String
status String
tags List<String>
workerCount Double
workerPools List<GetSatelliteClusterWorkerPool>
workers List<String>

crn string
health string
id string
infrastructureTopology string
ingressHostname string
ingressSecret string
kubeVersion string
location string
name string
privateServiceEndpoint boolean
privateServiceEndpointUrl string
publicServiceEndpoint boolean
publicServiceEndpointUrl string
resourceGroupId string
resourceGroupName string
serverUrl string
state string
status string
tags string[]
workerCount number
workerPools GetSatelliteClusterWorkerPool[]
workers string[]

crn str
health str
id str
infrastructure_topology str
ingress_hostname str
ingress_secret str
kube_version str
location str
name str
private_service_endpoint bool
private_service_endpoint_url str
public_service_endpoint bool
public_service_endpoint_url str
resource_group_id str
resource_group_name str
server_url str
state str
status str
tags Sequence[str]
worker_count float
worker_pools Sequence[GetSatelliteClusterWorkerPool]
workers Sequence[str]

crn String
health String
id String
infrastructureTopology String
ingressHostname String
ingressSecret String
kubeVersion String
location String
name String
privateServiceEndpoint Boolean
privateServiceEndpointUrl String
publicServiceEndpoint Boolean
publicServiceEndpointUrl String
resourceGroupId String
resourceGroupName String
serverUrl String
state String
status String
tags List<String>
workerCount Number
workerPools List<Property Map>
workers List<String>

Supporting Types

GetSatelliteClusterWorkerPool

DefaultWorkerPoolLabels Dictionary<string, string>
Flavour string
HostLabels Dictionary<string, string>
Id string
Isolation string
Name string: The name or ID of the Satellite cluster.
SizePerZone double
State string
Zones List<GetSatelliteClusterWorkerPoolZone>

DefaultWorkerPoolLabels map[string]string
Flavour string
HostLabels map[string]string
Id string
Isolation string
Name string: The name or ID of the Satellite cluster.
SizePerZone float64
State string
Zones []GetSatelliteClusterWorkerPoolZone

defaultWorkerPoolLabels Map<String,String>
flavour String
hostLabels Map<String,String>
id String
isolation String
name String: The name or ID of the Satellite cluster.
sizePerZone Double
state String
zones List<GetSatelliteClusterWorkerPoolZone>

defaultWorkerPoolLabels {[key: string]: string}
flavour string
hostLabels {[key: string]: string}
id string
isolation string
name string: The name or ID of the Satellite cluster.
sizePerZone number
state string
zones GetSatelliteClusterWorkerPoolZone[]

default_worker_pool_labels Mapping[str, str]
flavour str
host_labels Mapping[str, str]
id str
isolation str
name str: The name or ID of the Satellite cluster.
size_per_zone float
state str
zones Sequence[GetSatelliteClusterWorkerPoolZone]

defaultWorkerPoolLabels Map<String>
flavour String
hostLabels Map<String>
id String
isolation String
name String: The name or ID of the Satellite cluster.
sizePerZone Number
state String
zones List<Property Map>

GetSatelliteClusterWorkerPoolZone

WorkerCount double
Zone string

WorkerCount float64
Zone string

workerCount Double
zone String

workerCount number
zone string

worker_count float
zone str

workerCount Number
zone String

Package Details

Repository: ibm ibm-cloud/terraform-provider-ibm
License
Notes: This Pulumi package is based on the ibm Terraform Provider.

ibm 1.77.1 published on Monday, Apr 14, 2025 by ibm-cloud

ibm-cloud/terraform-provider-ibm

ibm.getSatelliteCluster

On this page

On this page

Example Usage

Attributes reference

Using getSatelliteCluster

getSatelliteCluster Result

Supporting Types

GetSatelliteClusterWorkerPool

GetSatelliteClusterWorkerPoolZone

Package Details

On this page

On this page