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

ibm.getContainerVpcClusterWorker

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 VPC cluster. For more information, about VPC container cluster worker, see supported infrastructure providers.

    Example Usage

    The following example retrieves information about a worker node with the ID in the cluster.

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

const workerFoo = ibm.getContainerVpcClusterWorker({
    clusterNameId: "test",
    workerId: "dev-mex10-pa70c4414695c041518603bfd0cd6e333a-w1",
});

    import pulumi
import pulumi_ibm as ibm

worker_foo = ibm.get_container_vpc_cluster_worker(cluster_name_id="test",
    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.GetContainerVpcClusterWorker(ctx, &ibm.GetContainerVpcClusterWorkerArgs{
			ClusterNameId: "test",
			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 workerFoo = Ibm.GetContainerVpcClusterWorker.Invoke(new()
    {
        ClusterNameId = "test",
        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.GetContainerVpcClusterWorkerArgs;
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 workerFoo = IbmFunctions.getContainerVpcClusterWorker(GetContainerVpcClusterWorkerArgs.builder()
            .clusterNameId("test")
            .workerId("dev-mex10-pa70c4414695c041518603bfd0cd6e333a-w1")
            .build());

    }
}

    variables:
  workerFoo:
    fn::invoke:
      function: ibm:getContainerVpcClusterWorker
      arguments:
        clusterNameId: test
        workerId: dev-mex10-pa70c4414695c041518603bfd0cd6e333a-w1

    Using getContainerVpcClusterWorker

    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 getContainerVpcClusterWorker(args: GetContainerVpcClusterWorkerArgs, opts?: InvokeOptions): Promise<GetContainerVpcClusterWorkerResult>
function getContainerVpcClusterWorkerOutput(args: GetContainerVpcClusterWorkerOutputArgs, opts?: InvokeOptions): Output<GetContainerVpcClusterWorkerResult>
    def get_container_vpc_cluster_worker(cluster_name_id: Optional[str] = None,
                                     id: Optional[str] = None,
                                     resource_group_id: Optional[str] = None,
                                     worker_id: Optional[str] = None,
                                     opts: Optional[InvokeOptions] = None) -> GetContainerVpcClusterWorkerResult
def get_container_vpc_cluster_worker_output(cluster_name_id: Optional[pulumi.Input[str]] = None,
                                     id: Optional[pulumi.Input[str]] = None,
                                     resource_group_id: Optional[pulumi.Input[str]] = None,
                                     worker_id: Optional[pulumi.Input[str]] = None,
                                     opts: Optional[InvokeOptions] = None) -> Output[GetContainerVpcClusterWorkerResult]
    func GetContainerVpcClusterWorker(ctx *Context, args *GetContainerVpcClusterWorkerArgs, opts ...InvokeOption) (*GetContainerVpcClusterWorkerResult, error)
func GetContainerVpcClusterWorkerOutput(ctx *Context, args *GetContainerVpcClusterWorkerOutputArgs, opts ...InvokeOption) GetContainerVpcClusterWorkerResultOutput

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

    public static class GetContainerVpcClusterWorker 
{
    public static Task<GetContainerVpcClusterWorkerResult> InvokeAsync(GetContainerVpcClusterWorkerArgs args, InvokeOptions? opts = null)
    public static Output<GetContainerVpcClusterWorkerResult> Invoke(GetContainerVpcClusterWorkerInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetContainerVpcClusterWorkerResult> getContainerVpcClusterWorker(GetContainerVpcClusterWorkerArgs args, InvokeOptions options)
public static Output<GetContainerVpcClusterWorkerResult> getContainerVpcClusterWorker(GetContainerVpcClusterWorkerArgs args, InvokeOptions options)

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

    The following arguments are supported:

    ClusterNameId string
    The name or ID of the cluster that the worker node belongs to.
    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>.
    Id string
    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.
    ClusterNameId string
    The name or ID of the cluster that the worker node belongs to.
    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>.
    Id string
    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.
    clusterNameId String
    The name or ID of the cluster that the worker node belongs to.
    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>.
    id String
    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.
    clusterNameId string
    The name or ID of the cluster that the worker node belongs to.
    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>.
    id string
    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.
    cluster_name_id str
    The name or ID of the cluster that the worker node belongs to.
    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>.
    id str
    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.
    clusterNameId String
    The name or ID of the cluster that the worker node belongs to.
    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>.
    id String
    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.

    getContainerVpcClusterWorker Result

    The following output properties are available:

    ClusterNameId string
    Flavor string
    HostPoolId string
    (String) The ID of the dedicated host pool the worker is associated with.
    Id string
    KubeVersion string
    NetworkInterfaces List<GetContainerVpcClusterWorkerNetworkInterface>
    (String) The network interface of the cluster.
    PoolId string
    (String) The ID of the worker pool that the worker node belongs to.
    PoolName string
    (String) The name of the worker pool that the worker node belongs to.
    ResourceControllerUrl string
    State string
    (String) The state of the worker node.
    WorkerId string
    ResourceGroupId string
    ClusterNameId string
    Flavor string
    HostPoolId string
    (String) The ID of the dedicated host pool the worker is associated with.
    Id string
    KubeVersion string
    NetworkInterfaces []GetContainerVpcClusterWorkerNetworkInterface
    (String) The network interface of the cluster.
    PoolId string
    (String) The ID of the worker pool that the worker node belongs to.
    PoolName string
    (String) The name of the worker pool that the worker node belongs to.
    ResourceControllerUrl string
    State string
    (String) The state of the worker node.
    WorkerId string
    ResourceGroupId string
    clusterNameId String
    flavor String
    hostPoolId String
    (String) The ID of the dedicated host pool the worker is associated with.
    id String
    kubeVersion String
    networkInterfaces List<GetContainerVpcClusterWorkerNetworkInterface>
    (String) The network interface of the cluster.
    poolId String
    (String) The ID of the worker pool that the worker node belongs to.
    poolName String
    (String) The name of the worker pool that the worker node belongs to.
    resourceControllerUrl String
    state String
    (String) The state of the worker node.
    workerId String
    resourceGroupId String
    clusterNameId string
    flavor string
    hostPoolId string
    (String) The ID of the dedicated host pool the worker is associated with.
    id string
    kubeVersion string
    networkInterfaces GetContainerVpcClusterWorkerNetworkInterface[]
    (String) The network interface of the cluster.
    poolId string
    (String) The ID of the worker pool that the worker node belongs to.
    poolName string
    (String) The name of the worker pool that the worker node belongs to.
    resourceControllerUrl string
    state string
    (String) The state of the worker node.
    workerId string
    resourceGroupId string
    cluster_name_id str
    flavor str
    host_pool_id str
    (String) The ID of the dedicated host pool the worker is associated with.
    id str
    kube_version str
    network_interfaces Sequence[GetContainerVpcClusterWorkerNetworkInterface]
    (String) The network interface of the cluster.
    pool_id str
    (String) The ID of the worker pool that the worker node belongs to.
    pool_name str
    (String) The name of the worker pool that the worker node belongs to.
    resource_controller_url str
    state str
    (String) The state of the worker node.
    worker_id str
    resource_group_id str
    clusterNameId String
    flavor String
    hostPoolId String
    (String) The ID of the dedicated host pool the worker is associated with.
    id String
    kubeVersion String
    networkInterfaces List<Property Map>
    (String) The network interface of the cluster.
    poolId String
    (String) The ID of the worker pool that the worker node belongs to.
    poolName String
    (String) The name of the worker pool that the worker node belongs to.
    resourceControllerUrl String
    state String
    (String) The state of the worker node.
    workerId String
    resourceGroupId String

    Supporting Types

    GetContainerVpcClusterWorkerNetworkInterface

    Cidr string
    (String) The CIDR of the network.
    IpAddress string
    (String) The IP address of the worker pool that the worker node belongs to.
    SubnetId string
    (String) The ID of the worker pool subnet that the worker node is attached to.
    Cidr string
    (String) The CIDR of the network.
    IpAddress string
    (String) The IP address of the worker pool that the worker node belongs to.
    SubnetId string
    (String) The ID of the worker pool subnet that the worker node is attached to.
    cidr String
    (String) The CIDR of the network.
    ipAddress String
    (String) The IP address of the worker pool that the worker node belongs to.
    subnetId String
    (String) The ID of the worker pool subnet that the worker node is attached to.
    cidr string
    (String) The CIDR of the network.
    ipAddress string
    (String) The IP address of the worker pool that the worker node belongs to.
    subnetId string
    (String) The ID of the worker pool subnet that the worker node is attached to.
    cidr str
    (String) The CIDR of the network.
    ip_address str
    (String) The IP address of the worker pool that the worker node belongs to.
    subnet_id str
    (String) The ID of the worker pool subnet that the worker node is attached to.
    cidr String
    (String) The CIDR of the network.
    ipAddress String
    (String) The IP address of the worker pool that the worker node belongs to.
    subnetId String
    (String) The ID of the worker pool subnet that the worker node is attached to.

    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