Nutanix Acropolis discovery
Summarize
Summary of Nutanix Acropolis discovery
The ServiceNow Discovery application leverages the Nutanix Components pattern to identify and gather details about Nutanix Acropolis environments, specifically supporting Nutanix Prism Central version 2024.3.1.8 and Prism Element 7.0.1.6. It uses REST APIs to collect data, with support for both API versions v1-3 and the newer v4 starting from Discovery and Service Mapping Patterns version 1.29.0. Nutanix event patterns detect state changes in virtual machines and hosts, triggering rediscovery to keep CMDB data current.
Show less
Key Features
- Comprehensive Discovery: Identifies Nutanix clusters, hosts, virtual machines, storage pools, storage containers, and controller VMs, populating detailed configuration items (CIs) in the CMDB.
- API Version Support: Supports legacy APIs (v1-3) and the latest v4 API, with v4 discovery creating new records without updating legacy ones.
- Event-driven Rediscovery: Nutanix VM Event and Host Event patterns detect state changes every five minutes (disabled by default), enabling near real-time CMDB updates.
- Integration with VMware: Links Nutanix components hosted on ESX clusters to VMware clusters when VMware probe discovery is run prior to Nutanix discovery.
- Tag Discovery: Collects tags for hosts and VMs, storing them in the Key Value [cmdbkeyvalue] table, with an option to disable tag discovery for performance optimization.
- Security and Connectivity: Requires MID Server deployment with SSL certificates installed and proper API permissions configured for read-only access.
- Configurable Batch Processing: Allows adjustment of batch size for deleting redundant relationships to optimize performance.
- Dashboards: Provides out-of-the-box dashboards for visibility into discovered Nutanix infrastructure, accessible via the Discovery Admin Workspace.
Prerequisites and Configuration
- Ensure the Discovery and Service Mapping Patterns, Visibility Content, and CMDB CI Class Models applications are up to date.
- Deploy a dedicated MID Server with network access to Nutanix Prism Element and Prism Central, including importing Nutanix SSL certificates into the MID Server's Java keystore.
- Verify that the user account for discovery has read-only permissions on the required REST API endpoints for the Nutanix versions in use.
- For v4 API usage, Prism Central must be at least version 7.3, and the MID Server property must be set to enable v4 discovery.
- Create serverless discovery schedules targeting Nutanix components via REST API.
- Run VMware probe discovery first if linking Nutanix components to ESX clusters is needed.
- Optionally disable CI tag discovery to improve discovery performance in environments with numerous tags.
- Enable Nutanix event discovery scheduled jobs to activate VM and host state change detection for automatic rediscovery.
Data Collected and CMDB Impact
Discovery populates detailed CI records in the CMDB for the following Nutanix components:
- Controller VMs: Including name, UUID, memory, power state, hypervisor type, and descriptions.
- Clusters: Covering cluster name, IP addresses, version, subnets, timezone, hypervisor types, NTP servers, node count, and block serial numbers.
- Hosts: Capturing CPU details, RAM, and serial numbers (non-applicable in v4).
- Storage Pools and Containers: Including IDs, names, sizes, replication, deduplication, compression, and erasure code settings.
- Virtual Machine Instances: With CPU count, memory, state, and descriptive information.
- Prism Central Instances: Identified by name and object ID, linked by IP or DNS name depending on discovery method.
Differing details may be retrieved depending on the API version used.
CI Relationships
Discovery establishes extensive relationships between Nutanix CIs and other infrastructure components to accurately reflect environment topology. This includes:
- Clusters containing hosts and virtual machines.
- Hosts registering virtual machines.
- Storage pools containing storage containers.
- Server instances linked to Nutanix virtual machines.
- Management relations between Nutanix Prism Central and clusters.
- Special relationships to support AHV and ESX virtualization platforms, including VMware cluster integration when applicable.
Practical Benefits for ServiceNow Customers
- Automated and Accurate Discovery: Enables efficient mapping and management of Nutanix Acropolis infrastructure within ServiceNow CMDB, supporting IT operations and service management processes.
- Real-time Updates: Event-driven rediscovery keeps the CMDB aligned with actual
The ServiceNow Discovery application uses the Nutanix Components pattern to find components of the Nutanix Acropolis solution containing Nutanix Prism Central version 2024.3.1.8 or Nutanix Prism Element 7.0.1.6. Discovering some of these resources may require updating to the latest version of the Discovery and Service Mapping Patterns application from the ServiceNow Store.
The Nutanix Components pattern uses REST APIs to collect information about the Acropolis deployment components.
Starting with version 1.29.0, Discovery and Service Mapping Patterns supports Nutanix v4 discovery. When you switch to v4, Discovery creates new pool and container records, while existing records stop being updated.
Request apps on the Store
Visit the ServiceNow Store to view all the available apps, and for information about submitting requests to the store. For cumulative release notes information for all released apps, see the ServiceNow Store version history release notes.
Nutanix events
The Nutanix VM Event pattern finds events for virtual machines (VMs) in the Nutanix deployment and triggers rediscovery when a state change is detected. Starting with Discovery and Service Mapping Patterns version 1.31.0, the VM Event pattern also supports API v4, and the Nutanix Host Event pattern detects state changes for Nutanix hosts using API v4. Both patterns run every five minutes by default, but are inactive until you enable the relevant scheduled job.
| Pattern | CI | API version |
|---|---|---|
| Nutanix VM Event | Nutanix Virtual Machine Instance [cmdb_ci_nutanix_vm_instance] | v1–3 and v4 |
| Nutanix Host Event | Nutanix Host [cmdb_ci_nutanix_host] | v4 only |
Prerequisites
- Verify that the following applications are up to date
-
- Discovery and Service Mapping Patterns
- Visibility Content
- CMDB CI Class Models
- Verify MID Server requirements
- Deploy and connect a dedicated MID Server with network access to Prism Element and Prism Central.
- Install Nutanix end-point SSL certificates for the MID Server JRE
-
- Collect the certificates by browsing the Nutanix Prism console on Internet Explorer.
- Add SSL certificates for the MID Server, as described in Add SSL certificates for the MID Server.
- Use the following JRE keytool command to import the SSL certificates in the MID Server's keystore:
<MID Installation>/jre/bin/keytool -import -v -keystore <MID Installation>jre/lib/security/cacerts.If you must enter a password, enter a custom password or the default password - "changeit".
- Install Nutanix end-point SSL certificates for the MID Server JRE.
- Verify API permissions for v1-3
- Verify that the user has read-only access to the following API requests:
- /PrismGateway/services/rest/v1/vms
- /PrismGateway/services/rest/v1/storage_pools
- /PrismGateway/services/rest/v2.0/tasks/list
- /PrismGateway/services/rest/v2.0/hosts
- /PrismGateway/services/rest/v2.0/clusters
- /PrismGateway/services/rest/v2.0/vms
- /PrismGateway/services/rest/v2.0/storage_containers
- /api/nutanix/v3/clusters/list
- /api/nutanix/v3/categories/list
- /api/nutanix/v3/categories/{category_keys}/list
- /api/nutanix/v3/category/query
- Verify API permissions for v4
- Verify that the user has read-only access to the following GET APIs. Note that the API call referencing
/PrismGateway/services/rest/v1/vmsuses a legacy endpoint because it's not available yet in the newer API./api/clustermgmt/v4/config/clusters/api/clustermgmt/v4/config/clusters/{clusters_ID}/hosts/api/clustermgmt/v4/config/storage-containers/api/vmm/v4/ahv/config/vms/PrismGateway/services/rest/v1/vms/api/prism/v4/config/categories?$expand=associations/api/prism/v4/config/categories/{categories_ID}?$limit=extId&$expand=detailedAssociations
- Verify Prism Central version for v4 API
- Ensure that Prism Central is at least version 7.3 to use the v4 API.
- Set MID Server property to discover v4
- Enable Nutanix v4 discovery by setting the MID Server property value to the exact v4 version. For more information, see Enable Nutanix v4 discovery.
- Configure basic authentication credentials
- For more information, see Basic authentication credentials.
- Create a serverless discovery schedule
- Create a discovery schedule to perform targeted discovery of Nutanix components. For more information, see Create a serverless schedule for Nutanix Acropolis discovery.
- Link Nutanix components to ESX clusters
- The Nutanix Components pattern can discover Nutanix components hosted on ESX clusters, like storage pools, storage containers, and Controller Virtual Machine (CVM), but not ESX clusters themselves. Run VMware probe discovery before the Nutanix pattern discovery to link the Nutanix components to their ESX clusters. If you don't, the Nutanix components are linked to Nutanix Prism instead. For more information on VMware probe discovery, see Discovery for VMware virtualization.
- (Optional) Disable CI tag discovery
- The Nutanix Components pattern discovers tags for Nutanix hosts and virtual machines. If you have dozens of tags in your deployment, it might slow down the discovery causing performance issues. You can disable the CI tag discovery by performing the
following steps:
- Navigate to .
- Select the Nutanix Components pattern.
- Under Extension Section, select the check box for Categories (Tags) and select Remove.
- Select Save.
- Adjust the batch size for removing redundant relationship data
- The sn_itom_pattern.nutanix_relations_deletion_batch_size property sets the batch size for deleting relations between Nutanix Virtual Machine Instance and Nutanix Host. The default value is 1000; you can adjust this batch size as needed.
- Configure Nutanix events
-
- Verify that Nutanix Components discovery has run and that the Nutanix Prism Central [cmdb_ci_nutanix_prism_central] table is populated.
- Verify that the MID Servers for Nutanix event discovery have All or Nutanix capability.
- Enable the event discovery scheduled job. For more information, see Enable Nutanix event discovery.
Data collected by Discovery during horizontal discovery
Discovery populates the data in the CMDB when running the Nutanix Components pattern.
| Field | Description |
|---|---|
| Name [name] | The name of the Nutanix Controller VM. |
| VM ID [vm_id] | The universally unique identifier (UUID) of the Nutanix Controller VM. |
| Object ID [object_id] | The ID of the Nutanix Controller VM. |
| Memory (MB) [memory] | The memory size of the Nutanix Controller VM in Megabytes (MB). |
| State [state] | The power state of the Nutanix Controller VM (on/off). |
| Hypervisor Type [hypervisor_type] | The type of the hypervisor used for the Nutanix Controller VM. |
| Description [short_description] | The description defined for the virtual machine in the Nutanix console: Prism Central or Prism Element. |
| Field | Description |
|---|---|
| Name [name] | The name of the Nutanix Cluster. |
| IP Address [ip_address] | The IP address of the Nutanix Cluster. |
| Cluster ID [cluster_id] | The ID of the Nutanix Cluster. |
| Object ID [object_id] | The object ID of the Nutanix Cluster. |
| Version [version] | The Nutanix Cluster version. |
| Full Version [full_version] | The full version of the Nutanix Cluster. |
| Internal Subnet [internal_subnet] | The subnet of the internal IP address of the Nutanix Cluster. |
| External Subnet [external_subnet] | The subnet of the external IP address of the Nutanix Cluster. |
| Timezone [timezone] | The time zone of the Nutanix Cluster. |
| Hypervisor Types [hypervisor_types] | The type of the hypervisor used for the Nutanix Cluster. |
| NTP Servers [ntp_servers] | The Network Time Protocol (NTP) servers that are related to the Nutanix Cluster. |
| Number of Nodes [num_nodes] | The number of nodes connected to the Nutanix Cluster. |
| NCC Version [ncc_version] | The Nutanix Cluster Check (NCC) version. |
| Block Serial Numbers [block_serial_numbers] | The serial numbers of blocks of data connected to the Nutanix Cluster. |
| Field | Description |
|---|---|
| Name [name] | The name of the Nutanix host. |
| Object ID [object_id] | The ID of the Nutanix host. |
| CPU core count [cpu_core_count] | The number of Nutanix host cores. |
| CPU core thread [cpu_core_thread] | The number of threads of the Nutanix host. |
| CPU speed (MHz) [cpu_speed] | The CPU speed of the Nutanix host in MHz. |
| CPU count [cpu_count] | The number of CPU sockets of the Nutanix host. |
| RAM (MB) [ram] | The memory of the host in Megabites (MB). |
| Serial number [serial_number] | Serial number of the Nutanix host. This field is not applicable for v4. |
| Field | Description |
|---|---|
| Name [name] |
|
| Pool ID [pool_id] |
|
| Object ID [object_id] |
|
| Size [size] | The size of the Nutanix storage pool. This field is not applicable for v4. |
| Field | Description |
|---|---|
| Object ID [object_id] | The ID of the Nutanix container. |
| Container ID [container_id] | The UUID of the Nutanix container. |
| Name [name] | The name of the Nutanix container. |
| Replication Factor [replication_factor] | The number of copies created for the data stored on this Nutanix storage container. |
| Deduplication [deduplication] | The deduplication is enabled or disabled for the Nutanix container. |
| Compression [compression] | The compression is enabled or disabled for the Nutanix container. |
| Erasure Code [erasure_code] | The erasure of code is enabled or disabled for the Nutanix container. |
| Size [size] | The Nutanix container size calculated dynamically during discovery. |
| Field | Description |
|---|---|
| Name [name] | The name of the Nutanix Controller VM. |
| VM Instance ID [vm_inst_id] | The universally unique identifier (UUID) of the Nutanix Controller VM. |
| Object ID [object_id] | The ID of the Nutanix Controller VM. |
| CPUs [cpus] | The number of CPUs that the VM has. |
| Memory (MB) [memory] | The memory size of the Nutanix Controller VM in Megabytes (MB). |
| State [state] | The power state of the Nutanix Controller VM (on/off). |
| Description [short_description] | The description defined for the virtual machine in the Nutanix console: Prism Central or Prism Element. |
| Field | Description |
|---|---|
| Name [name] | The name of the Nutanix Prism Central multi-cluster manager.
|
| Object ID [object_id] | The ID of the Nutanix Prism Central. This field has the same value as the Name field.
|
CI relationships
These relationships are created to support all Nutanix discovery, regardless of hypervisor.
| CI | Relationship | CI |
|---|---|---|
| Nutanix Cluster [cmdb_ci_nutanix_cluster] | Members::Member of | Nutanix Host [cmdb_ci_nutanix_host] |
| Nutanix Virtual Machine Instance [cmdb_ci_nutanix_vm_instance] | Registered::Has registered | Nutanix Host [cmdb_ci_nutanix_host] |
| Nutanix Virtual Machine Instance [cmdb_ci_nutanix_vm_instance] | Hosted on::Hosts | Nutanix Cluster [cmdb_ci_nutanix_cluster] |
| Nutanix Storage Pool [cmdb_ci_nutanix_storage_pool] | Contains::Contained by | Nutanix Storage Container [cmdb_ci_nutanix_storage_container] |
| Servers [cmdb_ci_server] | Instantiates::Instantiated by | Nutanix Virtual Machine Instance [cmdb_ci_nutanix_vm_instance] |
| Nutanix Cluster [cmdb_ci_nutanix_cluster] | Managed by::Manages | Nutanix Prism Central [cmdb_ci_nutanix_prism_central] |
These relationships are created to support Nutanix discovery for components hosted on AHV clusters.
| CI | Relationship | CI |
|---|---|---|
| Nutanix Controller VM [cmdb_ci_nutanix_controller_vm] | Runs on::Runs | Nutanix Virtual Machine Instance [cmdb_ci_nutanix_vm_instance] |
| Nutanix Cluster [cmdb_ci_nutanix_cluster] | Defines resources for::Gets resources from | Nutanix Storage Pool [cmdb_ci_nutanix_storage_pool] |
These relationships are created to support Nutanix discovery for components hosted on ESX clusters if you ran a VMware discovery.
| CI | Relationship | CI |
|---|---|---|
| Nutanix Controller VM [cmdb_ci_nutanix_controller_vm] | Runs on::Runs | VMware Virtual Machine Instance [cmdb_ci_vmware_instance] |
| VMware Cluster [cmdb_ci_vmware_cluster] | Defines resources for::Gets resources from | Nutanix Storage Pool [cmdb_ci_nutanix_storage_pool] |
These relationships are created to support Nutanix discovery for components hosted on ESX clusters if you didn't run a VMware discovery.
| CI | Relationship | CI |
|---|---|---|
| Nutanix Controller VM [cmdb_ci_nutanix_controller_vm] | Hosted on::Hosts | Nutanix Prism Central [cmdb_ci_nutanix_prism_central] |
| Nutanix Storage Pool [cmdb_ci_nutanix_storage_pool] | Hosted on::Hosts | Nutanix Prism Central [cmdb_ci_nutanix_prism_central] |
Tag discovery
The Nutanix Components pattern collects tags and populates them in the Key Value [cmdb_key_value] table.
| Field | Description |
|---|---|
| Key [key] | The category key. |
| Value [value] | The category value. |
| Configuration item [configuration_item] | References the Nutanix Host [cmdb_ci_nutanix_host] table. |
Dashboard
The dashboard contains reports that query the Configuration Management Database (CMDB) and display the results. The information is displayed only after the pattern has discovered the infrastructure.
To display the dashboard, navigate to .
After upgrading to Discovery Admin Workspace version 1.3.1 (August 2024 Store), you can navigate to and use the enhanced dashboard.