Nutanix
Visualize your Nutanix infrastructure in JupiterOne — Prism Central accounts, clusters, hosts, and virtual machines — map hosts to the workloads they run, and monitor changes through queries and alerts.
- Installation
- Authorization
- Data Model
- Types
- Release Notes
Installation
This integration connects to a Nutanix Prism Central instance using the Nutanix v4.2 REST APIs and ingests clusters, hosts (physical nodes), and virtual machines. It is a collector-based integration and communicates with Prism Central over HTTPS on port 9440.
Configuration in Nutanix
Before configuring the integration in JupiterOne, prepare the following in Nutanix Prism Central:
- The hostname or IP address of your Prism Central instance, reachable from the JupiterOne collector on port
9440. - A local or authentication-domain user for the integration to authenticate as. Assign it a role with at least read (Viewer) access to clusters, hosts, and virtual machines.
- The username and password for that user.
- If Prism Central presents a self-signed or internal-CA TLS certificate, obtain the CA certificate (in PEM format) so the collector can verify the connection.
Once you have obtained the information above, proceed to JupiterOne to finalize the integration.
Configuration in JupiterOne
To install the Nutanix integration in JupiterOne, navigate to the Integrations tab in JupiterOne and select Nutanix. Click New Instance to begin configuring your integration.
Creating an instance requires the following:
-
The Account Name used to identify the Nutanix account in JupiterOne. Ingested entities will have this value stored in
tag.AccountNamewhen theAccountNametoggle is enabled. -
Description to assist in identifying the integration instance, if desired.
-
Polling Interval that you feel is sufficient for your monitoring needs. You may leave this as
DISABLEDand manually execute the integration. -
Your Prism Central Host, Username, and Password.
-
Optionally, a CA Certificate to trust a self-signed or internal-CA certificate, or enable Disable TLS Verification to skip certificate validation (not recommended).
-
Optionally, enable Include Powered-Off VMs to also ingest virtual machines that are powered off.
Click Create once all values are provided to finalize the integration.
Next steps
Now that your integration instance has been configured, it will begin running on the polling interval you provided, populating data within JupiterOne. Continue on to our Instance management guide to learn more about working with and editing integration instances.
Roles
RBAC roles that must be assigned to the integration principal.
Show Roles (1)
Viewer
Endpoints
API endpoints that the integration makes requests to.
Show Endpoints (3)
https://<prism-central-host>:9440/api/clustermgmt/v4.2/config/clustershttps://<prism-central-host>:9440/api/clustermgmt/v4.2/config/hostshttps://<prism-central-host>:9440/api/vmm/v4.2/ahv/config/vms
Documentation Links
Links to provider documentation relevant to setup and configuration.
Show Documentation Links (3)
Per-Step Breakdown
Detailed authorization requirements for each ingestion step.
Show all steps (2)
| Step | Roles | Endpoints |
|---|---|---|
| Fetch Hosts | Viewer | https://<prism-central-host>:9440/api/clustermgmt/v4.2/config/hosts |
| Fetch Virtual Machines | Viewer | https://<prism-central-host>:9440/api/vmm/v4.2/ahv/config/vms |
Entities
The following entities are created:
| Resources | Entity _type | Entity _class |
|---|---|---|
| Account | nutanix_account | Account |
| Cluster | nutanix_cluster | Cluster |
| Host | nutanix_host | Host |
| VirtualMachine | nutanix_vm | Workload |
Relationships
The following relationships are created:
Source Entity _type | Relationship _class | Target Entity _type |
|---|---|---|
nutanix_account | HAS | nutanix_cluster |
nutanix_cluster | HAS | nutanix_host |
nutanix_cluster | CONTAINS | nutanix_vm |
nutanix_host | HOSTS | nutanix_vm |
Nutanix Account
nutanix_account inherits from Account
Nutanix Cluster
nutanix_cluster inherits from Cluster
| Property | Type | Description | Specifications |
|---|---|---|---|
clusterFqdn * | string | null | Fully qualified domain name of the cluster. | |
clusterType * | string | null | The type of cluster (e.g. AOS, PRISM_CENTRAL). | |
encryptionInTransitStatus * | string | null | Encryption-in-transit status for the cluster. | |
externalIpAddress * | string | null | Cluster external (virtual) IPv4 address. | |
hypervisorTypes * | array | null | Hypervisor types running on the cluster (e.g. AHV, ESX). | |
version * | string | null | Cluster software (AOS) build version. | |
vmCount * | number | null | Number of VMs running on the cluster. |
Nutanix Host
nutanix_host inherits from Host
| Property | Type | Description | Specifications |
|---|---|---|---|
cpuCapacityHz * | number | null | Total CPU capacity of the host in Hz. | |
cpuFrequencyHz * | number | null | CPU frequency of the host in Hz. | |
cpuModel * | string | null | CPU model name of the host. | |
hypervisorState * | string | null | Current state of the hypervisor on the host. | |
hypervisorType * | string | null | Hypervisor type running on the host (e.g. AHV). | |
isDegraded * | boolean | null | Whether the node is in a degraded state. | |
isSecureBooted * | boolean | null | Whether the host booted with Secure Boot enabled. | |
maintenanceState * | string | null | Maintenance state of the host. | |
memorySizeBytes * | number | null | Total memory size of the host in bytes. | |
numCpuCores * | number | null | Number of CPU cores on the host. | |
numCpuSockets * | number | null | Number of CPU sockets on the host. | |
numCpuThreads * | number | null | Number of CPU threads on the host. |
Nutanix Vm
nutanix_vm inherits from Workload
| Property | Type | Description | Specifications |
|---|---|---|---|
biosUuid * | string | null | BIOS UUID of the VM. | |
categoryIds * | array | null | External ids of the categories associated with the VM. | |
ipAddresses * | array | null | IPv4 addresses learned on the VM NICs, as reported by the guest. | |
isAgentVm * | boolean | null | Whether the VM is an agent VM. | |
isLiveMigrateCapable * | boolean | null | Whether the VM is capable of live migration. | |
memorySizeBytes * | number | null | Memory size assigned to the VM in bytes. | |
numCoresPerSocket * | number | null | Number of cores per socket assigned to the VM. | |
numSockets * | number | null | Number of vCPU sockets assigned to the VM. | |
numThreadsPerCore * | number | null | Number of threads per core assigned to the VM. | |
powerState * | string | null | Power state of the VM (ON, OFF, PAUSED, UNDETERMINED). | |
protectionType * | string | null | Data protection type applied to the VM. |