1. Packages
  2. Ibm Provider
  3. API Docs
  4. getContainerDedicatedHostPool
ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud

ibm.getContainerDedicatedHostPool

Explore with Pulumi AI

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

    Retrieve information about a dedicated host pool. For more information, about dedicated host pool, see Creating and managing dedicated hosts on VPC Gen 2 infrastructure.

    Example Usage

    In the following example, you can retrieve a dedicated host pool:

    import * as pulumi from "@pulumi/pulumi";
    import * as ibm from "@pulumi/ibm";
    
    const testDhostpool = ibm.getContainerDedicatedHostPool({
        hostPoolId: "dh-abcdefgh1234567",
    });
    
    import pulumi
    import pulumi_ibm as ibm
    
    test_dhostpool = ibm.get_container_dedicated_host_pool(host_pool_id="dh-abcdefgh1234567")
    
    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.LookupContainerDedicatedHostPool(ctx, &ibm.LookupContainerDedicatedHostPoolArgs{
    			HostPoolId: "dh-abcdefgh1234567",
    		}, 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 testDhostpool = Ibm.GetContainerDedicatedHostPool.Invoke(new()
        {
            HostPoolId = "dh-abcdefgh1234567",
        });
    
    });
    
    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.GetContainerDedicatedHostPoolArgs;
    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 testDhostpool = IbmFunctions.getContainerDedicatedHostPool(GetContainerDedicatedHostPoolArgs.builder()
                .hostPoolId("dh-abcdefgh1234567")
                .build());
    
        }
    }
    
    variables:
      testDhostpool:
        fn::invoke:
          function: ibm:getContainerDedicatedHostPool
          arguments:
            hostPoolId: dh-abcdefgh1234567
    

    Using getContainerDedicatedHostPool

    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 getContainerDedicatedHostPool(args: GetContainerDedicatedHostPoolArgs, opts?: InvokeOptions): Promise<GetContainerDedicatedHostPoolResult>
    function getContainerDedicatedHostPoolOutput(args: GetContainerDedicatedHostPoolOutputArgs, opts?: InvokeOptions): Output<GetContainerDedicatedHostPoolResult>
    def get_container_dedicated_host_pool(host_pool_id: Optional[str] = None,
                                          id: Optional[str] = None,
                                          opts: Optional[InvokeOptions] = None) -> GetContainerDedicatedHostPoolResult
    def get_container_dedicated_host_pool_output(host_pool_id: Optional[pulumi.Input[str]] = None,
                                          id: Optional[pulumi.Input[str]] = None,
                                          opts: Optional[InvokeOptions] = None) -> Output[GetContainerDedicatedHostPoolResult]
    func LookupContainerDedicatedHostPool(ctx *Context, args *LookupContainerDedicatedHostPoolArgs, opts ...InvokeOption) (*LookupContainerDedicatedHostPoolResult, error)
    func LookupContainerDedicatedHostPoolOutput(ctx *Context, args *LookupContainerDedicatedHostPoolOutputArgs, opts ...InvokeOption) LookupContainerDedicatedHostPoolResultOutput

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

    public static class GetContainerDedicatedHostPool 
    {
        public static Task<GetContainerDedicatedHostPoolResult> InvokeAsync(GetContainerDedicatedHostPoolArgs args, InvokeOptions? opts = null)
        public static Output<GetContainerDedicatedHostPoolResult> Invoke(GetContainerDedicatedHostPoolInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetContainerDedicatedHostPoolResult> getContainerDedicatedHostPool(GetContainerDedicatedHostPoolArgs args, InvokeOptions options)
    public static Output<GetContainerDedicatedHostPoolResult> getContainerDedicatedHostPool(GetContainerDedicatedHostPoolArgs args, InvokeOptions options)
    
    fn::invoke:
      function: ibm:index/getContainerDedicatedHostPool:getContainerDedicatedHostPool
      arguments:
        # arguments dictionary

    The following arguments are supported:

    HostPoolId string
    The unique identifier of the dedicated host pool.
    Id string
    HostPoolId string
    The unique identifier of the dedicated host pool.
    Id string
    hostPoolId String
    The unique identifier of the dedicated host pool.
    id String
    hostPoolId string
    The unique identifier of the dedicated host pool.
    id string
    host_pool_id str
    The unique identifier of the dedicated host pool.
    id str
    hostPoolId String
    The unique identifier of the dedicated host pool.
    id String

    getContainerDedicatedHostPool Result

    The following output properties are available:

    FlavorClass string
    (String) The flavor class of the dedicated host pool.
    HostCount double
    (Int) The count of the hosts under the zone.
    HostPoolId string
    Id string
    Metro string
    (String) The metro to create the dedicated host pool in.
    Name string
    (String) The name of the dedicated host pool.
    State string
    (String) The state of the dedicated host pool.
    WorkerPools List<GetContainerDedicatedHostPoolWorkerPool>
    (List) A nested block describes the worker pools of this dedicated host pool.
    Zones List<GetContainerDedicatedHostPoolZone>
    (List) A nested block describes the zones of this dedicated host pool.
    FlavorClass string
    (String) The flavor class of the dedicated host pool.
    HostCount float64
    (Int) The count of the hosts under the zone.
    HostPoolId string
    Id string
    Metro string
    (String) The metro to create the dedicated host pool in.
    Name string
    (String) The name of the dedicated host pool.
    State string
    (String) The state of the dedicated host pool.
    WorkerPools []GetContainerDedicatedHostPoolWorkerPool
    (List) A nested block describes the worker pools of this dedicated host pool.
    Zones []GetContainerDedicatedHostPoolZone
    (List) A nested block describes the zones of this dedicated host pool.
    flavorClass String
    (String) The flavor class of the dedicated host pool.
    hostCount Double
    (Int) The count of the hosts under the zone.
    hostPoolId String
    id String
    metro String
    (String) The metro to create the dedicated host pool in.
    name String
    (String) The name of the dedicated host pool.
    state String
    (String) The state of the dedicated host pool.
    workerPools List<GetContainerDedicatedHostPoolWorkerPool>
    (List) A nested block describes the worker pools of this dedicated host pool.
    zones List<GetContainerDedicatedHostPoolZone>
    (List) A nested block describes the zones of this dedicated host pool.
    flavorClass string
    (String) The flavor class of the dedicated host pool.
    hostCount number
    (Int) The count of the hosts under the zone.
    hostPoolId string
    id string
    metro string
    (String) The metro to create the dedicated host pool in.
    name string
    (String) The name of the dedicated host pool.
    state string
    (String) The state of the dedicated host pool.
    workerPools GetContainerDedicatedHostPoolWorkerPool[]
    (List) A nested block describes the worker pools of this dedicated host pool.
    zones GetContainerDedicatedHostPoolZone[]
    (List) A nested block describes the zones of this dedicated host pool.
    flavor_class str
    (String) The flavor class of the dedicated host pool.
    host_count float
    (Int) The count of the hosts under the zone.
    host_pool_id str
    id str
    metro str
    (String) The metro to create the dedicated host pool in.
    name str
    (String) The name of the dedicated host pool.
    state str
    (String) The state of the dedicated host pool.
    worker_pools Sequence[GetContainerDedicatedHostPoolWorkerPool]
    (List) A nested block describes the worker pools of this dedicated host pool.
    zones Sequence[GetContainerDedicatedHostPoolZone]
    (List) A nested block describes the zones of this dedicated host pool.
    flavorClass String
    (String) The flavor class of the dedicated host pool.
    hostCount Number
    (Int) The count of the hosts under the zone.
    hostPoolId String
    id String
    metro String
    (String) The metro to create the dedicated host pool in.
    name String
    (String) The name of the dedicated host pool.
    state String
    (String) The state of the dedicated host pool.
    workerPools List<Property Map>
    (List) A nested block describes the worker pools of this dedicated host pool.
    zones List<Property Map>
    (List) A nested block describes the zones of this dedicated host pool.

    Supporting Types

    GetContainerDedicatedHostPoolWorkerPool

    ClusterId string
    (String) The ID of the cluster.
    WorkerPoolId string
    (String) The unique identifier of the worker pool.
    ClusterId string
    (String) The ID of the cluster.
    WorkerPoolId string
    (String) The unique identifier of the worker pool.
    clusterId String
    (String) The ID of the cluster.
    workerPoolId String
    (String) The unique identifier of the worker pool.
    clusterId string
    (String) The ID of the cluster.
    workerPoolId string
    (String) The unique identifier of the worker pool.
    cluster_id str
    (String) The ID of the cluster.
    worker_pool_id str
    (String) The unique identifier of the worker pool.
    clusterId String
    (String) The ID of the cluster.
    workerPoolId String
    (String) The unique identifier of the worker pool.

    GetContainerDedicatedHostPoolZone

    Capacities List<GetContainerDedicatedHostPoolZoneCapacity>
    (Map) A nested block describes the capacity of the zone. Nested scheme for capacity:
    HostCount double
    (Int) The count of the hosts under the zone.
    Zone string
    (String) The name of the zone.
    Capacities []GetContainerDedicatedHostPoolZoneCapacity
    (Map) A nested block describes the capacity of the zone. Nested scheme for capacity:
    HostCount float64
    (Int) The count of the hosts under the zone.
    Zone string
    (String) The name of the zone.
    capacities List<GetContainerDedicatedHostPoolZoneCapacity>
    (Map) A nested block describes the capacity of the zone. Nested scheme for capacity:
    hostCount Double
    (Int) The count of the hosts under the zone.
    zone String
    (String) The name of the zone.
    capacities GetContainerDedicatedHostPoolZoneCapacity[]
    (Map) A nested block describes the capacity of the zone. Nested scheme for capacity:
    hostCount number
    (Int) The count of the hosts under the zone.
    zone string
    (String) The name of the zone.
    capacities Sequence[GetContainerDedicatedHostPoolZoneCapacity]
    (Map) A nested block describes the capacity of the zone. Nested scheme for capacity:
    host_count float
    (Int) The count of the hosts under the zone.
    zone str
    (String) The name of the zone.
    capacities List<Property Map>
    (Map) A nested block describes the capacity of the zone. Nested scheme for capacity:
    hostCount Number
    (Int) The count of the hosts under the zone.
    zone String
    (String) The name of the zone.

    GetContainerDedicatedHostPoolZoneCapacity

    MemoryBytes double
    (Int) Memory capacity of the zone.
    Vcpu double
    (Int) VCPU capacity of the zone.
    MemoryBytes float64
    (Int) Memory capacity of the zone.
    Vcpu float64
    (Int) VCPU capacity of the zone.
    memoryBytes Double
    (Int) Memory capacity of the zone.
    vcpu Double
    (Int) VCPU capacity of the zone.
    memoryBytes number
    (Int) Memory capacity of the zone.
    vcpu number
    (Int) VCPU capacity of the zone.
    memory_bytes float
    (Int) Memory capacity of the zone.
    vcpu float
    (Int) VCPU capacity of the zone.
    memoryBytes Number
    (Int) Memory capacity of the zone.
    vcpu Number
    (Int) VCPU capacity 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