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

ibm.getContainerClusterWorker

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 about the worker nodes of your IBM Cloud Kubernetes Service cluster. For more information, about cluster worker, see updating clusters, worker nodes, and cluster components.

    Example Usage

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

const clusterFoo = ibm.getContainerClusterWorker({
    workerId: "dev-mex10-pa70c4414695c041518603bfd0cd6e333a-w1",
});

    import pulumi
import pulumi_ibm as ibm

cluster_foo = ibm.get_container_cluster_worker(worker_id="dev-mex10-pa70c4414695c041518603bfd0cd6e333a-w1")

    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.GetContainerClusterWorker(ctx, &ibm.GetContainerClusterWorkerArgs{
			WorkerId: "dev-mex10-pa70c4414695c041518603bfd0cd6e333a-w1",
		}, 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 clusterFoo = Ibm.GetContainerClusterWorker.Invoke(new()
    {
        WorkerId = "dev-mex10-pa70c4414695c041518603bfd0cd6e333a-w1",
    });

});

    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.GetContainerClusterWorkerArgs;
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 clusterFoo = IbmFunctions.getContainerClusterWorker(GetContainerClusterWorkerArgs.builder()
            .workerId("dev-mex10-pa70c4414695c041518603bfd0cd6e333a-w1")
            .build());

    }
}

    variables:
  clusterFoo:
    fn::invoke:
      function: ibm:getContainerClusterWorker
      arguments:
        workerId: dev-mex10-pa70c4414695c041518603bfd0cd6e333a-w1

    Using getContainerClusterWorker

    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 getContainerClusterWorker(args: GetContainerClusterWorkerArgs, opts?: InvokeOptions): Promise<GetContainerClusterWorkerResult>
function getContainerClusterWorkerOutput(args: GetContainerClusterWorkerOutputArgs, opts?: InvokeOptions): Output<GetContainerClusterWorkerResult>
    def get_container_cluster_worker(account_guid: Optional[str] = None,
                                 id: Optional[str] = None,
                                 org_guid: Optional[str] = None,
                                 region: Optional[str] = None,
                                 resource_group_id: Optional[str] = None,
                                 space_guid: Optional[str] = None,
                                 worker_id: Optional[str] = None,
                                 opts: Optional[InvokeOptions] = None) -> GetContainerClusterWorkerResult
def get_container_cluster_worker_output(account_guid: Optional[pulumi.Input[str]] = None,
                                 id: Optional[pulumi.Input[str]] = None,
                                 org_guid: Optional[pulumi.Input[str]] = None,
                                 region: Optional[pulumi.Input[str]] = None,
                                 resource_group_id: Optional[pulumi.Input[str]] = None,
                                 space_guid: Optional[pulumi.Input[str]] = None,
                                 worker_id: Optional[pulumi.Input[str]] = None,
                                 opts: Optional[InvokeOptions] = None) -> Output[GetContainerClusterWorkerResult]
    func GetContainerClusterWorker(ctx *Context, args *GetContainerClusterWorkerArgs, opts ...InvokeOption) (*GetContainerClusterWorkerResult, error)
func GetContainerClusterWorkerOutput(ctx *Context, args *GetContainerClusterWorkerOutputArgs, opts ...InvokeOption) GetContainerClusterWorkerResultOutput

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

    public static class GetContainerClusterWorker 
{
    public static Task<GetContainerClusterWorkerResult> InvokeAsync(GetContainerClusterWorkerArgs args, InvokeOptions? opts = null)
    public static Output<GetContainerClusterWorkerResult> Invoke(GetContainerClusterWorkerInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetContainerClusterWorkerResult> getContainerClusterWorker(GetContainerClusterWorkerArgs args, InvokeOptions options)
public static Output<GetContainerClusterWorkerResult> getContainerClusterWorker(GetContainerClusterWorkerArgs args, InvokeOptions options)

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

    The following arguments are supported:

    WorkerId string

    The ID of the worker node for which you want to retrieve information. To find the ID, run ibmcloud ks worker ls cluster <cluster_name_or_ID>.

    Deprecated reference

    AccountGuid string
    The GUID for the IBM Cloud account that the cluster is associated with. You can retrieve the value from the ibm.getAccount data source or by running the ibmcloud iam accounts command in the IBM Cloud CLI.

    Deprecated: Deprecated

    Id string
    OrgGuid string
    The GUID for the IBM Cloud organization that the cluster is associated with. You can retrieve the value from the ibm.Org data source or by running the ibmcloud iam orgs --guid command in the IBM Cloud CLI.

    Deprecated: Deprecated

    Region string
    The region where the worker is provisioned. If the region is not specified it will be defaulted to provider region(IC_REGION/IBMCLOUD_REGION). To get the list of supported regions please access this link and use the alias.

    Deprecated: Deprecated

    ResourceGroupId string
    The ID of the resource group where your cluster is provisioned into. To find the resource group, run ibmcloud resource groups or use the ibm.ResourceGroup data source. If this parameter is not provided, the default resource group is used.
    SpaceGuid string
    The GUID for the IBM Cloud space that the cluster is associated with. You can retrieve the value from the ibm.Space data source or by running the ibmcloud iam space <space-name> --guid command in the IBM Cloud CLI.

    Deprecated: Deprecated

    WorkerId string

    The ID of the worker node for which you want to retrieve information. To find the ID, run ibmcloud ks worker ls cluster <cluster_name_or_ID>.

    Deprecated reference

    AccountGuid string
    The GUID for the IBM Cloud account that the cluster is associated with. You can retrieve the value from the ibm.getAccount data source or by running the ibmcloud iam accounts command in the IBM Cloud CLI.

    Deprecated: Deprecated

    Id string
    OrgGuid string
    The GUID for the IBM Cloud organization that the cluster is associated with. You can retrieve the value from the ibm.Org data source or by running the ibmcloud iam orgs --guid command in the IBM Cloud CLI.

    Deprecated: Deprecated

    Region string
    The region where the worker is provisioned. If the region is not specified it will be defaulted to provider region(IC_REGION/IBMCLOUD_REGION). To get the list of supported regions please access this link and use the alias.

    Deprecated: Deprecated

    ResourceGroupId string
    The ID of the resource group where your cluster is provisioned into. To find the resource group, run ibmcloud resource groups or use the ibm.ResourceGroup data source. If this parameter is not provided, the default resource group is used.
    SpaceGuid string
    The GUID for the IBM Cloud space that the cluster is associated with. You can retrieve the value from the ibm.Space data source or by running the ibmcloud iam space <space-name> --guid command in the IBM Cloud CLI.

    Deprecated: Deprecated

    workerId String

    The ID of the worker node for which you want to retrieve information. To find the ID, run ibmcloud ks worker ls cluster <cluster_name_or_ID>.

    Deprecated reference

    accountGuid String
    The GUID for the IBM Cloud account that the cluster is associated with. You can retrieve the value from the ibm.getAccount data source or by running the ibmcloud iam accounts command in the IBM Cloud CLI.

    Deprecated: Deprecated

    id String
    orgGuid String
    The GUID for the IBM Cloud organization that the cluster is associated with. You can retrieve the value from the ibm.Org data source or by running the ibmcloud iam orgs --guid command in the IBM Cloud CLI.

    Deprecated: Deprecated

    region String
    The region where the worker is provisioned. If the region is not specified it will be defaulted to provider region(IC_REGION/IBMCLOUD_REGION). To get the list of supported regions please access this link and use the alias.

    Deprecated: Deprecated

    resourceGroupId String
    The ID of the resource group where your cluster is provisioned into. To find the resource group, run ibmcloud resource groups or use the ibm.ResourceGroup data source. If this parameter is not provided, the default resource group is used.
    spaceGuid String
    The GUID for the IBM Cloud space that the cluster is associated with. You can retrieve the value from the ibm.Space data source or by running the ibmcloud iam space <space-name> --guid command in the IBM Cloud CLI.

    Deprecated: Deprecated

    workerId string

    The ID of the worker node for which you want to retrieve information. To find the ID, run ibmcloud ks worker ls cluster <cluster_name_or_ID>.

    Deprecated reference

    accountGuid string
    The GUID for the IBM Cloud account that the cluster is associated with. You can retrieve the value from the ibm.getAccount data source or by running the ibmcloud iam accounts command in the IBM Cloud CLI.

    Deprecated: Deprecated

    id string
    orgGuid string
    The GUID for the IBM Cloud organization that the cluster is associated with. You can retrieve the value from the ibm.Org data source or by running the ibmcloud iam orgs --guid command in the IBM Cloud CLI.

    Deprecated: Deprecated

    region string
    The region where the worker is provisioned. If the region is not specified it will be defaulted to provider region(IC_REGION/IBMCLOUD_REGION). To get the list of supported regions please access this link and use the alias.

    Deprecated: Deprecated

    resourceGroupId string
    The ID of the resource group where your cluster is provisioned into. To find the resource group, run ibmcloud resource groups or use the ibm.ResourceGroup data source. If this parameter is not provided, the default resource group is used.
    spaceGuid string
    The GUID for the IBM Cloud space that the cluster is associated with. You can retrieve the value from the ibm.Space data source or by running the ibmcloud iam space <space-name> --guid command in the IBM Cloud CLI.

    Deprecated: Deprecated

    worker_id str

    The ID of the worker node for which you want to retrieve information. To find the ID, run ibmcloud ks worker ls cluster <cluster_name_or_ID>.

    Deprecated reference

    account_guid str
    The GUID for the IBM Cloud account that the cluster is associated with. You can retrieve the value from the ibm.getAccount data source or by running the ibmcloud iam accounts command in the IBM Cloud CLI.

    Deprecated: Deprecated

    id str
    org_guid str
    The GUID for the IBM Cloud organization that the cluster is associated with. You can retrieve the value from the ibm.Org data source or by running the ibmcloud iam orgs --guid command in the IBM Cloud CLI.

    Deprecated: Deprecated

    region str
    The region where the worker is provisioned. If the region is not specified it will be defaulted to provider region(IC_REGION/IBMCLOUD_REGION). To get the list of supported regions please access this link and use the alias.

    Deprecated: Deprecated

    resource_group_id str
    The ID of the resource group where your cluster is provisioned into. To find the resource group, run ibmcloud resource groups or use the ibm.ResourceGroup data source. If this parameter is not provided, the default resource group is used.
    space_guid str
    The GUID for the IBM Cloud space that the cluster is associated with. You can retrieve the value from the ibm.Space data source or by running the ibmcloud iam space <space-name> --guid command in the IBM Cloud CLI.

    Deprecated: Deprecated

    workerId String

    The ID of the worker node for which you want to retrieve information. To find the ID, run ibmcloud ks worker ls cluster <cluster_name_or_ID>.

    Deprecated reference

    accountGuid String
    The GUID for the IBM Cloud account that the cluster is associated with. You can retrieve the value from the ibm.getAccount data source or by running the ibmcloud iam accounts command in the IBM Cloud CLI.

    Deprecated: Deprecated

    id String
    orgGuid String
    The GUID for the IBM Cloud organization that the cluster is associated with. You can retrieve the value from the ibm.Org data source or by running the ibmcloud iam orgs --guid command in the IBM Cloud CLI.

    Deprecated: Deprecated

    region String
    The region where the worker is provisioned. If the region is not specified it will be defaulted to provider region(IC_REGION/IBMCLOUD_REGION). To get the list of supported regions please access this link and use the alias.

    Deprecated: Deprecated

    resourceGroupId String
    The ID of the resource group where your cluster is provisioned into. To find the resource group, run ibmcloud resource groups or use the ibm.ResourceGroup data source. If this parameter is not provided, the default resource group is used.
    spaceGuid String
    The GUID for the IBM Cloud space that the cluster is associated with. You can retrieve the value from the ibm.Space data source or by running the ibmcloud iam space <space-name> --guid command in the IBM Cloud CLI.

    Deprecated: Deprecated

    getContainerClusterWorker Result

    The following output properties are available:

    Id string
    PrivateIp string
    (String) The private IP address that is assigned to the worker node.
    PrivateVlan string
    (String) The ID of the private VLAN that the worker node is attached to.
    PublicIp string
    (String) The public IP address that is assigned to the worker node.
    PublicVlan string
    (String) The ID of the public VLAN that the worker node is attached to.
    ResourceControllerUrl string
    State string
    (String) The state of the worker node.
    Status string
    (String) The status of the worker node.
    WorkerId string
    AccountGuid string

    Deprecated: Deprecated

    OrgGuid string

    Deprecated: Deprecated

    Region string

    Deprecated: Deprecated

    ResourceGroupId string
    SpaceGuid string

    Deprecated: Deprecated

    Id string
    PrivateIp string
    (String) The private IP address that is assigned to the worker node.
    PrivateVlan string
    (String) The ID of the private VLAN that the worker node is attached to.
    PublicIp string
    (String) The public IP address that is assigned to the worker node.
    PublicVlan string
    (String) The ID of the public VLAN that the worker node is attached to.
    ResourceControllerUrl string
    State string
    (String) The state of the worker node.
    Status string
    (String) The status of the worker node.
    WorkerId string
    AccountGuid string

    Deprecated: Deprecated

    OrgGuid string

    Deprecated: Deprecated

    Region string

    Deprecated: Deprecated

    ResourceGroupId string
    SpaceGuid string

    Deprecated: Deprecated

    id String
    privateIp String
    (String) The private IP address that is assigned to the worker node.
    privateVlan String
    (String) The ID of the private VLAN that the worker node is attached to.
    publicIp String
    (String) The public IP address that is assigned to the worker node.
    publicVlan String
    (String) The ID of the public VLAN that the worker node is attached to.
    resourceControllerUrl String
    state String
    (String) The state of the worker node.
    status String
    (String) The status of the worker node.
    workerId String
    accountGuid String

    Deprecated: Deprecated

    orgGuid String

    Deprecated: Deprecated

    region String

    Deprecated: Deprecated

    resourceGroupId String
    spaceGuid String

    Deprecated: Deprecated

    id string
    privateIp string
    (String) The private IP address that is assigned to the worker node.
    privateVlan string
    (String) The ID of the private VLAN that the worker node is attached to.
    publicIp string
    (String) The public IP address that is assigned to the worker node.
    publicVlan string
    (String) The ID of the public VLAN that the worker node is attached to.
    resourceControllerUrl string
    state string
    (String) The state of the worker node.
    status string
    (String) The status of the worker node.
    workerId string
    accountGuid string

    Deprecated: Deprecated

    orgGuid string

    Deprecated: Deprecated

    region string

    Deprecated: Deprecated

    resourceGroupId string
    spaceGuid string

    Deprecated: Deprecated

    id str
    private_ip str
    (String) The private IP address that is assigned to the worker node.
    private_vlan str
    (String) The ID of the private VLAN that the worker node is attached to.
    public_ip str
    (String) The public IP address that is assigned to the worker node.
    public_vlan str
    (String) The ID of the public VLAN that the worker node is attached to.
    resource_controller_url str
    state str
    (String) The state of the worker node.
    status str
    (String) The status of the worker node.
    worker_id str
    account_guid str

    Deprecated: Deprecated

    org_guid str

    Deprecated: Deprecated

    region str

    Deprecated: Deprecated

    resource_group_id str
    space_guid str

    Deprecated: Deprecated

    id String
    privateIp String
    (String) The private IP address that is assigned to the worker node.
    privateVlan String
    (String) The ID of the private VLAN that the worker node is attached to.
    publicIp String
    (String) The public IP address that is assigned to the worker node.
    publicVlan String
    (String) The ID of the public VLAN that the worker node is attached to.
    resourceControllerUrl String
    state String
    (String) The state of the worker node.
    status String
    (String) The status of the worker node.
    workerId String
    accountGuid String

    Deprecated: Deprecated

    orgGuid String

    Deprecated: Deprecated

    region String

    Deprecated: Deprecated

    resourceGroupId String
    spaceGuid String

    Deprecated: Deprecated

    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