Search Knowledge Base by Keyword

Nutanix Prism – Legacy

< Back

Overview

Nutanix Prism is the management plane for Nutanix hyperconverged infrastructure: clusters of physical nodes whose local storage is pooled and served back to virtual machines, usually on Nutanix’s AHV hypervisor. This connector covers the API generations that came before v4. The v2.0 API is scoped to a single cluster through Prism Element and answers plain GET calls such as /api/nutanix/v2.0/hosts. The v3 API is the Prism Central intentful API, where you POST to a /list endpoint with a kind in the body and receive an entities array back.

The connector authenticates with HTTP Basic against the API Domain you supply (the shipped default is the placeholder https://PRISM_FQDN_REPLACE:9440). Templates mix both generations: v2.0 GET calls for hosts, storage containers and clusters, and v3 POST list calls for clusters, projects, categories, VMs and subnets. Every template reads the entities node and writes to a prism_*_v2 or prism_*_v3 staging table, so the API generation a row came from is visible in the table name.

The value to the estate is the same as the current connector: cluster, host and VM inventory to resolve a workload down to the node carrying it, storage containers for the capacity picture, and subnets, categories and projects for the network, tagging and ownership model. What differs is the shape of the data, because the v2.0 and v3 payloads are structured differently from v4 and the resulting staging tables are not interchangeable.

The connector is bidirectional. One generic outbound template ships, a POST that sends a record key as JSON to an endpoint you configure. It ships disabled and has no endpoint set.

NOTE: Use this connector when your Prism and AHV versions do not expose the v4 APIs; use Nutanix Prism when they do. Both ship at the same connector version with the same Basic authentication form and the same job fields, and their staging tables are named differently, so you can run both against the same environment during an upgrade. The one exception is the projects job, which uses the same prism_projects_v3 table in both connectors.

NOTE: Every template in this connector, inbound and outbound, ships with Enabled set to No. Nothing runs until you choose which API generation your Prism supports and enable the matching jobs.

Connector Properties

Property Value
Identifier NUTANIX PRISM LEGACY
Name Nutanix Prism – Legacy
Description An Enterprise-Grade Control Plane for Unified Hybrid Cloud Management. This connector supports AHV versions that support up to API v3
Job Types Both Inbound and Outbound
Order 40
Enabled Yes
Locked Yes
Block Update No
Single Authentication No
Windows Only No
Connector Version 2026-07-27
Hooks None
Additional Job Fields None
Image

Authentication Methods

One authentication method ships. Both the v2.0 and the v3 APIs accept HTTP Basic credentials directly, so the same method covers every template.

Method Identifier Base Method Script Order Enabled Config Fields
Username / Password NUTANIX PRISM_RW_LEG JSON Rest API_user json_rest_api.php 10 Yes 5

NOTE: Certificate verification is disabled on both the authentication and data calls, which is what allows the connection to work against Prism’s default self-signed certificate.

NOTE: The API Domain default is the literal placeholder https://PRISM_FQDN_REPLACE:9440. Replace the host portion with your Prism FQDN; the :9440 port is correct.

Method 1: Username / Password (NUTANIX PRISM_RW_LEG)

Connect to a GET method API with a username / password

Sends an Authorization: Basic header built from the username and password on the connection, Base64 encoded at run time. Use a read-only Prism account. Note that the v2.0 templates address a single cluster through Prism Element while the v3 templates address Prism Central, so which endpoint you point the connection at determines which half of the template set will answer.

Connection Configuration Fields (5)

Order Label Type Required Default Max Len Tooltip
10 API Domain text Yes https://PRISM_FQDN_REPLACE:9440 255 Enter API domain of the Connection
30 Server Temporary Working Path text Yes storage/etl5 255 Enter path where temporary files are stored during data processing (exclude starting and ending backslash)
40 Username text Yes 1024 Enter username of the Connection
50 Password password Yes 64000 Enter password of the Connection
250 Additional Job Fields fields_list No [{"key":"prism","value":"REPLACE"}] Enter list of additional fields to add to staging data for all jobs

Authentication Configuration

Headers sent on the authentication call:

Header Value Base64
Content-Type: application/json Off
Authorization: Basic %user_name%:%user_pass% On

cURL options:

Option Authentication Call Data Calls
USERAGENT Mozilla/5.0 (Windows NT 6.1 Win64 x64 rv:47.0) Gecko/20100101 Firefox/47.0 Same
SSL_VERIFYHOST false Same
SSL_VERIFYPEER false Same
RETURNTRANSFER true Same
FOLLOWLOCATION true Same
FAILONERROR true Same
CONNECTTIMEOUT 10 Same

Inbound Job Fields Enabled (45)

The inbound job form exposes the standard REST job fields: endpoint, return data node, pagination, three levels of enumeration, and the staging table the response lands in.

Order Label Type Required Default Tooltip
10 Job Description text Yes Enter description of the Job
20 Job Schedule lookup Yes Daily Select frequency Job should run
30 Enabled radio Yes Yes Choose if Job is enabled
40 Use Unparsed Data radio No No Choose if you wish to parse the incoming data, or leave it in its raw format
50 Log Raw API Calls radio Yes No Choose if raw API calls are logged
70 Destination Table text Yes Enter name of the destination table
80 Data Identity text No Enter identity of the Job
110 Append Files to Same Destination Table radio No No Choose if multiple files in the same path will append to the same destination table, or will create a new destination table for each file
120 Append New Data to Existing Tables radio No No Choose if new data will append to the existing destination table, or will create a new destination table
130 Fields to Index text No Enter fields to index
170 Method Type select Yes GET Select method type of the Job
190 API End Point text No Enter API end point of the Job
200 API Data Parameters fields_list No Enter API data parameters of the Job
210 Body Data Sending Method select Yes JSON Encoded Data Select method for sending the body data
220 Raw JSON Body Data textarea No Enter the raw JSON body to send. Do not use body selections in the API Parameters if this is used.
230 API Return Data Node text No Enter API return data node of the Job
250 Pagination Type select No None Select request paging type of the Job
270 API Pagination Node text No Enter API pagination node of the Job
280 Pagination Offset Start text No Enter request paging offset start of the Job
290 Pagination Limit text No Enter request pagination limit of the Job
300 Pagination Termination Node text No Enter request paging termination node and value of the Job
310 Maximum API Calls text No Enter maximum number of API calls for the Job to make
320 Enumeration 1 Type select No None Enter enumeration level 1 type
330 Enumeration ETL Job lookup No Select ETL job for the enumeration values
340 Enumeration 1 Data Type data_type No Select the data type and fields for enumeration 1 values
350 Enumeration 1 Keys End Point text No Enter enumeration 1 keys end point of the Job
360 Enumeration 1 Node text No Enter enumeration 1 node of the Job
370 Enumeration 1 Fields fields_list No Enter enumeration 1 fields of the Job
380 Enumeration 2 Type select No None Enter enumeration level 2 type
390 Enumeration 2 ETL Job lookup No Select ETL job for the enumeration 2 values
400 Enumeration 2 Data Type data_type No Select the data type and fields for enumeration 2 values
410 Enumeration 2 Keys End Point text No Enter enumeration 2 keys end point of the Job
420 Enumeration 2 Node text No Enter enumeration 2 node of the Job
430 Enumeration 2 Fields fields_list No Enter enumeration 2 fields of the Job
440 Enumeration 3 Type select No None Enter enumeration level 3 type
450 Enumeration 3 ETL Job lookup No Select ETL job for the enumeration 3 values
460 Enumeration 3 Data Type data_type No Select the data type and fields for enumeration 3 values
470 Enumeration 3 Keys End Point text No Enter enumeration 3 keys end point of the Job
480 Enumeration 3 Node text No Enter enumeration 3 node of the Job
490 Enumeration 3 Fields fields_list No Enter enumeration 3 fields of the Job
500 Pause Enumeration text No Enter values for pausing enumeration every X calls for Y seconds
510 Kill Enumeration on Error radio No No Choose to stop the enumeration loop on an error or continue processing the loop
520 Additional Fields fields_list No Enter list of additional fields to add to staging data
550 Retry Pause text No Enter values for retrying a failed API connection. Retry X times, waiting Y seconds between each try, with an API timeout of Z seconds.
560 Order text Yes Enter order of the Job

Outbound Job Fields Enabled (13)

Order Label Type Required Default Tooltip
10 Job Description text Yes Enter description of the Job
30 Enabled radio Yes Yes Choose if Job is enabled
50 Log Raw API Calls radio Yes No Choose if raw API calls are logged
170 Method Type select Yes GET Select method type of the Job
180 Data Sending Method select Yes JSON Encoded Data Select method for sending the outbound data
190 API End Point text No Enter API end point of the Job
200 API Data Parameters fields_list No Enter API data parameters of the Job
210 Body Data Sending Method select Yes JSON Encoded Data Select method for sending the body data
260 Return Data Fields List fields_list Yes Enter return data fields of the Job
530 Outbound Fields List fields_list Yes Enter outbound fields of the Job
540 Ignore Empty Outbound Fields radio No Yes Ignore, and do not include, any outbound fields that are empty and have no data
550 Raw JSON Outbound Template textarea No Enter the raw JSON outbound template to send. This will replace any automated structures defined in the outbound fields.
560 Order text Yes Enter order of the Job

Inbound Job Templates (10)

Ten inbound templates ship, split between the v2.0 Prism Element API and the v3 Prism Central list API. All run Daily and all ship disabled. Pick the set that matches the endpoint your connection points at; the v2.0 and v3 jobs are alternative routes to overlapping data, not a set meant to be enabled all at once.

# Job Description Destination Table API End Point Enabled What It Pulls
1 GET Hosts prism_hosts_v2 /api/nutanix/v2.0/hosts No Physical node inventory from the v2.0 API: host name and uuid, hardware serial and block model, CPU and memory configuration, hypervisor type and version, controller VM and IPMI addresses, and disk counts per node.
2 GET Clusters V3 prism_clusters_v3 /api/nutanix/v3/clusters/list No The same cluster entities through the v3 Prism Central list API, returned in the v3 spec and status structure. Use this one when the connection points at Prism Central rather than a single cluster.
3 GET Projects V3 prism_projects_v3 /api/nutanix/v3/projects/list No Prism Central projects, with project name and uuid, owner, the subnets and resources allotted to each project and the quotas applied.
4 GET Categories v3 prism_categories_v3 /api/nutanix/v3/categories/list No The category keys defined in Prism Central, the tag names that category values hang off. This is the first half of the Nutanix tagging model; the values themselves come from GET Category Values v3.
5 GET Categories v3 ENUM 1 prism_categories_v3_enum_1 /api/nutanix/v3/categories/list No The same category key list as GET Categories v3, shipped separately as the key source for the GET Category Values v3 enumeration. It exists to produce the list of category names that the values job loops over.
6 GET Category Values v3 prism_category_values_v3 /api/nutanix/v3/categories/%enum_id_1%/list No The values defined under one category key, called once per key with the key name substituted into the path. Together with the categories job it gives you the full key and value tag set that Nutanix policies are written against.
7 GET Containers prism_containers_v2 /api/nutanix/v2.0/storage_containers No Storage containers from the v2.0 API, with replication factor, compression and deduplication settings, and the capacity and usage figures behind the workloads that sit on them.
8 GET VMs prism_vms_v3 /api/nutanix/v3/vms/list No Every virtual machine through the v3 list API, with name and uuid, power state, vCPU and memory allocation, disk and NIC configuration, and the host and cluster it runs on. The largest collection in the set, and the only one besides subnets that ships with pagination configured.
9 GET Subnets prism_subnets_v3 /api/nutanix/v3/subnets/list No Virtual subnets through the v3 list API, with name and uuid, VLAN identifier, IP address management configuration and the cluster each belongs to.
10 GET Clusters V2 prism_clusters_v2 /api/nutanix/v2.0/clusters No Cluster records from the v2.0 Prism Element API: cluster name and uuid, AOS version, node count, redundancy factor and the external and virtual IP addresses.

Job Template Configuration

Settings Common to All Ten Templates

Setting Value
Enabled No
Job Schedule Daily (15 1 * * *)
Allow Empty Table Yes
Append Files to Same Destination Table No
Append New Data to Existing Tables No
Use Unparsed Data No
Convert UUID-Keyed Objects to Rows No
Ignore XML Attributes No
Log Raw API Calls No
Body Data Sending Method JSON Encoded Data
API Return Data Node entities

Settings That Vary by Template

Template ID Order Destination Table Data Identity Method Type API End Point Pagination Type
GET Hosts 138 20 prism_hosts_v2 prism_hosts_v2 GET /api/nutanix/v2.0/hosts Not set
GET Clusters V3 143 30 prism_clusters_v3 prism_clusters_v3 POST /api/nutanix/v3/clusters/list Not set
GET Projects V3 145 30 prism_projects_v3 prism_projects_v3 POST /api/nutanix/v3/projects/list Not set
GET Categories v3 146 30 prism_categories_v3 prism_categories_v3 POST /api/nutanix/v3/categories/list Not set
GET Categories v3 ENUM 1 147 30 prism_categories_v3_enum_1 prism_categories_v3_enum_1 POST /api/nutanix/v3/categories/list Not set
GET Category Values v3 148 30 prism_category_values_v3 prism_category_values_v3 POST /api/nutanix/v3/categories/%enum_id_1%/list Not set
GET Containers 139 210 prism_containers_v2 prism_containers_v2 GET /api/nutanix/v2.0/storage_containers Not set
GET VMs 140 210 prism_vms_v3 prism_vms_v3 POST /api/nutanix/v3/vms/list Records
GET Subnets 141 220 prism_subnets_v3 prism_subnets_v3 POST /api/nutanix/v3/subnets/list Records
GET Clusters V2 142 230 prism_clusters_v2 prism_clusters_v2 GET /api/nutanix/v2.0/clusters Pages

Settings That Vary by Template (continued)

Template ID Pagination Limit Pagination Offset Start Pagination Termination Node
GET Hosts 138 Not set Not set Not set
GET Clusters V3 143 Not set Not set Not set
GET Projects V3 145 Not set Not set Not set
GET Categories v3 146 Not set Not set Not set
GET Categories v3 ENUM 1 147 Not set Not set Not set
GET Category Values v3 148 Not set Not set Not set
GET Containers 139 Not set Not set Not set
GET VMs 140 10 0 metadata.length=0
GET Subnets 141 10 0 metadata.length=0
GET Clusters V2 142 10 1 metadata.start_index<=0

Job Parameters and Enumeration

GET Clusters V3

API data parameters:

Key Value In Body
kind cluster on

GET Projects V3

API data parameters:

Key Value In Body
kind project on

GET Categories v3

API data parameters:

Key Value In Body
kind category on

GET Categories v3 ENUM 1

API data parameters:

Key Value In Body
kind category on

GET Category Values v3

API data parameters:

Key Value In Body
kind category on

Enumeration 1 fields:

Name Value
enum_id_1 name

GET VMs

API data parameters:

Key Value Type In Body
kind vm String on
offset %pagination_offset% Numeric on
length %pagination_limit% Numeric on

GET Subnets

API data parameters:

Key Value Type In Body
kind subnet String on
offset %pagination_offset% Numeric on
length %pagination_limit% Numeric on

GET Clusters V2

API data parameters:

Key Value Type
page %pagination_offset% Numeric
count 10 Numeric

Outbound Job Templates (1)

One generic outbound template ships, disabled. It is a starting point for pushing a ReadyWorks record to an API, not a Nutanix action.

# Job Description Method API End Point Enabled What It Does
1 Rest POST API POST Not set No Posts a single field, Record Key, as a JSON body to whatever endpoint you configure, and reads a status, a message and an echoed record key back out of the response. The endpoint is empty as shipped.

Job Template Configuration

Settings

Setting Value
Order 10
Enabled No
Log Raw API Calls No
Method Type POST
Body Data Sending Method JSON Encoded Data
Data Sending Method JSON Encoded Data
Ignore Empty Outbound Fields Yes

Job Parameters and Enumeration

Rest POST API

Outbound fields list:

Label Name Type Required Pattern
Record Key record_key String on

Return data fields:

Label Name
Return Status status
Return Message message
Record Key data.record_key
Tags: