Nutanix v0.7.4 published on Friday, Mar 21, 2025 by Piers Karsenbarg
nutanix.getClusters
Explore with Pulumi AI
Describes Clusters
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as nutanix from "@pulumi/nutanix";
const clusters = nutanix.getClusters({});
import pulumi
import pulumi_nutanix as nutanix
clusters = nutanix.get_clusters()
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.GetClusters(ctx, map[string]interface{}{}, 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 clusters = Nutanix.GetClusters.Invoke();
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.nutanix.NutanixFunctions;
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 clusters = NutanixFunctions.getClusters();
    }
}
variables:
  clusters:
    fn::invoke:
      function: nutanix:getClusters
      arguments: {}
Reference
The project_reference, owner_reference, availability_zone_reference, cluster_reference, attributes supports the following:
- kind: - The kind name (Default value: project).
- name: - the name.
- UUID: - the UUID.
Version
The version attribute supports the following:
- product_name: - Name of the producer/distribution of the image. For example windows or red hat.
- product_version: - Version string for the disk image.
See detailed information in Nutanix Clusters.
Using getClusters
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 getClusters(opts?: InvokeOptions): Promise<GetClustersResult>
function getClustersOutput(opts?: InvokeOptions): Output<GetClustersResult>def get_clusters(opts: Optional[InvokeOptions] = None) -> GetClustersResult
def get_clusters_output(opts: Optional[InvokeOptions] = None) -> Output[GetClustersResult]func GetClusters(ctx *Context, opts ...InvokeOption) (*GetClustersResult, error)
func GetClustersOutput(ctx *Context, opts ...InvokeOption) GetClustersResultOutput> Note: This function is named GetClusters in the Go SDK.
public static class GetClusters 
{
    public static Task<GetClustersResult> InvokeAsync(InvokeOptions? opts = null)
    public static Output<GetClustersResult> Invoke(InvokeOptions? opts = null)
}public static CompletableFuture<GetClustersResult> getClusters(InvokeOptions options)
public static Output<GetClustersResult> getClusters(InvokeOptions options)
fn::invoke:
  function: nutanix:index/getClusters:getClusters
  arguments:
    # arguments dictionarygetClusters Result
The following output properties are available:
- ApiVersion string
- The API version.
- Entities
List<PiersKarsenbarg. Nutanix. Outputs. Get Clusters Entity> 
- List of Clusters
- Id string
- The provider-assigned unique ID for this managed resource.
- ApiVersion string
- The API version.
- Entities
[]GetClusters Entity 
- List of Clusters
- Id string
- The provider-assigned unique ID for this managed resource.
- apiVersion String
- The API version.
- entities
List<GetClusters Entity> 
- List of Clusters
- id String
- The provider-assigned unique ID for this managed resource.
- apiVersion string
- The API version.
- entities
GetClusters Entity[] 
- List of Clusters
- id string
- The provider-assigned unique ID for this managed resource.
- api_version str
- The API version.
- entities
Sequence[GetClusters Entity] 
- List of Clusters
- id str
- The provider-assigned unique ID for this managed resource.
- apiVersion String
- The API version.
- entities List<Property Map>
- List of Clusters
- id String
- The provider-assigned unique ID for this managed resource.
Supporting Types
GetClustersEntity  
- AnalysisVm Dictionary<string, string>Efficiency Map 
- Map of cluster efficiency which includes numbers of inefficient vms. The value is populated by analytics on PC. (Readonly)
 
- ApiVersion string
- The API version.
- 
List<PiersKarsenbarg. Nutanix. Inputs. Get Clusters Entity Authorized Public Key List> 
- Build Dictionary<string, string>
- Cluster build details.
 
- CaCertificate List<PiersLists Karsenbarg. Nutanix. Inputs. Get Clusters Entity Ca Certificate List> 
- Zone name used in value of TZ environment variable.
 
- Categories
List<PiersKarsenbarg. Nutanix. Inputs. Get Clusters Entity Category> 
- Categories for the image.
 
- CertificationSigning Dictionary<string, string>Info 
- Customer information used in Certificate Signing Request for creating digital certificates.
 
- ClientAuth Dictionary<string, string>
- Client authentication config.
 
- ClusterArch string
- Cluster architecture. (Readonly, Options: Options : X86_64 , PPC64LE)
 
- DomainServer Dictionary<string, string>Credentials 
- Cluster domain credentials.
 
- DomainServer stringName 
- Joined domain name. In 'put' request, empty name will unjoin the cluster from current domain.
 
- DomainServer stringNameserver 
- The IP of the nameserver that can resolve the domain name. Must set when joining the domain.
 
- EnabledFeature List<string>Lists 
- Array of enabled features.
 
- EncryptionStatus string
- Cluster encryption status.
 
- ExternalData stringServices Ip 
- The cluster IP address that provides external entities access to various cluster data services.
 
- ExternalIp string
- The local IP of cluster visible externally.
 
- ExternalSubnet string
- External subnet for cross server communication. The format is IP/netmask. (default 172.16.0.0/255.240.0.0)
 
- GpuDriver stringVersion 
- GPU driver version.
 
- HttpProxy List<PiersLists Karsenbarg. Nutanix. Inputs. Get Clusters Entity Http Proxy List> 
- List of proxies to connect to the service centers.
 
- HttpProxy List<PiersWhitelists Karsenbarg. Nutanix. Inputs. Get Clusters Entity Http Proxy Whitelist> 
- HTTP proxy whitelist.
 
- InternalSubnet string
- The internal subnet is local to every server - its not visible outside.iSCSI requests generated internally within the appliance (by user VMs or VMFS) are sent to the internal subnet. The format is IP/netmask.
 
- IsAvailable bool
- Indicates if cluster is available to contact. (Readonly)
 
- ManagementServer List<PiersLists Karsenbarg. Nutanix. Inputs. Get Clusters Entity Management Server List> 
- List of cluster management servers. (Readonly)
 
- MasqueradingIp string
- The cluster NAT'd or proxy IP which maps to the cluster local IP.
 
- MasqueradingPort int
- Port used together with masquerading_ip to connect to the cluster.
 
- Metadata Dictionary<string, string>
- The image kind metadata.
 
- Name string
- The name for the image.
 
- NameServer List<string>Ip Lists 
- The list of IP addresses of the name servers.
 
- NfsSubnet List<string>Whitelists 
- Comma separated list of subnets (of the form 'a.b.c.d/l.m.n.o') that are allowed to send NFS requests to this container. If not specified, the global NFS whitelist will be looked up for access permission. The internal subnet is always automatically considered part of the whitelist, even if the field below does not explicitly specify it. Similarly, all the hypervisor IPs are considered part of the whitelist. Finally, to permit debugging, all of the SVMs local IPs are considered to be implicitly part of the whitelist.
 
- Nodes
List<PiersKarsenbarg. Nutanix. Inputs. Get Clusters Entity Node> 
- NtpServer List<string>Ip Lists 
- The list of IP addresses or FQDNs of the NTP servers.
 
- OperationMode string
- Cluster operation mode. - 'NORMAL': Cluster is operating normally. - 'READ_ONLY': Cluster is operating in read only mode. - 'STAND_ALONE': Only one node is operational in the cluster. This is valid only for single node or two node clusters. - 'SWITCH_TO_TWO_NODE': Cluster is moving from single node to two node cluster. - 'OVERRIDE': Valid only for single node cluster. If the user wants to run vms on a single node cluster in read only mode, he can set the cluster peration mode to override. Writes will be allowed in override mode.
 
- OwnerReference Dictionary<string, string>
- The reference to a user.
 
- ProjectReference Dictionary<string, string>
- The reference to a project.
 
- ServiceLists List<string>
- Array of enabled cluster services. For example, a cluster can function as both AOS and cloud data gateway. - 'AOS': Regular Prism Element - 'PRISM_CENTRAL': Prism Central - 'CLOUD_DATA_GATEWAY': Cloud backup and DR gateway - 'AFS': Cluster for file server - 'WITNESS' : Witness cluster - 'XI_PORTAL': Xi cluster.
 
- SmtpServer Dictionary<string, string>Address 
- SMTP Server Address.
 
- SmtpServer Dictionary<string, string>Credentials 
- SMTP Server Credentials.
 
- SmtpServer stringEmail Address 
- SMTP Server Email Address.
 
- SmtpServer List<string>Proxy Type Lists 
- SMTP Server Proxy Type List
 
- SmtpServer stringType 
- SMTP Server type.
 
- SoftwareMap Dictionary<string, string>Ncc 
- Map of software on the cluster with software type as the key.
 
- SoftwareMap Dictionary<string, string>Nos 
- Map of software on the cluster with software type as the key.
 
- SslKey stringExpire Datetime 
- UTC date and time in RFC-3339 format when the key expires
 
- SslKey stringName 
- SslKey Dictionary<string, string>Signing Info 
- Customer information used in Certificate Signing Request for creating digital certificates.
 
- SslKey stringType 
- SSL key type. Key types with RSA_2048, ECDSA_256 and ECDSA_384 are supported for key generation and importing.
 
- State string
- The state of the cluster entity.
 
- SupportedInformation stringVerbosity 
- Verbosity level settings for populating support information. - 'Nothing': Send nothing - 'Basic': Send basic information - skip core dump and hypervisor stats information - 'BasicPlusCoreDump': Send basic and core dump information - 'All': Send all information (Default value: BASIC_PLUS_CORE_DUMP)
 
- Timezone string
- Zone name used in value of TZ environment variable.
 
- AnalysisVm map[string]stringEfficiency Map 
- Map of cluster efficiency which includes numbers of inefficient vms. The value is populated by analytics on PC. (Readonly)
 
- ApiVersion string
- The API version.
- 
[]GetClusters Entity Authorized Public Key List 
- Build map[string]string
- Cluster build details.
 
- CaCertificate []GetLists Clusters Entity Ca Certificate List 
- Zone name used in value of TZ environment variable.
 
- Categories
[]GetClusters Entity Category 
- Categories for the image.
 
- CertificationSigning map[string]stringInfo 
- Customer information used in Certificate Signing Request for creating digital certificates.
 
- ClientAuth map[string]string
- Client authentication config.
 
- ClusterArch string
- Cluster architecture. (Readonly, Options: Options : X86_64 , PPC64LE)
 
- DomainServer map[string]stringCredentials 
- Cluster domain credentials.
 
- DomainServer stringName 
- Joined domain name. In 'put' request, empty name will unjoin the cluster from current domain.
 
- DomainServer stringNameserver 
- The IP of the nameserver that can resolve the domain name. Must set when joining the domain.
 
- EnabledFeature []stringLists 
- Array of enabled features.
 
- EncryptionStatus string
- Cluster encryption status.
 
- ExternalData stringServices Ip 
- The cluster IP address that provides external entities access to various cluster data services.
 
- ExternalIp string
- The local IP of cluster visible externally.
 
- ExternalSubnet string
- External subnet for cross server communication. The format is IP/netmask. (default 172.16.0.0/255.240.0.0)
 
- GpuDriver stringVersion 
- GPU driver version.
 
- HttpProxy []GetLists Clusters Entity Http Proxy List 
- List of proxies to connect to the service centers.
 
- HttpProxy []GetWhitelists Clusters Entity Http Proxy Whitelist 
- HTTP proxy whitelist.
 
- InternalSubnet string
- The internal subnet is local to every server - its not visible outside.iSCSI requests generated internally within the appliance (by user VMs or VMFS) are sent to the internal subnet. The format is IP/netmask.
 
- IsAvailable bool
- Indicates if cluster is available to contact. (Readonly)
 
- ManagementServer []GetLists Clusters Entity Management Server List 
- List of cluster management servers. (Readonly)
 
- MasqueradingIp string
- The cluster NAT'd or proxy IP which maps to the cluster local IP.
 
- MasqueradingPort int
- Port used together with masquerading_ip to connect to the cluster.
 
- Metadata map[string]string
- The image kind metadata.
 
- Name string
- The name for the image.
 
- NameServer []stringIp Lists 
- The list of IP addresses of the name servers.
 
- NfsSubnet []stringWhitelists 
- Comma separated list of subnets (of the form 'a.b.c.d/l.m.n.o') that are allowed to send NFS requests to this container. If not specified, the global NFS whitelist will be looked up for access permission. The internal subnet is always automatically considered part of the whitelist, even if the field below does not explicitly specify it. Similarly, all the hypervisor IPs are considered part of the whitelist. Finally, to permit debugging, all of the SVMs local IPs are considered to be implicitly part of the whitelist.
 
- Nodes
[]GetClusters Entity Node 
- NtpServer []stringIp Lists 
- The list of IP addresses or FQDNs of the NTP servers.
 
- OperationMode string
- Cluster operation mode. - 'NORMAL': Cluster is operating normally. - 'READ_ONLY': Cluster is operating in read only mode. - 'STAND_ALONE': Only one node is operational in the cluster. This is valid only for single node or two node clusters. - 'SWITCH_TO_TWO_NODE': Cluster is moving from single node to two node cluster. - 'OVERRIDE': Valid only for single node cluster. If the user wants to run vms on a single node cluster in read only mode, he can set the cluster peration mode to override. Writes will be allowed in override mode.
 
- OwnerReference map[string]string
- The reference to a user.
 
- ProjectReference map[string]string
- The reference to a project.
 
- ServiceLists []string
- Array of enabled cluster services. For example, a cluster can function as both AOS and cloud data gateway. - 'AOS': Regular Prism Element - 'PRISM_CENTRAL': Prism Central - 'CLOUD_DATA_GATEWAY': Cloud backup and DR gateway - 'AFS': Cluster for file server - 'WITNESS' : Witness cluster - 'XI_PORTAL': Xi cluster.
 
- SmtpServer map[string]stringAddress 
- SMTP Server Address.
 
- SmtpServer map[string]stringCredentials 
- SMTP Server Credentials.
 
- SmtpServer stringEmail Address 
- SMTP Server Email Address.
 
- SmtpServer []stringProxy Type Lists 
- SMTP Server Proxy Type List
 
- SmtpServer stringType 
- SMTP Server type.
 
- SoftwareMap map[string]stringNcc 
- Map of software on the cluster with software type as the key.
 
- SoftwareMap map[string]stringNos 
- Map of software on the cluster with software type as the key.
 
- SslKey stringExpire Datetime 
- UTC date and time in RFC-3339 format when the key expires
 
- SslKey stringName 
- SslKey map[string]stringSigning Info 
- Customer information used in Certificate Signing Request for creating digital certificates.
 
- SslKey stringType 
- SSL key type. Key types with RSA_2048, ECDSA_256 and ECDSA_384 are supported for key generation and importing.
 
- State string
- The state of the cluster entity.
 
- SupportedInformation stringVerbosity 
- Verbosity level settings for populating support information. - 'Nothing': Send nothing - 'Basic': Send basic information - skip core dump and hypervisor stats information - 'BasicPlusCoreDump': Send basic and core dump information - 'All': Send all information (Default value: BASIC_PLUS_CORE_DUMP)
 
- Timezone string
- Zone name used in value of TZ environment variable.
 
- analysisVm Map<String,String>Efficiency Map 
- Map of cluster efficiency which includes numbers of inefficient vms. The value is populated by analytics on PC. (Readonly)
 
- apiVersion String
- The API version.
- 
List<GetClusters Entity Authorized Public Key List> 
- build Map<String,String>
- Cluster build details.
 
- caCertificate List<GetLists Clusters Entity Ca Certificate List> 
- Zone name used in value of TZ environment variable.
 
- categories
List<GetClusters Entity Category> 
- Categories for the image.
 
- certificationSigning Map<String,String>Info 
- Customer information used in Certificate Signing Request for creating digital certificates.
 
- clientAuth Map<String,String>
- Client authentication config.
 
- clusterArch String
- Cluster architecture. (Readonly, Options: Options : X86_64 , PPC64LE)
 
- domainServer Map<String,String>Credentials 
- Cluster domain credentials.
 
- domainServer StringName 
- Joined domain name. In 'put' request, empty name will unjoin the cluster from current domain.
 
- domainServer StringNameserver 
- The IP of the nameserver that can resolve the domain name. Must set when joining the domain.
 
- enabledFeature List<String>Lists 
- Array of enabled features.
 
- encryptionStatus String
- Cluster encryption status.
 
- externalData StringServices Ip 
- The cluster IP address that provides external entities access to various cluster data services.
 
- externalIp String
- The local IP of cluster visible externally.
 
- externalSubnet String
- External subnet for cross server communication. The format is IP/netmask. (default 172.16.0.0/255.240.0.0)
 
- gpuDriver StringVersion 
- GPU driver version.
 
- httpProxy List<GetLists Clusters Entity Http Proxy List> 
- List of proxies to connect to the service centers.
 
- httpProxy List<GetWhitelists Clusters Entity Http Proxy Whitelist> 
- HTTP proxy whitelist.
 
- internalSubnet String
- The internal subnet is local to every server - its not visible outside.iSCSI requests generated internally within the appliance (by user VMs or VMFS) are sent to the internal subnet. The format is IP/netmask.
 
- isAvailable Boolean
- Indicates if cluster is available to contact. (Readonly)
 
- managementServer List<GetLists Clusters Entity Management Server List> 
- List of cluster management servers. (Readonly)
 
- masqueradingIp String
- The cluster NAT'd or proxy IP which maps to the cluster local IP.
 
- masqueradingPort Integer
- Port used together with masquerading_ip to connect to the cluster.
 
- metadata Map<String,String>
- The image kind metadata.
 
- name String
- The name for the image.
 
- nameServer List<String>Ip Lists 
- The list of IP addresses of the name servers.
 
- nfsSubnet List<String>Whitelists 
- Comma separated list of subnets (of the form 'a.b.c.d/l.m.n.o') that are allowed to send NFS requests to this container. If not specified, the global NFS whitelist will be looked up for access permission. The internal subnet is always automatically considered part of the whitelist, even if the field below does not explicitly specify it. Similarly, all the hypervisor IPs are considered part of the whitelist. Finally, to permit debugging, all of the SVMs local IPs are considered to be implicitly part of the whitelist.
 
- nodes
List<GetClusters Entity Node> 
- ntpServer List<String>Ip Lists 
- The list of IP addresses or FQDNs of the NTP servers.
 
- operationMode String
- Cluster operation mode. - 'NORMAL': Cluster is operating normally. - 'READ_ONLY': Cluster is operating in read only mode. - 'STAND_ALONE': Only one node is operational in the cluster. This is valid only for single node or two node clusters. - 'SWITCH_TO_TWO_NODE': Cluster is moving from single node to two node cluster. - 'OVERRIDE': Valid only for single node cluster. If the user wants to run vms on a single node cluster in read only mode, he can set the cluster peration mode to override. Writes will be allowed in override mode.
 
- ownerReference Map<String,String>
- The reference to a user.
 
- projectReference Map<String,String>
- The reference to a project.
 
- serviceLists List<String>
- Array of enabled cluster services. For example, a cluster can function as both AOS and cloud data gateway. - 'AOS': Regular Prism Element - 'PRISM_CENTRAL': Prism Central - 'CLOUD_DATA_GATEWAY': Cloud backup and DR gateway - 'AFS': Cluster for file server - 'WITNESS' : Witness cluster - 'XI_PORTAL': Xi cluster.
 
- smtpServer Map<String,String>Address 
- SMTP Server Address.
 
- smtpServer Map<String,String>Credentials 
- SMTP Server Credentials.
 
- smtpServer StringEmail Address 
- SMTP Server Email Address.
 
- smtpServer List<String>Proxy Type Lists 
- SMTP Server Proxy Type List
 
- smtpServer StringType 
- SMTP Server type.
 
- softwareMap Map<String,String>Ncc 
- Map of software on the cluster with software type as the key.
 
- softwareMap Map<String,String>Nos 
- Map of software on the cluster with software type as the key.
 
- sslKey StringExpire Datetime 
- UTC date and time in RFC-3339 format when the key expires
 
- sslKey StringName 
- sslKey Map<String,String>Signing Info 
- Customer information used in Certificate Signing Request for creating digital certificates.
 
- sslKey StringType 
- SSL key type. Key types with RSA_2048, ECDSA_256 and ECDSA_384 are supported for key generation and importing.
 
- state String
- The state of the cluster entity.
 
- supportedInformation StringVerbosity 
- Verbosity level settings for populating support information. - 'Nothing': Send nothing - 'Basic': Send basic information - skip core dump and hypervisor stats information - 'BasicPlusCoreDump': Send basic and core dump information - 'All': Send all information (Default value: BASIC_PLUS_CORE_DUMP)
 
- timezone String
- Zone name used in value of TZ environment variable.
 
- analysisVm {[key: string]: string}Efficiency Map 
- Map of cluster efficiency which includes numbers of inefficient vms. The value is populated by analytics on PC. (Readonly)
 
- apiVersion string
- The API version.
- 
GetClusters Entity Authorized Public Key List[] 
- build {[key: string]: string}
- Cluster build details.
 
- caCertificate GetLists Clusters Entity Ca Certificate List[] 
- Zone name used in value of TZ environment variable.
 
- categories
GetClusters Entity Category[] 
- Categories for the image.
 
- certificationSigning {[key: string]: string}Info 
- Customer information used in Certificate Signing Request for creating digital certificates.
 
- clientAuth {[key: string]: string}
- Client authentication config.
 
- clusterArch string
- Cluster architecture. (Readonly, Options: Options : X86_64 , PPC64LE)
 
- domainServer {[key: string]: string}Credentials 
- Cluster domain credentials.
 
- domainServer stringName 
- Joined domain name. In 'put' request, empty name will unjoin the cluster from current domain.
 
- domainServer stringNameserver 
- The IP of the nameserver that can resolve the domain name. Must set when joining the domain.
 
- enabledFeature string[]Lists 
- Array of enabled features.
 
- encryptionStatus string
- Cluster encryption status.
 
- externalData stringServices Ip 
- The cluster IP address that provides external entities access to various cluster data services.
 
- externalIp string
- The local IP of cluster visible externally.
 
- externalSubnet string
- External subnet for cross server communication. The format is IP/netmask. (default 172.16.0.0/255.240.0.0)
 
- gpuDriver stringVersion 
- GPU driver version.
 
- httpProxy GetLists Clusters Entity Http Proxy List[] 
- List of proxies to connect to the service centers.
 
- httpProxy GetWhitelists Clusters Entity Http Proxy Whitelist[] 
- HTTP proxy whitelist.
 
- internalSubnet string
- The internal subnet is local to every server - its not visible outside.iSCSI requests generated internally within the appliance (by user VMs or VMFS) are sent to the internal subnet. The format is IP/netmask.
 
- isAvailable boolean
- Indicates if cluster is available to contact. (Readonly)
 
- managementServer GetLists Clusters Entity Management Server List[] 
- List of cluster management servers. (Readonly)
 
- masqueradingIp string
- The cluster NAT'd or proxy IP which maps to the cluster local IP.
 
- masqueradingPort number
- Port used together with masquerading_ip to connect to the cluster.
 
- metadata {[key: string]: string}
- The image kind metadata.
 
- name string
- The name for the image.
 
- nameServer string[]Ip Lists 
- The list of IP addresses of the name servers.
 
- nfsSubnet string[]Whitelists 
- Comma separated list of subnets (of the form 'a.b.c.d/l.m.n.o') that are allowed to send NFS requests to this container. If not specified, the global NFS whitelist will be looked up for access permission. The internal subnet is always automatically considered part of the whitelist, even if the field below does not explicitly specify it. Similarly, all the hypervisor IPs are considered part of the whitelist. Finally, to permit debugging, all of the SVMs local IPs are considered to be implicitly part of the whitelist.
 
- nodes
GetClusters Entity Node[] 
- ntpServer string[]Ip Lists 
- The list of IP addresses or FQDNs of the NTP servers.
 
- operationMode string
- Cluster operation mode. - 'NORMAL': Cluster is operating normally. - 'READ_ONLY': Cluster is operating in read only mode. - 'STAND_ALONE': Only one node is operational in the cluster. This is valid only for single node or two node clusters. - 'SWITCH_TO_TWO_NODE': Cluster is moving from single node to two node cluster. - 'OVERRIDE': Valid only for single node cluster. If the user wants to run vms on a single node cluster in read only mode, he can set the cluster peration mode to override. Writes will be allowed in override mode.
 
- ownerReference {[key: string]: string}
- The reference to a user.
 
- projectReference {[key: string]: string}
- The reference to a project.
 
- serviceLists string[]
- Array of enabled cluster services. For example, a cluster can function as both AOS and cloud data gateway. - 'AOS': Regular Prism Element - 'PRISM_CENTRAL': Prism Central - 'CLOUD_DATA_GATEWAY': Cloud backup and DR gateway - 'AFS': Cluster for file server - 'WITNESS' : Witness cluster - 'XI_PORTAL': Xi cluster.
 
- smtpServer {[key: string]: string}Address 
- SMTP Server Address.
 
- smtpServer {[key: string]: string}Credentials 
- SMTP Server Credentials.
 
- smtpServer stringEmail Address 
- SMTP Server Email Address.
 
- smtpServer string[]Proxy Type Lists 
- SMTP Server Proxy Type List
 
- smtpServer stringType 
- SMTP Server type.
 
- softwareMap {[key: string]: string}Ncc 
- Map of software on the cluster with software type as the key.
 
- softwareMap {[key: string]: string}Nos 
- Map of software on the cluster with software type as the key.
 
- sslKey stringExpire Datetime 
- UTC date and time in RFC-3339 format when the key expires
 
- sslKey stringName 
- sslKey {[key: string]: string}Signing Info 
- Customer information used in Certificate Signing Request for creating digital certificates.
 
- sslKey stringType 
- SSL key type. Key types with RSA_2048, ECDSA_256 and ECDSA_384 are supported for key generation and importing.
 
- state string
- The state of the cluster entity.
 
- supportedInformation stringVerbosity 
- Verbosity level settings for populating support information. - 'Nothing': Send nothing - 'Basic': Send basic information - skip core dump and hypervisor stats information - 'BasicPlusCoreDump': Send basic and core dump information - 'All': Send all information (Default value: BASIC_PLUS_CORE_DUMP)
 
- timezone string
- Zone name used in value of TZ environment variable.
 
- analysis_vm_ Mapping[str, str]efficiency_ map 
- Map of cluster efficiency which includes numbers of inefficient vms. The value is populated by analytics on PC. (Readonly)
 
- api_version str
- The API version.
- 
Sequence[GetClusters Entity Authorized Public Key List] 
- build Mapping[str, str]
- Cluster build details.
 
- ca_certificate_ Sequence[Getlists Clusters Entity Ca Certificate List] 
- Zone name used in value of TZ environment variable.
 
- categories
Sequence[GetClusters Entity Category] 
- Categories for the image.
 
- certification_signing_ Mapping[str, str]info 
- Customer information used in Certificate Signing Request for creating digital certificates.
 
- client_auth Mapping[str, str]
- Client authentication config.
 
- cluster_arch str
- Cluster architecture. (Readonly, Options: Options : X86_64 , PPC64LE)
 
- domain_server_ Mapping[str, str]credentials 
- Cluster domain credentials.
 
- domain_server_ strname 
- Joined domain name. In 'put' request, empty name will unjoin the cluster from current domain.
 
- domain_server_ strnameserver 
- The IP of the nameserver that can resolve the domain name. Must set when joining the domain.
 
- enabled_feature_ Sequence[str]lists 
- Array of enabled features.
 
- encryption_status str
- Cluster encryption status.
 
- external_data_ strservices_ ip 
- The cluster IP address that provides external entities access to various cluster data services.
 
- external_ip str
- The local IP of cluster visible externally.
 
- external_subnet str
- External subnet for cross server communication. The format is IP/netmask. (default 172.16.0.0/255.240.0.0)
 
- gpu_driver_ strversion 
- GPU driver version.
 
- http_proxy_ Sequence[Getlists Clusters Entity Http Proxy List] 
- List of proxies to connect to the service centers.
 
- http_proxy_ Sequence[Getwhitelists Clusters Entity Http Proxy Whitelist] 
- HTTP proxy whitelist.
 
- internal_subnet str
- The internal subnet is local to every server - its not visible outside.iSCSI requests generated internally within the appliance (by user VMs or VMFS) are sent to the internal subnet. The format is IP/netmask.
 
- is_available bool
- Indicates if cluster is available to contact. (Readonly)
 
- management_server_ Sequence[Getlists Clusters Entity Management Server List] 
- List of cluster management servers. (Readonly)
 
- masquerading_ip str
- The cluster NAT'd or proxy IP which maps to the cluster local IP.
 
- masquerading_port int
- Port used together with masquerading_ip to connect to the cluster.
 
- metadata Mapping[str, str]
- The image kind metadata.
 
- name str
- The name for the image.
 
- name_server_ Sequence[str]ip_ lists 
- The list of IP addresses of the name servers.
 
- nfs_subnet_ Sequence[str]whitelists 
- Comma separated list of subnets (of the form 'a.b.c.d/l.m.n.o') that are allowed to send NFS requests to this container. If not specified, the global NFS whitelist will be looked up for access permission. The internal subnet is always automatically considered part of the whitelist, even if the field below does not explicitly specify it. Similarly, all the hypervisor IPs are considered part of the whitelist. Finally, to permit debugging, all of the SVMs local IPs are considered to be implicitly part of the whitelist.
 
- nodes
Sequence[GetClusters Entity Node] 
- ntp_server_ Sequence[str]ip_ lists 
- The list of IP addresses or FQDNs of the NTP servers.
 
- operation_mode str
- Cluster operation mode. - 'NORMAL': Cluster is operating normally. - 'READ_ONLY': Cluster is operating in read only mode. - 'STAND_ALONE': Only one node is operational in the cluster. This is valid only for single node or two node clusters. - 'SWITCH_TO_TWO_NODE': Cluster is moving from single node to two node cluster. - 'OVERRIDE': Valid only for single node cluster. If the user wants to run vms on a single node cluster in read only mode, he can set the cluster peration mode to override. Writes will be allowed in override mode.
 
- owner_reference Mapping[str, str]
- The reference to a user.
 
- project_reference Mapping[str, str]
- The reference to a project.
 
- service_lists Sequence[str]
- Array of enabled cluster services. For example, a cluster can function as both AOS and cloud data gateway. - 'AOS': Regular Prism Element - 'PRISM_CENTRAL': Prism Central - 'CLOUD_DATA_GATEWAY': Cloud backup and DR gateway - 'AFS': Cluster for file server - 'WITNESS' : Witness cluster - 'XI_PORTAL': Xi cluster.
 
- smtp_server_ Mapping[str, str]address 
- SMTP Server Address.
 
- smtp_server_ Mapping[str, str]credentials 
- SMTP Server Credentials.
 
- smtp_server_ stremail_ address 
- SMTP Server Email Address.
 
- smtp_server_ Sequence[str]proxy_ type_ lists 
- SMTP Server Proxy Type List
 
- smtp_server_ strtype 
- SMTP Server type.
 
- software_map_ Mapping[str, str]ncc 
- Map of software on the cluster with software type as the key.
 
- software_map_ Mapping[str, str]nos 
- Map of software on the cluster with software type as the key.
 
- ssl_key_ strexpire_ datetime 
- UTC date and time in RFC-3339 format when the key expires
 
- ssl_key_ strname 
- ssl_key_ Mapping[str, str]signing_ info 
- Customer information used in Certificate Signing Request for creating digital certificates.
 
- ssl_key_ strtype 
- SSL key type. Key types with RSA_2048, ECDSA_256 and ECDSA_384 are supported for key generation and importing.
 
- state str
- The state of the cluster entity.
 
- supported_information_ strverbosity 
- Verbosity level settings for populating support information. - 'Nothing': Send nothing - 'Basic': Send basic information - skip core dump and hypervisor stats information - 'BasicPlusCoreDump': Send basic and core dump information - 'All': Send all information (Default value: BASIC_PLUS_CORE_DUMP)
 
- timezone str
- Zone name used in value of TZ environment variable.
 
- analysisVm Map<String>Efficiency Map 
- Map of cluster efficiency which includes numbers of inefficient vms. The value is populated by analytics on PC. (Readonly)
 
- apiVersion String
- The API version.
- List<Property Map>
- build Map<String>
- Cluster build details.
 
- caCertificate List<Property Map>Lists 
- Zone name used in value of TZ environment variable.
 
- categories List<Property Map>
- Categories for the image.
 
- certificationSigning Map<String>Info 
- Customer information used in Certificate Signing Request for creating digital certificates.
 
- clientAuth Map<String>
- Client authentication config.
 
- clusterArch String
- Cluster architecture. (Readonly, Options: Options : X86_64 , PPC64LE)
 
- domainServer Map<String>Credentials 
- Cluster domain credentials.
 
- domainServer StringName 
- Joined domain name. In 'put' request, empty name will unjoin the cluster from current domain.
 
- domainServer StringNameserver 
- The IP of the nameserver that can resolve the domain name. Must set when joining the domain.
 
- enabledFeature List<String>Lists 
- Array of enabled features.
 
- encryptionStatus String
- Cluster encryption status.
 
- externalData StringServices Ip 
- The cluster IP address that provides external entities access to various cluster data services.
 
- externalIp String
- The local IP of cluster visible externally.
 
- externalSubnet String
- External subnet for cross server communication. The format is IP/netmask. (default 172.16.0.0/255.240.0.0)
 
- gpuDriver StringVersion 
- GPU driver version.
 
- httpProxy List<Property Map>Lists 
- List of proxies to connect to the service centers.
 
- httpProxy List<Property Map>Whitelists 
- HTTP proxy whitelist.
 
- internalSubnet String
- The internal subnet is local to every server - its not visible outside.iSCSI requests generated internally within the appliance (by user VMs or VMFS) are sent to the internal subnet. The format is IP/netmask.
 
- isAvailable Boolean
- Indicates if cluster is available to contact. (Readonly)
 
- managementServer List<Property Map>Lists 
- List of cluster management servers. (Readonly)
 
- masqueradingIp String
- The cluster NAT'd or proxy IP which maps to the cluster local IP.
 
- masqueradingPort Number
- Port used together with masquerading_ip to connect to the cluster.
 
- metadata Map<String>
- The image kind metadata.
 
- name String
- The name for the image.
 
- nameServer List<String>Ip Lists 
- The list of IP addresses of the name servers.
 
- nfsSubnet List<String>Whitelists 
- Comma separated list of subnets (of the form 'a.b.c.d/l.m.n.o') that are allowed to send NFS requests to this container. If not specified, the global NFS whitelist will be looked up for access permission. The internal subnet is always automatically considered part of the whitelist, even if the field below does not explicitly specify it. Similarly, all the hypervisor IPs are considered part of the whitelist. Finally, to permit debugging, all of the SVMs local IPs are considered to be implicitly part of the whitelist.
 
- nodes List<Property Map>
- ntpServer List<String>Ip Lists 
- The list of IP addresses or FQDNs of the NTP servers.
 
- operationMode String
- Cluster operation mode. - 'NORMAL': Cluster is operating normally. - 'READ_ONLY': Cluster is operating in read only mode. - 'STAND_ALONE': Only one node is operational in the cluster. This is valid only for single node or two node clusters. - 'SWITCH_TO_TWO_NODE': Cluster is moving from single node to two node cluster. - 'OVERRIDE': Valid only for single node cluster. If the user wants to run vms on a single node cluster in read only mode, he can set the cluster peration mode to override. Writes will be allowed in override mode.
 
- ownerReference Map<String>
- The reference to a user.
 
- projectReference Map<String>
- The reference to a project.
 
- serviceLists List<String>
- Array of enabled cluster services. For example, a cluster can function as both AOS and cloud data gateway. - 'AOS': Regular Prism Element - 'PRISM_CENTRAL': Prism Central - 'CLOUD_DATA_GATEWAY': Cloud backup and DR gateway - 'AFS': Cluster for file server - 'WITNESS' : Witness cluster - 'XI_PORTAL': Xi cluster.
 
- smtpServer Map<String>Address 
- SMTP Server Address.
 
- smtpServer Map<String>Credentials 
- SMTP Server Credentials.
 
- smtpServer StringEmail Address 
- SMTP Server Email Address.
 
- smtpServer List<String>Proxy Type Lists 
- SMTP Server Proxy Type List
 
- smtpServer StringType 
- SMTP Server type.
 
- softwareMap Map<String>Ncc 
- Map of software on the cluster with software type as the key.
 
- softwareMap Map<String>Nos 
- Map of software on the cluster with software type as the key.
 
- sslKey StringExpire Datetime 
- UTC date and time in RFC-3339 format when the key expires
 
- sslKey StringName 
- sslKey Map<String>Signing Info 
- Customer information used in Certificate Signing Request for creating digital certificates.
 
- sslKey StringType 
- SSL key type. Key types with RSA_2048, ECDSA_256 and ECDSA_384 are supported for key generation and importing.
 
- state String
- The state of the cluster entity.
 
- supportedInformation StringVerbosity 
- Verbosity level settings for populating support information. - 'Nothing': Send nothing - 'Basic': Send basic information - skip core dump and hypervisor stats information - 'BasicPlusCoreDump': Send basic and core dump information - 'All': Send all information (Default value: BASIC_PLUS_CORE_DUMP)
 
- timezone String
- Zone name used in value of TZ environment variable.
 
GetClustersEntityAuthorizedPublicKeyList      
GetClustersEntityCaCertificateList     
- CaName string
- Certificate string
- CaName string
- Certificate string
- caName String
- certificate String
- caName string
- certificate string
- ca_name str
- certificate str
- caName String
- certificate String
GetClustersEntityCategory   
GetClustersEntityHttpProxyList     
- Address Dictionary<string, string>
- Credentials Dictionary<string, string>
- ProxyType List<string>Lists 
- Address map[string]string
- Credentials map[string]string
- ProxyType []stringLists 
- address Map<String,String>
- credentials Map<String,String>
- proxyType List<String>Lists 
- address {[key: string]: string}
- credentials {[key: string]: string}
- proxyType string[]Lists 
- address Mapping[str, str]
- credentials Mapping[str, str]
- proxy_type_ Sequence[str]lists 
- address Map<String>
- credentials Map<String>
- proxyType List<String>Lists 
GetClustersEntityHttpProxyWhitelist     
- Target string
- TargetType string
- Target string
- TargetType string
- target String
- targetType String
- target string
- targetType string
- target str
- target_type str
- target String
- targetType String
GetClustersEntityManagementServerList     
- DrsEnabled bool
- Ip string
- StatusLists List<string>
- Type string
- DrsEnabled bool
- Ip string
- StatusLists []string
- Type string
- drsEnabled Boolean
- ip String
- statusLists List<String>
- type String
- drsEnabled boolean
- ip string
- statusLists string[]
- type string
- drs_enabled bool
- ip str
- status_lists Sequence[str]
- type str
- drsEnabled Boolean
- ip String
- statusLists List<String>
- type String
GetClustersEntityNode   
Package Details
- Repository
- nutanix pierskarsenbarg/pulumi-nutanix
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the nutanixTerraform Provider.
