Nutanix v0.7.4 published on Friday, Mar 21, 2025 by Piers Karsenbarg
nutanix.getCluster
Explore with Pulumi AI
Describes Clusters
Using getCluster
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 getCluster(args: GetClusterArgs, opts?: InvokeOptions): Promise<GetClusterResult>
function getClusterOutput(args: GetClusterOutputArgs, opts?: InvokeOptions): Output<GetClusterResult>def get_cluster(categories: Optional[Sequence[GetClusterCategory]] = None,
                cluster_id: Optional[str] = None,
                name: Optional[str] = None,
                opts: Optional[InvokeOptions] = None) -> GetClusterResult
def get_cluster_output(categories: Optional[pulumi.Input[Sequence[pulumi.Input[GetClusterCategoryArgs]]]] = None,
                cluster_id: Optional[pulumi.Input[str]] = None,
                name: Optional[pulumi.Input[str]] = None,
                opts: Optional[InvokeOptions] = None) -> Output[GetClusterResult]func GetCluster(ctx *Context, args *GetClusterArgs, opts ...InvokeOption) (*GetClusterResult, error)
func GetClusterOutput(ctx *Context, args *GetClusterOutputArgs, opts ...InvokeOption) GetClusterResultOutput> Note: This function is named GetCluster in the Go SDK.
public static class GetCluster 
{
    public static Task<GetClusterResult> InvokeAsync(GetClusterArgs args, InvokeOptions? opts = null)
    public static Output<GetClusterResult> Invoke(GetClusterInvokeArgs args, InvokeOptions? opts = null)
}public static CompletableFuture<GetClusterResult> getCluster(GetClusterArgs args, InvokeOptions options)
public static Output<GetClusterResult> getCluster(GetClusterArgs args, InvokeOptions options)
fn::invoke:
  function: nutanix:index/getCluster:getCluster
  arguments:
    # arguments dictionaryThe following arguments are supported:
- Categories
List<PiersKarsenbarg. Nutanix. Inputs. Get Cluster Category> 
- Categories for the image.
 
- ClusterId string
- Represents clusters uuid
- Name string
- Represents the name of cluster
- Categories
[]GetCluster Category 
- Categories for the image.
 
- ClusterId string
- Represents clusters uuid
- Name string
- Represents the name of cluster
- categories
List<GetCluster Category> 
- Categories for the image.
 
- clusterId String
- Represents clusters uuid
- name String
- Represents the name of cluster
- categories
GetCluster Category[] 
- Categories for the image.
 
- clusterId string
- Represents clusters uuid
- name string
- Represents the name of cluster
- categories
Sequence[GetCluster Category] 
- Categories for the image.
 
- cluster_id str
- Represents clusters uuid
- name str
- Represents the name of cluster
- categories List<Property Map>
- Categories for the image.
 
- clusterId String
- Represents clusters uuid
- name String
- Represents the name of cluster
getCluster Result
The following output properties are available:
- 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. Outputs. Get Cluster Authorized Public Key List> 
- Build Dictionary<string, string>
- Cluster build details.
 
- CaCertificate List<PiersLists Karsenbarg. Nutanix. Outputs. Get Cluster Ca Certificate List> 
- Zone name used in value of TZ environment variable.
 
- Categories
List<PiersKarsenbarg. Nutanix. Outputs. Get Cluster 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)
 
- ClusterId string
- 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. Outputs. Get Cluster Http Proxy List> 
- List of proxies to connect to the service centers.
 
- HttpProxy List<PiersWhitelists Karsenbarg. Nutanix. Outputs. Get Cluster Http Proxy Whitelist> 
- HTTP proxy whitelist.
 
- Id string
- The provider-assigned unique ID for this managed resource.
- 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. Outputs. Get Cluster 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.
 
- 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. Outputs. Get Cluster 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.
- 
[]GetCluster Authorized Public Key List 
- Build map[string]string
- Cluster build details.
 
- CaCertificate []GetLists Cluster Ca Certificate List 
- Zone name used in value of TZ environment variable.
 
- Categories
[]GetCluster 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)
 
- ClusterId string
- 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 Cluster Http Proxy List 
- List of proxies to connect to the service centers.
 
- HttpProxy []GetWhitelists Cluster Http Proxy Whitelist 
- HTTP proxy whitelist.
 
- Id string
- The provider-assigned unique ID for this managed resource.
- 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 Cluster 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.
 
- 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
[]GetCluster 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<GetCluster Authorized Public Key List> 
- build Map<String,String>
- Cluster build details.
 
- caCertificate List<GetLists Cluster Ca Certificate List> 
- Zone name used in value of TZ environment variable.
 
- categories
List<GetCluster 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)
 
- clusterId String
- 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 Cluster Http Proxy List> 
- List of proxies to connect to the service centers.
 
- httpProxy List<GetWhitelists Cluster Http Proxy Whitelist> 
- HTTP proxy whitelist.
 
- id String
- The provider-assigned unique ID for this managed resource.
- 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 Cluster 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.
 
- 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<GetCluster 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.
- 
GetCluster Authorized Public Key List[] 
- build {[key: string]: string}
- Cluster build details.
 
- caCertificate GetLists Cluster Ca Certificate List[] 
- Zone name used in value of TZ environment variable.
 
- categories
GetCluster 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)
 
- clusterId string
- 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 Cluster Http Proxy List[] 
- List of proxies to connect to the service centers.
 
- httpProxy GetWhitelists Cluster Http Proxy Whitelist[] 
- HTTP proxy whitelist.
 
- id string
- The provider-assigned unique ID for this managed resource.
- 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 Cluster 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.
 
- 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
GetCluster 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[GetCluster Authorized Public Key List] 
- build Mapping[str, str]
- Cluster build details.
 
- ca_certificate_ Sequence[Getlists Cluster Ca Certificate List] 
- Zone name used in value of TZ environment variable.
 
- categories
Sequence[GetCluster 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)
 
- cluster_id str
- 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 Cluster Http Proxy List] 
- List of proxies to connect to the service centers.
 
- http_proxy_ Sequence[Getwhitelists Cluster Http Proxy Whitelist] 
- HTTP proxy whitelist.
 
- id str
- The provider-assigned unique ID for this managed resource.
- 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 Cluster 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.
 
- 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[GetCluster 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)
 
- clusterId String
- 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.
 
- id String
- The provider-assigned unique ID for this managed resource.
- 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.
 
- 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.
 
Supporting Types
GetClusterAuthorizedPublicKeyList     
GetClusterCaCertificateList    
- 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
GetClusterCategory  
GetClusterHttpProxyList    
- 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 
GetClusterHttpProxyWhitelist    
- 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
GetClusterManagementServerList    
- 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
GetClusterNode  
Package Details
- Repository
- nutanix pierskarsenbarg/pulumi-nutanix
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the nutanixTerraform Provider.
