ibm 1.78.0, Apr 30 25

ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud

ibm.getSatelliteClusterWorkerPool

Explore with Pulumi AI

ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud

Example Usage

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

const workerPool = ibm.getSatelliteClusterWorkerPool({
    name: _var.worker_pool_name,
    cluster: _var.cluster,
});

import pulumi
import pulumi_ibm as ibm

worker_pool = ibm.get_satellite_cluster_worker_pool(name=var["worker_pool_name"],
    cluster=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.LookupSatelliteClusterWorkerPool(ctx, &ibm.LookupSatelliteClusterWorkerPoolArgs{
			Name:    _var.Worker_pool_name,
			Cluster: _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 workerPool = Ibm.GetSatelliteClusterWorkerPool.Invoke(new()
    {
        Name = @var.Worker_pool_name,
        Cluster = @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.GetSatelliteClusterWorkerPoolArgs;
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 workerPool = IbmFunctions.getSatelliteClusterWorkerPool(GetSatelliteClusterWorkerPoolArgs.builder()
            .name(var_.worker_pool_name())
            .cluster(var_.cluster())
            .build());

    }
}

variables:
  workerPool:
    fn::invoke:
      function: ibm:getSatelliteClusterWorkerPool
      arguments:
        name: ${var.worker_pool_name}
        cluster: ${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 worker pool.
cluster - (String) The name or ID of the satellite cluster.
flavor - (String) The flavor of the satellite worker node.
operating_system (String) The operating system of the hosts in the worker pool.
provider - (String) Provider of this offering.
state - (String) The state of the worker pool.
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.
worker_pool_labels - (String) Labels on all the workers in the worker pool.
host_labels - (String) Host labels on the workers.
isolation - (String) Isolation of the worker node.
auto_scale_enabled - (String) Enable auto scalling for worker pool.
worker_count - (String) The number of workers that are attached.
openshift_license_source - (String) The license source for OpenShift.

Using getSatelliteClusterWorkerPool

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 getSatelliteClusterWorkerPool(args: GetSatelliteClusterWorkerPoolArgs, opts?: InvokeOptions): Promise<GetSatelliteClusterWorkerPoolResult>
function getSatelliteClusterWorkerPoolOutput(args: GetSatelliteClusterWorkerPoolOutputArgs, opts?: InvokeOptions): Output<GetSatelliteClusterWorkerPoolResult>

def get_satellite_cluster_worker_pool(cluster: Optional[str] = None,
                                      id: Optional[str] = None,
                                      name: Optional[str] = None,
                                      region: Optional[str] = None,
                                      resource_group_id: Optional[str] = None,
                                      opts: Optional[InvokeOptions] = None) -> GetSatelliteClusterWorkerPoolResult
def get_satellite_cluster_worker_pool_output(cluster: Optional[pulumi.Input[str]] = None,
                                      id: Optional[pulumi.Input[str]] = None,
                                      name: Optional[pulumi.Input[str]] = None,
                                      region: Optional[pulumi.Input[str]] = None,
                                      resource_group_id: Optional[pulumi.Input[str]] = None,
                                      opts: Optional[InvokeOptions] = None) -> Output[GetSatelliteClusterWorkerPoolResult]

func LookupSatelliteClusterWorkerPool(ctx *Context, args *LookupSatelliteClusterWorkerPoolArgs, opts ...InvokeOption) (*LookupSatelliteClusterWorkerPoolResult, error)
func LookupSatelliteClusterWorkerPoolOutput(ctx *Context, args *LookupSatelliteClusterWorkerPoolOutputArgs, opts ...InvokeOption) LookupSatelliteClusterWorkerPoolResultOutput

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

public static class GetSatelliteClusterWorkerPool 
{
    public static Task<GetSatelliteClusterWorkerPoolResult> InvokeAsync(GetSatelliteClusterWorkerPoolArgs args, InvokeOptions? opts = null)
    public static Output<GetSatelliteClusterWorkerPoolResult> Invoke(GetSatelliteClusterWorkerPoolInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetSatelliteClusterWorkerPoolResult> getSatelliteClusterWorkerPool(GetSatelliteClusterWorkerPoolArgs args, InvokeOptions options)
public static Output<GetSatelliteClusterWorkerPoolResult> getSatelliteClusterWorkerPool(GetSatelliteClusterWorkerPoolArgs args, InvokeOptions options)

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

The following arguments are supported:

Cluster string: The name or ID of the satellite. cluster.
Name string: The name or ID of the worker pool.
Id string
Region string: The name of the region.
ResourceGroupId string: The ID of the resource group.

Cluster string: The name or ID of the satellite. cluster.
Name string: The name or ID of the worker pool.
Id string
Region string: The name of the region.
ResourceGroupId string: The ID of the resource group.

cluster String: The name or ID of the satellite. cluster.
name String: The name or ID of the worker pool.
id String
region String: The name of the region.
resourceGroupId String: The ID of the resource group.

cluster string: The name or ID of the satellite. cluster.
name string: The name or ID of the worker pool.
id string
region string: The name of the region.
resourceGroupId string: The ID of the resource group.

cluster str: The name or ID of the satellite. cluster.
name str: The name or ID of the worker pool.
id str
region str: The name of the region.
resource_group_id str: The ID of the resource group.

cluster String: The name or ID of the satellite. cluster.
name String: The name or ID of the worker pool.
id String
region String: The name of the region.
resourceGroupId String: The ID of the resource group.

getSatelliteClusterWorkerPool Result

The following output properties are available:

AutoScaleEnabled bool
Cluster string
Flavor string
HostLabels Dictionary<string, string>
Id string
Isolation string
Name string
OpenshiftLicenseSource string
OperatingSystem string
Region string
ResourceGroupId string
State string
WorkerCount double
WorkerPoolLabels Dictionary<string, string>
Zones List<GetSatelliteClusterWorkerPoolZone>

AutoScaleEnabled bool
Cluster string
Flavor string
HostLabels map[string]string
Id string
Isolation string
Name string
OpenshiftLicenseSource string
OperatingSystem string
Region string
ResourceGroupId string
State string
WorkerCount float64
WorkerPoolLabels map[string]string
Zones []GetSatelliteClusterWorkerPoolZone

autoScaleEnabled Boolean
cluster String
flavor String
hostLabels Map<String,String>
id String
isolation String
name String
openshiftLicenseSource String
operatingSystem String
region String
resourceGroupId String
state String
workerCount Double
workerPoolLabels Map<String,String>
zones List<GetSatelliteClusterWorkerPoolZone>

autoScaleEnabled boolean
cluster string
flavor string
hostLabels {[key: string]: string}
id string
isolation string
name string
openshiftLicenseSource string
operatingSystem string
region string
resourceGroupId string
state string
workerCount number
workerPoolLabels {[key: string]: string}
zones GetSatelliteClusterWorkerPoolZone[]

auto_scale_enabled bool
cluster str
flavor str
host_labels Mapping[str, str]
id str
isolation str
name str
openshift_license_source str
operating_system str
region str
resource_group_id str
state str
worker_count float
worker_pool_labels Mapping[str, str]
zones Sequence[GetSatelliteClusterWorkerPoolZone]

autoScaleEnabled Boolean
cluster String
flavor String
hostLabels Map<String>
id String
isolation String
name String
openshiftLicenseSource String
operatingSystem String
region String
resourceGroupId String
state String
workerCount Number
workerPoolLabels Map<String>
zones List<Property Map>

Supporting Types

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

ibm-cloud/terraform-provider-ibm

ibm.getSatelliteClusterWorkerPool

On this page

On this page

Example Usage

Attributes reference

Using getSatelliteClusterWorkerPool

getSatelliteClusterWorkerPool Result

Supporting Types

GetSatelliteClusterWorkerPoolZone

Package Details

On this page

On this page