Nutanix v0.0.52 published on Friday, Jun 7, 2024 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)
// Output-based functions aren't available in Java yet
fn::invoke:
function: nutanix:index/getCluster:getCluster
arguments:
# arguments dictionary
The following arguments are supported:
- Categories
List<Piers
Karsenbarg. Nutanix. Inputs. Get Cluster Category> - Categories for the image.
- Cluster
Id string - Represents clusters uuid
- Name string
- Represents the name of cluster
- Categories
[]Get
Cluster Category - Categories for the image.
- Cluster
Id string - Represents clusters uuid
- Name string
- Represents the name of cluster
- categories
List<Get
Cluster Category> - Categories for the image.
- cluster
Id String - Represents clusters uuid
- name String
- Represents the name of cluster
- categories
Get
Cluster Category[] - Categories for the image.
- cluster
Id string - Represents clusters uuid
- name string
- Represents the name of cluster
- categories
Sequence[Get
Cluster 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.
- cluster
Id String - Represents clusters uuid
- name String
- Represents the name of cluster
getCluster Result
The following output properties are available:
- Analysis
Vm Dictionary<string, string>Efficiency Map - Map of cluster efficiency which includes numbers of inefficient vms. The value is populated by analytics on PC. (Readonly)
- Api
Version string - The API version.
- List<Piers
Karsenbarg. Nutanix. Outputs. Get Cluster Authorized Public Key List> - Build Dictionary<string, string>
- Cluster build details.
- Ca
Certificate List<PiersLists Karsenbarg. Nutanix. Outputs. Get Cluster Ca Certificate List> - Zone name used in value of TZ environment variable.
- Categories
List<Piers
Karsenbarg. Nutanix. Outputs. Get Cluster Category> - Categories for the image.
- Certification
Signing Dictionary<string, string>Info - Customer information used in Certificate Signing Request for creating digital certificates.
- Client
Auth Dictionary<string, string> - Client authentication config.
- Cluster
Arch string - Cluster architecture. (Readonly, Options: Options : X86_64 , PPC64LE)
- Cluster
Id string - Domain
Server Dictionary<string, string>Credentials - Cluster domain credentials.
- Domain
Server stringName - Joined domain name. In 'put' request, empty name will unjoin the cluster from current domain.
- Domain
Server stringNameserver - The IP of the nameserver that can resolve the domain name. Must set when joining the domain.
- Enabled
Feature List<string>Lists - Array of enabled features.
- Encryption
Status string - Cluster encryption status.
- External
Data stringServices Ip - The cluster IP address that provides external entities access to various cluster data services.
- External
Ip string - The local IP of cluster visible externally.
- External
Subnet string - External subnet for cross server communication. The format is IP/netmask. (default 172.16.0.0/255.240.0.0)
- Gpu
Driver stringVersion - GPU driver version.
- Http
Proxy List<PiersLists Karsenbarg. Nutanix. Outputs. Get Cluster Http Proxy List> - List of proxies to connect to the service centers.
- Http
Proxy List<PiersWhitelists Karsenbarg. Nutanix. Outputs. Get Cluster Http Proxy Whitelist> - HTTP proxy whitelist.
- Id string
- The provider-assigned unique ID for this managed resource.
- Internal
Subnet 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.
- Is
Available bool - Indicates if cluster is available to contact. (Readonly)
- Management
Server List<PiersLists Karsenbarg. Nutanix. Outputs. Get Cluster Management Server List> - List of cluster management servers. (Readonly)
- Masquerading
Ip string - 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 Dictionary<string, string>
- The image kind metadata.
- Name string
- the name.
- Name
Server List<string>Ip Lists - The list of IP addresses of the name servers.
- Nfs
Subnet 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<Piers
Karsenbarg. Nutanix. Outputs. Get Cluster Node> - Ntp
Server List<string>Ip Lists - The list of IP addresses or FQDNs of the NTP servers.
- Operation
Mode 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.
- Owner
Reference Dictionary<string, string> - The reference to a user.
- Project
Reference Dictionary<string, string> - The reference to a project.
- Service
Lists 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.
- Smtp
Server Dictionary<string, string>Address - SMTP Server Address.
- Smtp
Server Dictionary<string, string>Credentials - SMTP Server Credentials.
- Smtp
Server stringEmail Address - SMTP Server Email Address.
- Smtp
Server List<string>Proxy Type Lists - SMTP Server Proxy Type List
- Smtp
Server stringType - SMTP Server type.
- Software
Map Dictionary<string, object>Ncc - Map of software on the cluster with software type as the key.
- Software
Map Dictionary<string, object>Nos - Map of software on the cluster with software type as the key.
- Ssl
Key stringExpire Datetime - UTC date and time in RFC-3339 format when the key expires
- Ssl
Key stringName - Ssl
Key Dictionary<string, string>Signing Info - Customer information used in Certificate Signing Request for creating digital certificates.
- Ssl
Key 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.
- Supported
Information 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 map[string]stringEfficiency Map - Map of cluster efficiency which includes numbers of inefficient vms. The value is populated by analytics on PC. (Readonly)
- Api
Version string - The API version.
- []Get
Cluster Authorized Public Key List - Build map[string]string
- Cluster build details.
- Ca
Certificate []GetLists Cluster Ca Certificate List - Zone name used in value of TZ environment variable.
- Categories
[]Get
Cluster Category - Categories for the image.
- Certification
Signing map[string]stringInfo - Customer information used in Certificate Signing Request for creating digital certificates.
- Client
Auth map[string]string - Client authentication config.
- Cluster
Arch string - Cluster architecture. (Readonly, Options: Options : X86_64 , PPC64LE)
- Cluster
Id string - Domain
Server map[string]stringCredentials - Cluster domain credentials.
- Domain
Server stringName - Joined domain name. In 'put' request, empty name will unjoin the cluster from current domain.
- Domain
Server stringNameserver - The IP of the nameserver that can resolve the domain name. Must set when joining the domain.
- Enabled
Feature []stringLists - Array of enabled features.
- Encryption
Status string - Cluster encryption status.
- External
Data stringServices Ip - The cluster IP address that provides external entities access to various cluster data services.
- External
Ip string - The local IP of cluster visible externally.
- External
Subnet string - External subnet for cross server communication. The format is IP/netmask. (default 172.16.0.0/255.240.0.0)
- Gpu
Driver stringVersion - GPU driver version.
- Http
Proxy []GetLists Cluster Http Proxy List - List of proxies to connect to the service centers.
- Http
Proxy []GetWhitelists Cluster Http Proxy Whitelist - HTTP proxy whitelist.
- Id string
- The provider-assigned unique ID for this managed resource.
- Internal
Subnet 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.
- Is
Available bool - Indicates if cluster is available to contact. (Readonly)
- Management
Server []GetLists Cluster Management Server List - List of cluster management servers. (Readonly)
- Masquerading
Ip string - 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 map[string]string
- The image kind metadata.
- Name string
- the name.
- Name
Server []stringIp Lists - The list of IP addresses of the name servers.
- Nfs
Subnet []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
[]Get
Cluster Node - Ntp
Server []stringIp Lists - The list of IP addresses or FQDNs of the NTP servers.
- Operation
Mode 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.
- Owner
Reference map[string]string - The reference to a user.
- Project
Reference map[string]string - The reference to a project.
- Service
Lists []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.
- Smtp
Server map[string]stringAddress - SMTP Server Address.
- Smtp
Server map[string]stringCredentials - SMTP Server Credentials.
- Smtp
Server stringEmail Address - SMTP Server Email Address.
- Smtp
Server []stringProxy Type Lists - SMTP Server Proxy Type List
- Smtp
Server stringType - SMTP Server type.
- Software
Map map[string]interface{}Ncc - Map of software on the cluster with software type as the key.
- Software
Map map[string]interface{}Nos - Map of software on the cluster with software type as the key.
- Ssl
Key stringExpire Datetime - UTC date and time in RFC-3339 format when the key expires
- Ssl
Key stringName - Ssl
Key map[string]stringSigning Info - Customer information used in Certificate Signing Request for creating digital certificates.
- Ssl
Key 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.
- Supported
Information 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 Map<String,String>Efficiency Map - Map of cluster efficiency which includes numbers of inefficient vms. The value is populated by analytics on PC. (Readonly)
- api
Version String - The API version.
- List<Get
Cluster Authorized Public Key List> - build Map<String,String>
- Cluster build details.
- ca
Certificate List<GetLists Cluster Ca Certificate List> - Zone name used in value of TZ environment variable.
- categories
List<Get
Cluster Category> - Categories for the image.
- certification
Signing Map<String,String>Info - Customer information used in Certificate Signing Request for creating digital certificates.
- client
Auth Map<String,String> - Client authentication config.
- cluster
Arch String - Cluster architecture. (Readonly, Options: Options : X86_64 , PPC64LE)
- cluster
Id String - domain
Server Map<String,String>Credentials - Cluster domain credentials.
- domain
Server StringName - Joined domain name. In 'put' request, empty name will unjoin the cluster from current domain.
- domain
Server StringNameserver - The IP of the nameserver that can resolve the domain name. Must set when joining the domain.
- enabled
Feature List<String>Lists - Array of enabled features.
- encryption
Status String - Cluster encryption status.
- external
Data StringServices Ip - The cluster IP address that provides external entities access to various cluster data services.
- external
Ip String - The local IP of cluster visible externally.
- external
Subnet String - External subnet for cross server communication. The format is IP/netmask. (default 172.16.0.0/255.240.0.0)
- gpu
Driver StringVersion - GPU driver version.
- http
Proxy List<GetLists Cluster Http Proxy List> - List of proxies to connect to the service centers.
- http
Proxy List<GetWhitelists Cluster Http Proxy Whitelist> - HTTP proxy whitelist.
- id String
- The provider-assigned unique ID for this managed resource.
- internal
Subnet 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.
- is
Available Boolean - Indicates if cluster is available to contact. (Readonly)
- management
Server List<GetLists Cluster Management Server List> - List of cluster management servers. (Readonly)
- masquerading
Ip String - The cluster NAT'd or proxy IP which maps to the cluster local IP.
- masquerading
Port Integer - Port used together with masquerading_ip to connect to the cluster.
- metadata Map<String,String>
- The image kind metadata.
- name String
- the name.
- name
Server List<String>Ip Lists - The list of IP addresses of the name servers.
- nfs
Subnet 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<Get
Cluster Node> - ntp
Server List<String>Ip Lists - The list of IP addresses or FQDNs of the NTP servers.
- operation
Mode 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.
- owner
Reference Map<String,String> - The reference to a user.
- project
Reference Map<String,String> - The reference to a project.
- service
Lists 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.
- smtp
Server Map<String,String>Address - SMTP Server Address.
- smtp
Server Map<String,String>Credentials - SMTP Server Credentials.
- smtp
Server StringEmail Address - SMTP Server Email Address.
- smtp
Server List<String>Proxy Type Lists - SMTP Server Proxy Type List
- smtp
Server StringType - SMTP Server type.
- software
Map Map<String,Object>Ncc - Map of software on the cluster with software type as the key.
- software
Map Map<String,Object>Nos - Map of software on the cluster with software type as the key.
- ssl
Key StringExpire Datetime - UTC date and time in RFC-3339 format when the key expires
- ssl
Key StringName - ssl
Key Map<String,String>Signing Info - Customer information used in Certificate Signing Request for creating digital certificates.
- ssl
Key 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.
- supported
Information 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 {[key: string]: string}Efficiency Map - Map of cluster efficiency which includes numbers of inefficient vms. The value is populated by analytics on PC. (Readonly)
- api
Version string - The API version.
- Get
Cluster Authorized Public Key List[] - build {[key: string]: string}
- Cluster build details.
- ca
Certificate GetLists Cluster Ca Certificate List[] - Zone name used in value of TZ environment variable.
- categories
Get
Cluster Category[] - Categories for the image.
- certification
Signing {[key: string]: string}Info - Customer information used in Certificate Signing Request for creating digital certificates.
- client
Auth {[key: string]: string} - Client authentication config.
- cluster
Arch string - Cluster architecture. (Readonly, Options: Options : X86_64 , PPC64LE)
- cluster
Id string - domain
Server {[key: string]: string}Credentials - Cluster domain credentials.
- domain
Server stringName - Joined domain name. In 'put' request, empty name will unjoin the cluster from current domain.
- domain
Server stringNameserver - The IP of the nameserver that can resolve the domain name. Must set when joining the domain.
- enabled
Feature string[]Lists - Array of enabled features.
- encryption
Status string - Cluster encryption status.
- external
Data stringServices Ip - The cluster IP address that provides external entities access to various cluster data services.
- external
Ip string - The local IP of cluster visible externally.
- external
Subnet string - External subnet for cross server communication. The format is IP/netmask. (default 172.16.0.0/255.240.0.0)
- gpu
Driver stringVersion - GPU driver version.
- http
Proxy GetLists Cluster Http Proxy List[] - List of proxies to connect to the service centers.
- http
Proxy GetWhitelists Cluster Http Proxy Whitelist[] - HTTP proxy whitelist.
- id string
- The provider-assigned unique ID for this managed resource.
- internal
Subnet 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.
- is
Available boolean - Indicates if cluster is available to contact. (Readonly)
- management
Server GetLists Cluster Management Server List[] - List of cluster management servers. (Readonly)
- masquerading
Ip string - The cluster NAT'd or proxy IP which maps to the cluster local IP.
- masquerading
Port number - Port used together with masquerading_ip to connect to the cluster.
- metadata {[key: string]: string}
- The image kind metadata.
- name string
- the name.
- name
Server string[]Ip Lists - The list of IP addresses of the name servers.
- nfs
Subnet 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
Get
Cluster Node[] - ntp
Server string[]Ip Lists - The list of IP addresses or FQDNs of the NTP servers.
- operation
Mode 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.
- owner
Reference {[key: string]: string} - The reference to a user.
- project
Reference {[key: string]: string} - The reference to a project.
- service
Lists 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.
- smtp
Server {[key: string]: string}Address - SMTP Server Address.
- smtp
Server {[key: string]: string}Credentials - SMTP Server Credentials.
- smtp
Server stringEmail Address - SMTP Server Email Address.
- smtp
Server string[]Proxy Type Lists - SMTP Server Proxy Type List
- smtp
Server stringType - SMTP Server type.
- software
Map {[key: string]: any}Ncc - Map of software on the cluster with software type as the key.
- software
Map {[key: string]: any}Nos - Map of software on the cluster with software type as the key.
- ssl
Key stringExpire Datetime - UTC date and time in RFC-3339 format when the key expires
- ssl
Key stringName - ssl
Key {[key: string]: string}Signing Info - Customer information used in Certificate Signing Request for creating digital certificates.
- ssl
Key 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.
- supported
Information 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[Get
Cluster 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[Get
Cluster 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[Get
Cluster 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, Any]ncc - Map of software on the cluster with software type as the key.
- software_
map_ Mapping[str, Any]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.
- analysis
Vm Map<String>Efficiency Map - Map of cluster efficiency which includes numbers of inefficient vms. The value is populated by analytics on PC. (Readonly)
- api
Version String - The API version.
- List<Property Map>
- build Map<String>
- Cluster build details.
- ca
Certificate List<Property Map>Lists - Zone name used in value of TZ environment variable.
- categories List<Property Map>
- Categories for the image.
- certification
Signing Map<String>Info - Customer information used in Certificate Signing Request for creating digital certificates.
- client
Auth Map<String> - Client authentication config.
- cluster
Arch String - Cluster architecture. (Readonly, Options: Options : X86_64 , PPC64LE)
- cluster
Id String - domain
Server Map<String>Credentials - Cluster domain credentials.
- domain
Server StringName - Joined domain name. In 'put' request, empty name will unjoin the cluster from current domain.
- domain
Server StringNameserver - The IP of the nameserver that can resolve the domain name. Must set when joining the domain.
- enabled
Feature List<String>Lists - Array of enabled features.
- encryption
Status String - Cluster encryption status.
- external
Data StringServices Ip - The cluster IP address that provides external entities access to various cluster data services.
- external
Ip String - The local IP of cluster visible externally.
- external
Subnet String - External subnet for cross server communication. The format is IP/netmask. (default 172.16.0.0/255.240.0.0)
- gpu
Driver StringVersion - GPU driver version.
- http
Proxy List<Property Map>Lists - List of proxies to connect to the service centers.
- http
Proxy List<Property Map>Whitelists - HTTP proxy whitelist.
- id String
- The provider-assigned unique ID for this managed resource.
- internal
Subnet 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.
- is
Available Boolean - Indicates if cluster is available to contact. (Readonly)
- management
Server List<Property Map>Lists - List of cluster management servers. (Readonly)
- masquerading
Ip String - The cluster NAT'd or proxy IP which maps to the cluster local IP.
- masquerading
Port Number - Port used together with masquerading_ip to connect to the cluster.
- metadata Map<String>
- The image kind metadata.
- name String
- the name.
- name
Server List<String>Ip Lists - The list of IP addresses of the name servers.
- nfs
Subnet 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>
- ntp
Server List<String>Ip Lists - The list of IP addresses or FQDNs of the NTP servers.
- operation
Mode 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.
- owner
Reference Map<String> - The reference to a user.
- project
Reference Map<String> - The reference to a project.
- service
Lists 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.
- smtp
Server Map<String>Address - SMTP Server Address.
- smtp
Server Map<String>Credentials - SMTP Server Credentials.
- smtp
Server StringEmail Address - SMTP Server Email Address.
- smtp
Server List<String>Proxy Type Lists - SMTP Server Proxy Type List
- smtp
Server StringType - SMTP Server type.
- software
Map Map<Any>Ncc - Map of software on the cluster with software type as the key.
- software
Map Map<Any>Nos - Map of software on the cluster with software type as the key.
- ssl
Key StringExpire Datetime - UTC date and time in RFC-3339 format when the key expires
- ssl
Key StringName - ssl
Key Map<String>Signing Info - Customer information used in Certificate Signing Request for creating digital certificates.
- ssl
Key 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.
- supported
Information 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
- Ca
Name string - Certificate string
- Ca
Name string - Certificate string
- ca
Name String - certificate String
- ca
Name string - certificate string
- ca_
name str - certificate str
- ca
Name String - certificate String
GetClusterCategory
GetClusterHttpProxyList
- Address Dictionary<string, string>
- Credentials Dictionary<string, string>
- Proxy
Type List<string>Lists
- Address map[string]string
- Credentials map[string]string
- Proxy
Type []stringLists
- address Map<String,String>
- credentials Map<String,String>
- proxy
Type List<String>Lists
- address {[key: string]: string}
- credentials {[key: string]: string}
- proxy
Type string[]Lists
- address Mapping[str, str]
- credentials Mapping[str, str]
- proxy_
type_ Sequence[str]lists
- address Map<String>
- credentials Map<String>
- proxy
Type List<String>Lists
GetClusterHttpProxyWhitelist
- Target string
- Target
Type string
- Target string
- Target
Type string
- target String
- target
Type String
- target string
- target
Type string
- target str
- target_
type str
- target String
- target
Type String
GetClusterManagementServerList
- Drs
Enabled bool - Ip string
- Status
Lists List<string> - Type string
- Drs
Enabled bool - Ip string
- Status
Lists []string - Type string
- drs
Enabled Boolean - ip String
- status
Lists List<String> - type String
- drs
Enabled boolean - ip string
- status
Lists string[] - type string
- drs_
enabled bool - ip str
- status_
lists Sequence[str] - type str
- drs
Enabled Boolean - ip String
- status
Lists List<String> - type String
GetClusterNode
Package Details
- Repository
- nutanix pierskarsenbarg/pulumi-nutanix
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
nutanix
Terraform Provider.