Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Nutanix
  3. API Docs
  4. getCluster
Nutanix v0.7.3 published on Thursday, Mar 13, 2025 by Piers Karsenbarg
pierskarsenbarg/pulumi-nutanix

nutanix.getCluster

Explore with Pulumi AI

Nutanix v0.7.3 published on Thursday, Mar 13, 2025 by Piers Karsenbarg
pierskarsenbarg/pulumi-nutanix

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>
Copy
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]
Copy
func GetCluster(ctx *Context, args *GetClusterArgs, opts ...InvokeOption) (*GetClusterResult, error)
func GetClusterOutput(ctx *Context, args *GetClusterOutputArgs, opts ...InvokeOption) GetClusterResultOutput
Copy

> 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)
}
Copy
public static CompletableFuture<GetClusterResult> getCluster(GetClusterArgs args, InvokeOptions options)
public static Output<GetClusterResult> getCluster(GetClusterArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: nutanix:index/getCluster:getCluster
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Categories List<PiersKarsenbarg.Nutanix.Inputs.GetClusterCategory>
  • Categories for the image.
ClusterId string
Represents clusters uuid
Name string
Represents the name of cluster
Categories []GetClusterCategory
  • Categories for the image.
ClusterId string
Represents clusters uuid
Name string
Represents the name of cluster
categories List<GetClusterCategory>
  • Categories for the image.
clusterId String
Represents clusters uuid
name String
Represents the name of cluster
categories GetClusterCategory[]
  • Categories for the image.
clusterId string
Represents clusters uuid
name string
Represents the name of cluster
categories Sequence[GetClusterCategory]
  • 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:

AnalysisVmEfficiencyMap Dictionary<string, string>
  • Map of cluster efficiency which includes numbers of inefficient vms. The value is populated by analytics on PC. (Readonly)
ApiVersion string
The API version.
AuthorizedPublicKeyLists List<PiersKarsenbarg.Nutanix.Outputs.GetClusterAuthorizedPublicKeyList>
Build Dictionary<string, string>
  • Cluster build details.
CaCertificateLists List<PiersKarsenbarg.Nutanix.Outputs.GetClusterCaCertificateList>
  • Zone name used in value of TZ environment variable.
Categories List<PiersKarsenbarg.Nutanix.Outputs.GetClusterCategory>
  • Categories for the image.
CertificationSigningInfo Dictionary<string, string>
  • 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
DomainServerCredentials Dictionary<string, string>
  • Cluster domain credentials.
DomainServerName string
  • Joined domain name. In 'put' request, empty name will unjoin the cluster from current domain.
DomainServerNameserver string
  • The IP of the nameserver that can resolve the domain name. Must set when joining the domain.
EnabledFeatureLists List<string>
  • Array of enabled features.
EncryptionStatus string
  • Cluster encryption status.
ExternalDataServicesIp string
  • 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)
GpuDriverVersion string
  • GPU driver version.
HttpProxyLists List<PiersKarsenbarg.Nutanix.Outputs.GetClusterHttpProxyList>
  • List of proxies to connect to the service centers.
HttpProxyWhitelists List<PiersKarsenbarg.Nutanix.Outputs.GetClusterHttpProxyWhitelist>
  • 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)
ManagementServerLists List<PiersKarsenbarg.Nutanix.Outputs.GetClusterManagementServerList>
  • 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.
NameServerIpLists List<string>
  • The list of IP addresses of the name servers.
NfsSubnetWhitelists List<string>
  • 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.GetClusterNode>
NtpServerIpLists List<string>
  • 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.
SmtpServerAddress Dictionary<string, string>
  • SMTP Server Address.
SmtpServerCredentials Dictionary<string, string>
  • SMTP Server Credentials.
SmtpServerEmailAddress string
  • SMTP Server Email Address.
SmtpServerProxyTypeLists List<string>
  • SMTP Server Proxy Type List
SmtpServerType string
  • SMTP Server type.
SoftwareMapNcc Dictionary<string, string>
  • Map of software on the cluster with software type as the key.
SoftwareMapNos Dictionary<string, string>
  • Map of software on the cluster with software type as the key.
SslKeyExpireDatetime string
  • UTC date and time in RFC-3339 format when the key expires
SslKeyName string
SslKeySigningInfo Dictionary<string, string>
  • Customer information used in Certificate Signing Request for creating digital certificates.
SslKeyType string
  • 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.
SupportedInformationVerbosity string
  • 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.
AnalysisVmEfficiencyMap map[string]string
  • Map of cluster efficiency which includes numbers of inefficient vms. The value is populated by analytics on PC. (Readonly)
ApiVersion string
The API version.
AuthorizedPublicKeyLists []GetClusterAuthorizedPublicKeyList
Build map[string]string
  • Cluster build details.
CaCertificateLists []GetClusterCaCertificateList
  • Zone name used in value of TZ environment variable.
Categories []GetClusterCategory
  • Categories for the image.
CertificationSigningInfo map[string]string
  • 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
DomainServerCredentials map[string]string
  • Cluster domain credentials.
DomainServerName string
  • Joined domain name. In 'put' request, empty name will unjoin the cluster from current domain.
DomainServerNameserver string
  • The IP of the nameserver that can resolve the domain name. Must set when joining the domain.
EnabledFeatureLists []string
  • Array of enabled features.
EncryptionStatus string
  • Cluster encryption status.
ExternalDataServicesIp string
  • 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)
GpuDriverVersion string
  • GPU driver version.
HttpProxyLists []GetClusterHttpProxyList
  • List of proxies to connect to the service centers.
HttpProxyWhitelists []GetClusterHttpProxyWhitelist
  • 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)
ManagementServerLists []GetClusterManagementServerList
  • 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.
NameServerIpLists []string
  • The list of IP addresses of the name servers.
NfsSubnetWhitelists []string
  • 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 []GetClusterNode
NtpServerIpLists []string
  • 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.
SmtpServerAddress map[string]string
  • SMTP Server Address.
SmtpServerCredentials map[string]string
  • SMTP Server Credentials.
SmtpServerEmailAddress string
  • SMTP Server Email Address.
SmtpServerProxyTypeLists []string
  • SMTP Server Proxy Type List
SmtpServerType string
  • SMTP Server type.
SoftwareMapNcc map[string]string
  • Map of software on the cluster with software type as the key.
SoftwareMapNos map[string]string
  • Map of software on the cluster with software type as the key.
SslKeyExpireDatetime string
  • UTC date and time in RFC-3339 format when the key expires
SslKeyName string
SslKeySigningInfo map[string]string
  • Customer information used in Certificate Signing Request for creating digital certificates.
SslKeyType string
  • 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.
SupportedInformationVerbosity string
  • 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.
analysisVmEfficiencyMap Map<String,String>
  • Map of cluster efficiency which includes numbers of inefficient vms. The value is populated by analytics on PC. (Readonly)
apiVersion String
The API version.
authorizedPublicKeyLists List<GetClusterAuthorizedPublicKeyList>
build Map<String,String>
  • Cluster build details.
caCertificateLists List<GetClusterCaCertificateList>
  • Zone name used in value of TZ environment variable.
categories List<GetClusterCategory>
  • Categories for the image.
certificationSigningInfo Map<String,String>
  • 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
domainServerCredentials Map<String,String>
  • Cluster domain credentials.
domainServerName String
  • Joined domain name. In 'put' request, empty name will unjoin the cluster from current domain.
domainServerNameserver String
  • The IP of the nameserver that can resolve the domain name. Must set when joining the domain.
enabledFeatureLists List<String>
  • Array of enabled features.
encryptionStatus String
  • Cluster encryption status.
externalDataServicesIp String
  • 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)
gpuDriverVersion String
  • GPU driver version.
httpProxyLists List<GetClusterHttpProxyList>
  • List of proxies to connect to the service centers.
httpProxyWhitelists List<GetClusterHttpProxyWhitelist>
  • 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)
managementServerLists List<GetClusterManagementServerList>
  • 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.
nameServerIpLists List<String>
  • The list of IP addresses of the name servers.
nfsSubnetWhitelists List<String>
  • 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<GetClusterNode>
ntpServerIpLists List<String>
  • 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.
smtpServerAddress Map<String,String>
  • SMTP Server Address.
smtpServerCredentials Map<String,String>
  • SMTP Server Credentials.
smtpServerEmailAddress String
  • SMTP Server Email Address.
smtpServerProxyTypeLists List<String>
  • SMTP Server Proxy Type List
smtpServerType String
  • SMTP Server type.
softwareMapNcc Map<String,String>
  • Map of software on the cluster with software type as the key.
softwareMapNos Map<String,String>
  • Map of software on the cluster with software type as the key.
sslKeyExpireDatetime String
  • UTC date and time in RFC-3339 format when the key expires
sslKeyName String
sslKeySigningInfo Map<String,String>
  • Customer information used in Certificate Signing Request for creating digital certificates.
sslKeyType String
  • 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.
supportedInformationVerbosity String
  • 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.
analysisVmEfficiencyMap {[key: string]: string}
  • Map of cluster efficiency which includes numbers of inefficient vms. The value is populated by analytics on PC. (Readonly)
apiVersion string
The API version.
authorizedPublicKeyLists GetClusterAuthorizedPublicKeyList[]
build {[key: string]: string}
  • Cluster build details.
caCertificateLists GetClusterCaCertificateList[]
  • Zone name used in value of TZ environment variable.
categories GetClusterCategory[]
  • Categories for the image.
certificationSigningInfo {[key: string]: string}
  • 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
domainServerCredentials {[key: string]: string}
  • Cluster domain credentials.
domainServerName string
  • Joined domain name. In 'put' request, empty name will unjoin the cluster from current domain.
domainServerNameserver string
  • The IP of the nameserver that can resolve the domain name. Must set when joining the domain.
enabledFeatureLists string[]
  • Array of enabled features.
encryptionStatus string
  • Cluster encryption status.
externalDataServicesIp string
  • 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)
gpuDriverVersion string
  • GPU driver version.
httpProxyLists GetClusterHttpProxyList[]
  • List of proxies to connect to the service centers.
httpProxyWhitelists GetClusterHttpProxyWhitelist[]
  • 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)
managementServerLists GetClusterManagementServerList[]
  • 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.
nameServerIpLists string[]
  • The list of IP addresses of the name servers.
nfsSubnetWhitelists string[]
  • 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 GetClusterNode[]
ntpServerIpLists string[]
  • 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.
smtpServerAddress {[key: string]: string}
  • SMTP Server Address.
smtpServerCredentials {[key: string]: string}
  • SMTP Server Credentials.
smtpServerEmailAddress string
  • SMTP Server Email Address.
smtpServerProxyTypeLists string[]
  • SMTP Server Proxy Type List
smtpServerType string
  • SMTP Server type.
softwareMapNcc {[key: string]: string}
  • Map of software on the cluster with software type as the key.
softwareMapNos {[key: string]: string}
  • Map of software on the cluster with software type as the key.
sslKeyExpireDatetime string
  • UTC date and time in RFC-3339 format when the key expires
sslKeyName string
sslKeySigningInfo {[key: string]: string}
  • Customer information used in Certificate Signing Request for creating digital certificates.
sslKeyType string
  • 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.
supportedInformationVerbosity string
  • 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_efficiency_map Mapping[str, str]
  • 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.
authorized_public_key_lists Sequence[GetClusterAuthorizedPublicKeyList]
build Mapping[str, str]
  • Cluster build details.
ca_certificate_lists Sequence[GetClusterCaCertificateList]
  • Zone name used in value of TZ environment variable.
categories Sequence[GetClusterCategory]
  • Categories for the image.
certification_signing_info Mapping[str, str]
  • 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_credentials Mapping[str, str]
  • Cluster domain credentials.
domain_server_name str
  • Joined domain name. In 'put' request, empty name will unjoin the cluster from current domain.
domain_server_nameserver str
  • The IP of the nameserver that can resolve the domain name. Must set when joining the domain.
enabled_feature_lists Sequence[str]
  • Array of enabled features.
encryption_status str
  • Cluster encryption status.
external_data_services_ip str
  • 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_version str
  • GPU driver version.
http_proxy_lists Sequence[GetClusterHttpProxyList]
  • List of proxies to connect to the service centers.
http_proxy_whitelists Sequence[GetClusterHttpProxyWhitelist]
  • 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_lists Sequence[GetClusterManagementServerList]
  • 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_ip_lists Sequence[str]
  • The list of IP addresses of the name servers.
nfs_subnet_whitelists Sequence[str]
  • 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[GetClusterNode]
ntp_server_ip_lists Sequence[str]
  • 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_address Mapping[str, str]
  • SMTP Server Address.
smtp_server_credentials Mapping[str, str]
  • SMTP Server Credentials.
smtp_server_email_address str
  • SMTP Server Email Address.
smtp_server_proxy_type_lists Sequence[str]
  • SMTP Server Proxy Type List
smtp_server_type str
  • SMTP Server type.
software_map_ncc Mapping[str, str]
  • Map of software on the cluster with software type as the key.
software_map_nos Mapping[str, str]
  • Map of software on the cluster with software type as the key.
ssl_key_expire_datetime str
  • UTC date and time in RFC-3339 format when the key expires
ssl_key_name str
ssl_key_signing_info Mapping[str, str]
  • Customer information used in Certificate Signing Request for creating digital certificates.
ssl_key_type str
  • 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_verbosity str
  • 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.
analysisVmEfficiencyMap Map<String>
  • Map of cluster efficiency which includes numbers of inefficient vms. The value is populated by analytics on PC. (Readonly)
apiVersion String
The API version.
authorizedPublicKeyLists List<Property Map>
build Map<String>
  • Cluster build details.
caCertificateLists List<Property Map>
  • Zone name used in value of TZ environment variable.
categories List<Property Map>
  • Categories for the image.
certificationSigningInfo Map<String>
  • 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
domainServerCredentials Map<String>
  • Cluster domain credentials.
domainServerName String
  • Joined domain name. In 'put' request, empty name will unjoin the cluster from current domain.
domainServerNameserver String
  • The IP of the nameserver that can resolve the domain name. Must set when joining the domain.
enabledFeatureLists List<String>
  • Array of enabled features.
encryptionStatus String
  • Cluster encryption status.
externalDataServicesIp String
  • 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)
gpuDriverVersion String
  • GPU driver version.
httpProxyLists List<Property Map>
  • List of proxies to connect to the service centers.
httpProxyWhitelists List<Property Map>
  • 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)
managementServerLists List<Property Map>
  • 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.
nameServerIpLists List<String>
  • The list of IP addresses of the name servers.
nfsSubnetWhitelists List<String>
  • 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>
ntpServerIpLists List<String>
  • 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.
smtpServerAddress Map<String>
  • SMTP Server Address.
smtpServerCredentials Map<String>
  • SMTP Server Credentials.
smtpServerEmailAddress String
  • SMTP Server Email Address.
smtpServerProxyTypeLists List<String>
  • SMTP Server Proxy Type List
smtpServerType String
  • SMTP Server type.
softwareMapNcc Map<String>
  • Map of software on the cluster with software type as the key.
softwareMapNos Map<String>
  • Map of software on the cluster with software type as the key.
sslKeyExpireDatetime String
  • UTC date and time in RFC-3339 format when the key expires
sslKeyName String
sslKeySigningInfo Map<String>
  • Customer information used in Certificate Signing Request for creating digital certificates.
sslKeyType String
  • 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.
supportedInformationVerbosity String
  • 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

Key This property is required. string
Name This property is required. string
Represents the name of cluster
Key This property is required. string
Name This property is required. string
Represents the name of cluster
key This property is required. String
name This property is required. String
Represents the name of cluster
key This property is required. string
name This property is required. string
Represents the name of cluster
key This property is required. str
name This property is required. str
Represents the name of cluster
key This property is required. String
name This property is required. String
Represents the name of cluster

GetClusterCaCertificateList

CaName This property is required. string
Certificate This property is required. string
CaName This property is required. string
Certificate This property is required. string
caName This property is required. String
certificate This property is required. String
caName This property is required. string
certificate This property is required. string
ca_name This property is required. str
certificate This property is required. str
caName This property is required. String
certificate This property is required. String

GetClusterCategory

Name This property is required. string
  • the key name.
Value This property is required. string
  • value of the key.
Name This property is required. string
  • the key name.
Value This property is required. string
  • value of the key.
name This property is required. String
  • the key name.
value This property is required. String
  • value of the key.
name This property is required. string
  • the key name.
value This property is required. string
  • value of the key.
name This property is required. str
  • the key name.
value This property is required. str
  • value of the key.
name This property is required. String
  • the key name.
value This property is required. String
  • value of the key.

GetClusterHttpProxyList

Address This property is required. Dictionary<string, string>
Credentials This property is required. Dictionary<string, string>
ProxyTypeLists This property is required. List<string>
Address This property is required. map[string]string
Credentials This property is required. map[string]string
ProxyTypeLists This property is required. []string
address This property is required. Map<String,String>
credentials This property is required. Map<String,String>
proxyTypeLists This property is required. List<String>
address This property is required. {[key: string]: string}
credentials This property is required. {[key: string]: string}
proxyTypeLists This property is required. string[]
address This property is required. Mapping[str, str]
credentials This property is required. Mapping[str, str]
proxy_type_lists This property is required. Sequence[str]
address This property is required. Map<String>
credentials This property is required. Map<String>
proxyTypeLists This property is required. List<String>

GetClusterHttpProxyWhitelist

Target This property is required. string
TargetType This property is required. string
Target This property is required. string
TargetType This property is required. string
target This property is required. String
targetType This property is required. String
target This property is required. string
targetType This property is required. string
target This property is required. str
target_type This property is required. str
target This property is required. String
targetType This property is required. String

GetClusterManagementServerList

DrsEnabled This property is required. bool
Ip This property is required. string
StatusLists This property is required. List<string>
Type This property is required. string
DrsEnabled This property is required. bool
Ip This property is required. string
StatusLists This property is required. []string
Type This property is required. string
drsEnabled This property is required. Boolean
ip This property is required. String
statusLists This property is required. List<String>
type This property is required. String
drsEnabled This property is required. boolean
ip This property is required. string
statusLists This property is required. string[]
type This property is required. string
drs_enabled This property is required. bool
ip This property is required. str
status_lists This property is required. Sequence[str]
type This property is required. str
drsEnabled This property is required. Boolean
ip This property is required. String
statusLists This property is required. List<String>
type This property is required. String

GetClusterNode

Ip This property is required. string
Type This property is required. string
Version This property is required. string
Ip This property is required. string
Type This property is required. string
Version This property is required. string
ip This property is required. String
type This property is required. String
version This property is required. String
ip This property is required. string
type This property is required. string
version This property is required. string
ip This property is required. str
type This property is required. str
version This property is required. str
ip This property is required. String
type This property is required. String
version This property is required. String

Package Details

Repository
nutanix pierskarsenbarg/pulumi-nutanix
License
Apache-2.0
Notes
This Pulumi package is based on the nutanix Terraform Provider.
Nutanix v0.7.3 published on Thursday, Mar 13, 2025 by Piers Karsenbarg
pierskarsenbarg/pulumi-nutanix