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

ibm.getPiDhcps

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 all DHCP Servers. For more information, see getting started with IBM Power Systems Virtual Servers.

    Example Usage

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

const example = ibm.getPiDhcps({
    piCloudInstanceId: "<value of the cloud_instance_id>",
});

    import pulumi
import pulumi_ibm as ibm

example = ibm.get_pi_dhcps(pi_cloud_instance_id="<value of the cloud_instance_id>")

    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.GetPiDhcps(ctx, &ibm.GetPiDhcpsArgs{
			PiCloudInstanceId: "<value of the cloud_instance_id>",
		}, 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 example = Ibm.GetPiDhcps.Invoke(new()
    {
        PiCloudInstanceId = "<value of the cloud_instance_id>",
    });

});

    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.GetPiDhcpsArgs;
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 example = IbmFunctions.getPiDhcps(GetPiDhcpsArgs.builder()
            .piCloudInstanceId("<value of the cloud_instance_id>")
            .build());

    }
}

    variables:
  example:
    fn::invoke:
      function: ibm:getPiDhcps
      arguments:
        piCloudInstanceId: <value of the cloud_instance_id>

    Notes

    • Please find supported Regions for endpoints.
    • If a Power cloud instance is provisioned at lon04, The provider level attributes should be as follows:
      • region - lon
      • zone - lon04

    Example usage:

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

    import pulumi

    package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;

return await Deployment.RunAsync(() => 
{
});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
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) {
    }
}

    {}

    Using getPiDhcps

    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 getPiDhcps(args: GetPiDhcpsArgs, opts?: InvokeOptions): Promise<GetPiDhcpsResult>
function getPiDhcpsOutput(args: GetPiDhcpsOutputArgs, opts?: InvokeOptions): Output<GetPiDhcpsResult>
    def get_pi_dhcps(id: Optional[str] = None,
                 pi_cloud_instance_id: Optional[str] = None,
                 opts: Optional[InvokeOptions] = None) -> GetPiDhcpsResult
def get_pi_dhcps_output(id: Optional[pulumi.Input[str]] = None,
                 pi_cloud_instance_id: Optional[pulumi.Input[str]] = None,
                 opts: Optional[InvokeOptions] = None) -> Output[GetPiDhcpsResult]
    func GetPiDhcps(ctx *Context, args *GetPiDhcpsArgs, opts ...InvokeOption) (*GetPiDhcpsResult, error)
func GetPiDhcpsOutput(ctx *Context, args *GetPiDhcpsOutputArgs, opts ...InvokeOption) GetPiDhcpsResultOutput

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

    public static class GetPiDhcps 
{
    public static Task<GetPiDhcpsResult> InvokeAsync(GetPiDhcpsArgs args, InvokeOptions? opts = null)
    public static Output<GetPiDhcpsResult> Invoke(GetPiDhcpsInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetPiDhcpsResult> getPiDhcps(GetPiDhcpsArgs args, InvokeOptions options)
public static Output<GetPiDhcpsResult> getPiDhcps(GetPiDhcpsArgs args, InvokeOptions options)

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

    The following arguments are supported:

    PiCloudInstanceId string
    The GUID of the service instance associated with an account.
    Id string
    PiCloudInstanceId string
    The GUID of the service instance associated with an account.
    Id string
    piCloudInstanceId String
    The GUID of the service instance associated with an account.
    id String
    piCloudInstanceId string
    The GUID of the service instance associated with an account.
    id string
    pi_cloud_instance_id str
    The GUID of the service instance associated with an account.
    id str
    piCloudInstanceId String
    The GUID of the service instance associated with an account.
    id String

    getPiDhcps Result

    The following output properties are available:

    Id string
    PiCloudInstanceId string
    Servers List<GetPiDhcpsServer>
    (List) List of all the DHCP Servers.
    Id string
    PiCloudInstanceId string
    Servers []GetPiDhcpsServer
    (List) List of all the DHCP Servers.
    id String
    piCloudInstanceId String
    servers List<GetPiDhcpsServer>
    (List) List of all the DHCP Servers.
    id string
    piCloudInstanceId string
    servers GetPiDhcpsServer[]
    (List) List of all the DHCP Servers.
    id str
    pi_cloud_instance_id str
    servers Sequence[GetPiDhcpsServer]
    (List) List of all the DHCP Servers.
    id String
    piCloudInstanceId String
    servers List<Property Map>
    (List) List of all the DHCP Servers.

    Supporting Types

    GetPiDhcpsServer

    DhcpId string
    (String) ID of the DHCP Server.
    NetworkId string
    (String) ID of the DHCP Server private network.
    NetworkName string
    (String) Name of the DHCP Server private network.
    Status string
    (String) Status of the DHCP Server.
    DhcpId string
    (String) ID of the DHCP Server.
    NetworkId string
    (String) ID of the DHCP Server private network.
    NetworkName string
    (String) Name of the DHCP Server private network.
    Status string
    (String) Status of the DHCP Server.
    dhcpId String
    (String) ID of the DHCP Server.
    networkId String
    (String) ID of the DHCP Server private network.
    networkName String
    (String) Name of the DHCP Server private network.
    status String
    (String) Status of the DHCP Server.
    dhcpId string
    (String) ID of the DHCP Server.
    networkId string
    (String) ID of the DHCP Server private network.
    networkName string
    (String) Name of the DHCP Server private network.
    status string
    (String) Status of the DHCP Server.
    dhcp_id str
    (String) ID of the DHCP Server.
    network_id str
    (String) ID of the DHCP Server private network.
    network_name str
    (String) Name of the DHCP Server private network.
    status str
    (String) Status of the DHCP Server.
    dhcpId String
    (String) ID of the DHCP Server.
    networkId String
    (String) ID of the DHCP Server private network.
    networkName String
    (String) Name of the DHCP Server private network.
    status String
    (String) Status of the DHCP Server.

    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