--- title: "Get a cluster" method: GET path: "/clusters/{uuid}" tags: ["clusters"] --- # Get a cluster `GET /clusters/{uuid}` This operation gets a cluster. ## Path parameters - `uuid` string, UUID, required ## Response `200` Success - ClusterIntentResponse — Response object for intentful operations on a cluster - `status` ClusterDefStatus — Cluster status definition. A Nutanix cluster is comprised of three or more Nutanix nodes. Each node in the cluster contains memory, CPU, RAM, and storage (SSD/HDD). Each node in the cluster runs standard hypervisor such as VMware vSphere, Microsoft Hyper-V, or AHV. A Controller VM (CVM) runs on each node in the cluster. The CVM enables each node to share local storage from all nodes in the cluster. - `state` string — The state of the cluster entity. - `message_list` MessageResource[] - `message` string, required — If state is ERROR, a message describing the error. - `reason` string, required — If state is ERROR, a machine-readable snake-cased string. - `details` object — Custom key-value details relevant to the status. - `name` string — Cluster Name. - `resources` object, required — Cluster resources. - `nodes` ClusterNodes — Node info for this cluster. - `hypervisor_server_list` HypervisorServer[] - `ip` string, required - `version` string - `type` string - `config` ClusterConfig, required — Cluster Configuration. - `gpu_driver_version` string — GPU driver version. - `client_auth` ClientAuth — Client authentication config. - `status` string, required — Status of client authentication. - `ca_chain` string, byte — Content of CA chain certificate. - `name` string — Name of CA chain file. - `software_map` object — Map of software on the cluster with software type as the key. - `encryption_status` string — Cluster encryption status. - `ssl_key` SslKey — SSL certificate. - `key_type` string, required — SSL key type. Key types with RSA_2048, ECDSA_256 and ECDSA_384 are supported for key generation and importing. - `key_name` string - `signing_info` CertificationSigningInfo — Customer information used in Certificate Signing Request for creating digital certificates. - `city` string — The Town or City where customer's business is located. - `state` string — The Province, Region, County or State where customer business is is located. - `country_code` string — Two-letter ISO code for Country where customer's organization is located. - `common_name` string — Common name of the organization or host server - `organization` string — Name of the customer business. - `email_address` string — Email address of the certificate administrator. - `common_name_suffix` string — Common name is by default .nutanix.com, but if a customer wants something instead of nutanix.com they can specify it here. - `expire_datetime` string, date-time — UTC date and time in RFC-3339 format when the key expires - `service_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 - 'ONE_NODE_CLUSTER': Single node backup cluster - 'TWO_NODE_CLUSTER': Two node cluster - `certification_signing_info` CertificationSigningInfo — Customer information used in Certificate Signing Request for creating digital certificates. - `city` string — The Town or City where customer's business is located. - `state` string — The Province, Region, County or State where customer business is is located. - `country_code` string — Two-letter ISO code for Country where customer's organization is located. - `common_name` string — Common name of the organization or host server - `organization` string — Name of the customer business. - `email_address` string — Email address of the certificate administrator. - `common_name_suffix` string — Common name is by default .nutanix.com, but if a customer wants something instead of nutanix.com they can specify it here. - `redundancy_factor` integer — Cluster supported redundancy factor. - `external_configurations` ExternalConfigurations — External configurations for the connectors. - `citrix_connector_config` CitrixConnectorConfigDetails — Citrix Connector details. - `citrix_vm_reference_list` VmReference[] — Reference to the list of vm ids registered with citrix cloud. - … - `client_secret` string — The client secret for the Citrix Cloud. - `customer_id` string — The customer id registered with Citrix Cloud. - `client_id` string — The client id for the Citrix Cloud. - `resource_location` CitrixResourceLocation — Resource Location on Citrix Cloud. - … - `ca_certificate_list` CaCert[] — List of cluster trusted CA certificates. - `ca_name` string, required — Name of the certificate authority. - `certificate` string, byte, required — Certificate content. - `enabled_feature_list` string[] — Array of enabled features. - `is_available` boolean — Indicates if cluster is available to contact. - `timezone` string — Zone name used in value of TZ environment variable. - `cluster_arch` string — Cluster architecture. - `management_server_list` ClusterManagementServer[] — List of cluster management servers. - `drs_enabled` boolean — Denotes if DRS is enabled or not. - `ip` string, required - `type` string, required - `status_list` string[] — Array of management server status: - 'REGISTERED': Indicates whether the server is registered with Nutanix or not. - 'IN_USE': Indicates whether any host is managed by this server or not. - `authorized_public_key_list` PublicKey[] — List of valid ssh keys for the cluster. - `name` string, required - `key` string, required - `supported_information_verbosity` 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 - `domain_awareness_level` string — Domain awareness supported on cluster. - `build` BuildInfo — Cluster build details. - `commit_id` string, required — Last Git commit id which the build is based on. - `version` string, required — Numeric version. e.g. "5.5" - `short_commit_id` string, required — First 6 characters of the last Git commit id. - `full_version` string — Full version name. - `commit_date` string, date-time — Date/time of the last commit. - `build_type` string, required — Build type, one of {dbg, opt, release}. - `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. - `network` ClusterNetwork, required — Cluster network. - `http_proxy_whitelist` HttpProxyWhitelist[] — HTTP proxy whitelist. - `target` string, required - `target_type` string, required - `masquerading_port` integer — Port used together with masquerading_ip to connect to the cluster. - `masquerading_ip` string — The cluster NAT'd or proxy IP which maps to the cluster local IP. - `external_ip` string — The local IP of cluster visible externally. - `http_proxy_list` ClusterNetworkEntity[] — List of proxies to connect to the service centers. - `credentials` Credentials — Credentials to login server - `username` string, required - `password` string - `address` Address, required — Host address. - `ip` string — IPV4 address. - `ipv6` string — IPV6 address. - `port` integer — Port Number - `fqdn` string — Fully qualified domain name. - `proxy_type_list` string[] - `smtp_server` SmtpServer — SMTP Server. - `email_address` string, required - `type` string - `server` ClusterNetworkEntity, required — Cluster network entity. - `credentials` Credentials — Credentials to login server - … - `address` Address, required — Host address. - … - `proxy_type_list` string[] - `ntp_server_ip_list` string[] — The list of IP addresses or FQDNs of the NTP servers. - `external_subnet` string — External subnet for cross server communication. The format is IP/netmask. - `external_data_services_ip` string — The cluster IP address that provides external entities access to various cluster data services. - `domain_server` ClusterDomainServer — Cluster domain server. Only applied to the cluster with all Hyper-V hosts. - `nameserver` string — The IP of the nameserver that can resolve the domain name. Must set when joining the domain. - `name` string, required — Joined domain name. In 'put' request, empty name will unjoin the cluster from current domain. - `domain_credentials` Credentials — Credentials to login server - `username` string, required - `password` string - `name_server_ip_list` string[] — The list of IP addresses of the name servers. - `nfs_subnet_whitelist` 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. - `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. - `default_vswitch_config` VswitchConfig — VSwitch configuration. - `nic_teaming_policy` string, required — NIC teaming policy. - `uplink_grouping` string, required — Determines how the ethernet uplinks are selected for this vswitch. - `runtime_status_list` string[] — Cluster current attributes and onging operations. - `spec` Cluster — Cluster Definition. - `name` string — Cluster Name. - `resources` object — Cluster resources. - `config` ClusterConfigSpec — Cluster Configuration. - `gpu_driver_version` string — GPU driver version. - `client_auth` ClientAuth — Client authentication config. - `status` string, required — Status of client authentication. - `ca_chain` string, byte — Content of CA chain certificate. - `name` string — Name of CA chain file. - `authorized_public_key_list` PublicKey[] — List of valid ssh keys for the cluster. - `name` string, required - `key` string, required - `software_map` object — Map of software on the cluster with software type as the key. - `encryption_status` string — Cluster encryption status. - `supported_information_verbosity` 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 - `certification_signing_info` CertificationSigningInfo — Customer information used in Certificate Signing Request for creating digital certificates. - `city` string — The Town or City where customer's business is located. - `state` string — The Province, Region, County or State where customer business is is located. - `country_code` string — Two-letter ISO code for Country where customer's organization is located. - `common_name` string — Common name of the organization or host server - `organization` string — Name of the customer business. - `email_address` string — Email address of the certificate administrator. - `common_name_suffix` string — Common name is by default .nutanix.com, but if a customer wants something instead of nutanix.com they can specify it here. - `redundancy_factor` integer — Cluster supported redundancy factor. Default is 2. - `external_configurations` ExternalConfigurationsSpec — External configurations for the connectors. - `citrix_connector_config` CitrixConnectorConfigDetailsSpec — Citrix Connector details. - `citrix_vm_reference_list` VmReference[] — Reference to the list of vm ids registered with citrix cloud. - … - `client_secret` string — The client secret for the Citrix Cloud. - `customer_id` string — The customer id registered with Citrix Cloud. - `client_id` string — The client id for the Citrix Cloud. - `resource_location` CitrixResourceLocationSpec — Resource Location on Citrix Cloud. - … - `domain_awareness_level` string — Domain awareness supported on cluster. - `enabled_feature_list` string[] — Array of enabled features. - `timezone` string — Zone name used in value of TZ environment variable. - `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. - `network` ClusterNetwork — Cluster network. - `http_proxy_whitelist` HttpProxyWhitelist[] — HTTP proxy whitelist. - `target` string, required - `target_type` string, required - `masquerading_port` integer — Port used together with masquerading_ip to connect to the cluster. - `masquerading_ip` string — The cluster NAT'd or proxy IP which maps to the cluster local IP. - `external_ip` string — The local IP of cluster visible externally. - `http_proxy_list` ClusterNetworkEntity[] — List of proxies to connect to the service centers. - `credentials` Credentials — Credentials to login server - `username` string, required - `password` string - `address` Address, required — Host address. - `ip` string — IPV4 address. - `ipv6` string — IPV6 address. - `port` integer — Port Number - `fqdn` string — Fully qualified domain name. - `proxy_type_list` string[] - `smtp_server` SmtpServer — SMTP Server. - `email_address` string, required - `type` string - `server` ClusterNetworkEntity, required — Cluster network entity. - `credentials` Credentials — Credentials to login server - … - `address` Address, required — Host address. - … - `proxy_type_list` string[] - `ntp_server_ip_list` string[] — The list of IP addresses or FQDNs of the NTP servers. - `external_subnet` string — External subnet for cross server communication. The format is IP/netmask. - `external_data_services_ip` string — The cluster IP address that provides external entities access to various cluster data services. - `domain_server` ClusterDomainServer — Cluster domain server. Only applied to the cluster with all Hyper-V hosts. - `nameserver` string — The IP of the nameserver that can resolve the domain name. Must set when joining the domain. - `name` string, required — Joined domain name. In 'put' request, empty name will unjoin the cluster from current domain. - `domain_credentials` Credentials — Credentials to login server - `username` string, required - `password` string - `name_server_ip_list` string[] — The list of IP addresses of the name servers. - `nfs_subnet_whitelist` 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. - `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. - `default_vswitch_config` VswitchConfig — VSwitch configuration. - `nic_teaming_policy` string, required — NIC teaming policy. - `uplink_grouping` string, required — Determines how the ethernet uplinks are selected for this vswitch. - `runtime_status_list` string[] — Cluster onging operations. - `api_version` string, required - `metadata` ClusterMetadata, required — The cluster kind metadata - `last_update_time` string, date-time — UTC date and time in RFC-3339 format when cluster was last updated - `kind` string, required — The kind name - `uuid` string, UUID — cluster uuid - `spec_version` integer — Version number of the latest spec. - `creation_time` string, date-time — UTC date and time in RFC-3339 format when cluster was created - `spec_hash` string — Hash of the spec. This will be returned from server. - `should_force_translate` boolean — Applied on Prism Central only. Indicate whether force to translate the spec of the fanout request to fit the target cluster API schema. - `owner_reference` UserReference — The reference to a user - `kind` string, required — The kind name - `name` string - `uuid` string, UUID, required - `categories` object — Categories for the cluster - `name` string — cluster name ## Other responses - `default` — Internal Error --- [API](https://skmtc.net/nutanix/apis/nutanix-intentful-api.md) · [All operations](https://skmtc.net/nutanix/apis/nutanix-intentful-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/nutanix/nutanix-intentful-api/versions/40395083ab31/schema)