Nutanix v0.8.0, May 11 25

Nutanix v0.8.0 published on Sunday, May 11, 2025 by Piers Karsenbarg

nutanix.getPcsV2

Explore with Pulumi AI

Nutanix v0.8.0 published on Sunday, May 11, 2025 by Piers Karsenbarg

Example Usage

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

const pcs = nutanix.getPcsV2({});
const pcs_select = nutanix.getPcsV2({
    select: "config,extId",
});

import pulumi
import pulumi_nutanix as nutanix

pcs = nutanix.get_pcs_v2()
pcs_select = nutanix.get_pcs_v2(select="config,extId")

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := nutanix.GetPcsV2(ctx, &nutanix.GetPcsV2Args{}, nil)
		if err != nil {
			return err
		}
		_, err = nutanix.GetPcsV2(ctx, &nutanix.GetPcsV2Args{
			Select: pulumi.StringRef("config,extId"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var pcs = Nutanix.GetPcsV2.Invoke();

    var pcs_select = Nutanix.GetPcsV2.Invoke(new()
    {
        Select = "config,extId",
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.nutanix.NutanixFunctions;
import com.pulumi.nutanix.inputs.GetPcsV2Args;
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 pcs = NutanixFunctions.getPcsV2(GetPcsV2Args.builder()
            .build());

        final var pcs-select = NutanixFunctions.getPcsV2(GetPcsV2Args.builder()
            .select("config,extId")
            .build());

    }
}

variables:
  pcs:
    fn::invoke:
      function: nutanix:getPcsV2
      arguments: {}
  pcs-select:
    fn::invoke:
      function: nutanix:getPcsV2
      arguments:
        select: config,extId

PCS

The pcs argument supports the following:

tenant_id: - A globally unique identifier that represents the tenant that owns this entity. The system automatically assigns it, and it and is immutable from an API consumer perspective (some use cases may cause this Id to change - For instance, a use case may require the transfer of ownership of the entity, but these cases are handled automatically on the server).
ext_id: - A globally unique identifier of an instance that is suitable for external consumption.
links: - A HATEOAS style link for the response. Each link contains a user-friendly name identifying the link and an address for retrieving the particular resource.
config: - Domain manager (Prism Central) cluster configuration details.
is_registered_with_hosting_cluster: - Boolean value indicating if the domain manager (Prism Central) is registered with the hosting cluster, that is, Prism Element.
network: - Domain manager (Prism Central) network configuration details.
hosting_cluster_ext_id: - The external identifier of the cluster hosting the domain manager (Prism Central) instance.
should_enable_high_availability: - This configuration enables Prism Central to be deployed in scale-out mode.
node_ext_ids: - Domain manager (Prism Central) nodes external identifier.

Config

The config argument supports the following:

should_enable_lockdown_mode: - A boolean value indicating whether to enable lockdown mode for a cluster.
build_info: -Currently representing the build information to be used for the cluster creation.
name: - Name of the domain manager (Prism Central).
size: - Domain manager (Prism Central) size is an enumeration of starter, small, large, or extra large starter values. possible values are:
- SMALL : Domain manager (Prism Central) of size small.
- LARGE : Domain manager (Prism Central) of size large.
- EXTRALARGE : Domain manager (Prism Central) of size extra large.
- STARTER : Domain manager (Prism Central) of size starter.
bootstrap_config: - Bootstrap configuration details for the domain manager (Prism Central).
resource_config: - This configuration is used to provide the resource-related details like container external identifiers, number of VCPUs, memory size, data disk size of the domain manager (Prism Central). In the case of a multi-node setup, the sum of resources like number of VCPUs, memory size and data disk size are provided.

Build Info

The build_info argument supports the following:

version: - Software version.

Bootstrap Config

The bootstrap_config argument supports the following:

environment_info: - Environment information for the domain manager (Prism Central) cluster.

Environment Info

The environment_info argument supports the following:

type: - Enums denoting the environment type of the PC, that is, on-prem PC or cloud PC. Following are the supported entity types:
- ONPREM : On-prem environment.
- NTNX_CLOUD : Nutanix cloud environment.
provider_type: - Enums denoting the provider type of the PC, that is, AHV or ESXi. Following are the supported provider types:
- VSPHERE : Vsphere cloud provider.
- AZURE : Azure cloud provider.
- NTNX : Nutanix cloud provider.
- GCP : GCP cloud provider.
- AWS : AWS cloud provider.
provisioning_type: - Enums denoting the instance type of the cloud PC. It indicates whether the PC is created on bare-metal or on a cloud-provisioned VM. Hence, it supports two possible values:
- NTNX : Nutanix instance.
- NATIVE : Native instance.

Resource Config

The resource_config argument supports the following:

num_vcpus: - This property is used for readOnly purposes to display Prism Central number of VCPUs allocation.
memory_size_bytes: - This property is used for readOnly purposes to display Prism Central RAM allocation at the cluster level.
data_disk_size_bytes: - This property is used for readOnly purposes to display Prism Central data disk size allocation at a cluster level.
container_ext_ids: - The external identifier of the container that will be used to create the domain manager (Prism Central) cluster.

Network

the network argument supports the following:

external_address: - An unique address that identifies a device on the internet or a local network in IPv4 or IPv6 format.
name_servers: - List of name servers on a cluster. This is part of payload for both cluster create & update operations. For create operation, only ipv4 address / fqdn values are supported currently.
ntp_servers: - List of NTP servers on a cluster. This is part of payload for both cluster create & update operations. For create operation, only ipv4 address / fqdn values are supported currently.
fqdn: - Cluster fully qualified domain name. This is part of payload for cluster update operation only.
external_networks: - This configuration is used to manage Prism Central.

External Address

The external_address argument supports the following:

ipv4: - An unique address that identifies a device on the internet or a local network in IPv4 format.
ipv6: - An unique address that identifies a device on the internet or a local network in IPv6 format.

Name Servers, NTP Servers

The name_servers and ntp_servers arguments support the following:

ipv4: - An unique address that identifies a device on the internet or a local network in IPv4 format.
ipv6: - An unique address that identifies a device on the internet or a local network in IPv6 format.
fqdn: - A fully qualified domain name that specifies its exact location in the tree hierarchy of the Domain Name System.

External Networks

The external_networks argument supports the following:

default_gateway: - An unique address that identifies a device on the internet or a local network in IPv4/IPv6 format or a Fully Qualified Domain Name.
subnet_mask: - An unique address that identifies a device on the internet or a local network in IPv4/IPv6 format or a Fully Qualified Domain Name.
ip_ranges: - Range of IPs used for Prism Central network setup.
network_ext_id: - The network external identifier to which Domain Manager (Prism Central) is to be deployed or is already configured.

Default Gateway, Subnet Mask

The default_gatewayand subnet_mask arguments support the following:

ipv4: - An unique address that identifies a device on the internet or a local network in IPv4 format.
ipv6: - An unique address that identifies a device on the internet or a local network in IPv6 format.
fqdn: - A fully qualified domain name that specifies its exact location in the tree hierarchy of the Domain Name System.

IP Ranges

The ip_ranges argument supports the following:

begin: - The beginning IP address of the range.
end: - The ending IP address of the range.

begin, end

The begin and end arguments support the following:

ipv4: - An unique address that identifies a device on the internet or a local network in IPv4 format.
ipv6: - An unique address that identifies a device on the internet or a local network in IPv6 format.

IpV4, IpV6

The ipv4 and ipv6 arguments support the following:

value: - The IPv4/IPv6 address of the host.
prefix_length: - The prefix length of the network to which this host IPv4/IPv6 address belongs.

FQDN

The fqdn argument supports the following:

value: - The fully qualified domain name of the host.

See detailed information in Nutanix List PCs V4.

Using getPcsV2

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 getPcsV2(args: GetPcsV2Args, opts?: InvokeOptions): Promise<GetPcsV2Result>
function getPcsV2Output(args: GetPcsV2OutputArgs, opts?: InvokeOptions): Output<GetPcsV2Result>

def get_pcs_v2(select: Optional[str] = None,
               opts: Optional[InvokeOptions] = None) -> GetPcsV2Result
def get_pcs_v2_output(select: Optional[pulumi.Input[str]] = None,
               opts: Optional[InvokeOptions] = None) -> Output[GetPcsV2Result]

func GetPcsV2(ctx *Context, args *GetPcsV2Args, opts ...InvokeOption) (*GetPcsV2Result, error)
func GetPcsV2Output(ctx *Context, args *GetPcsV2OutputArgs, opts ...InvokeOption) GetPcsV2ResultOutput

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

public static class GetPcsV2 
{
    public static Task<GetPcsV2Result> InvokeAsync(GetPcsV2Args args, InvokeOptions? opts = null)
    public static Output<GetPcsV2Result> Invoke(GetPcsV2InvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetPcsV2Result> getPcsV2(GetPcsV2Args args, InvokeOptions options)
public static Output<GetPcsV2Result> getPcsV2(GetPcsV2Args args, InvokeOptions options)

fn::invoke:
  function: nutanix:index/getPcsV2:getPcsV2
  arguments:
    # arguments dictionary

The following arguments are supported:

Select string

URL query parameter that allows clients to request a specific set of properties for each entity or complex type. Expression specified with the $select must conform to the OData V4.01 URL conventions. If a $select expression consists of a single select item that is an asterisk (i.e., *), then all properties on the matching resource will be returned. supported values are:

Select string

URL query parameter that allows clients to request a specific set of properties for each entity or complex type. Expression specified with the $select must conform to the OData V4.01 URL conventions. If a $select expression consists of a single select item that is an asterisk (i.e., *), then all properties on the matching resource will be returned. supported values are:

select String

URL query parameter that allows clients to request a specific set of properties for each entity or complex type. Expression specified with the $select must conform to the OData V4.01 URL conventions. If a $select expression consists of a single select item that is an asterisk (i.e., *), then all properties on the matching resource will be returned. supported values are:

select string

URL query parameter that allows clients to request a specific set of properties for each entity or complex type. Expression specified with the $select must conform to the OData V4.01 URL conventions. If a $select expression consists of a single select item that is an asterisk (i.e., *), then all properties on the matching resource will be returned. supported values are:

select str

URL query parameter that allows clients to request a specific set of properties for each entity or complex type. Expression specified with the $select must conform to the OData V4.01 URL conventions. If a $select expression consists of a single select item that is an asterisk (i.e., *), then all properties on the matching resource will be returned. supported values are:

select String

URL query parameter that allows clients to request a specific set of properties for each entity or complex type. Expression specified with the $select must conform to the OData V4.01 URL conventions. If a $select expression consists of a single select item that is an asterisk (i.e., *), then all properties on the matching resource will be returned. supported values are: