Nutanix Hypervisor

Nutanix Hypervisor abstracts and isolates the VMs and their programs from the underlying server hardware, enabling a
more efficient use of physical resources, simpler maintenance and operations, and reduced costs. This integration was
integrated and tested with version v2 of Nutanix.

Configure Nutanix Hypervisor on Cortex XSOAR

1. Navigate to Settings > Integrations > Servers & Services.
2. Search for Nutanix Hypervisor.

3. Click Add instance to create and configure a new integration instance.

   Parameter	Description	Required
   Server URL	(e.g., https://192.168.0.1:57261)	True
   Fetch incidents		False
   Incident type		False
   Username		True
   Incidents Fetch Interval		False
   Maximum number of incidents per fetch	The maximum number of incidents to fetch each time.	False
   Alert Status Filters	Fetches incidents by the status filters given. For example, if acknowledged is true, then only alerts that have been acknowledged will be fetched. If ‘Auto Resolved’ or ‘Not Auto Resolved’ is selected, then by default also ‘Resolved’ will be set.	False
   Alert type IDs	Comma-separated list of alert type IDs. Fetches alerts whose type ID matches an alert_type_id in the alert_type_ids list. For example, alert ‘Alert E-mail Failure’ has type ID A111066. If alert_type_ids = ‘A111066’, only alerts of ‘Alert E-mail Failure’ will be displayed.	False
   Impact Types	Comma-separated list of impact types. Fetch alerts whose impact type matches an impact type in Impact Types list. For example, alert ‘Incorrect NTP Configuration’ has impact type ‘SystemIndicator’. If Impact Types = ‘SystemIndicator’, only alerts with impact type ‘SystemIndicator’, such as ‘Incorrect NTP Configuration’ will be displayed.	False
   First fetch timestamp	format: <number> <time unit>, e.g., 12 hours, 7 days.	False
   Trust any certificate (not secure)		False
   Use system proxy settings		False

4. Click Test to validate the URLs, token, and connection.

Available Alert Type IDs, Impact Types, and Entity Types

Alert Policies contains the list of all possible alerts in the system,
and their ID, impact type, and entity type. In order to check the optional values for these entities:

1. Go to your Nutanix UI and navigate to the Alerts screen. (Can be found under the second tab in the top left corner, see image below)
2. Navigate to the Alert Policies tab on the left sidebar.
   You should see the following screen:
   

• ID is the alert type ID filter parameter for fetching alerts, or the argument for the nutanix-hypervisor-alerts-list command.
• Impact Type is the impact type filter parameter for fetching alerts, or the argument for the nutanix-hypervisor-alerts-list command.

Permissions

The following commands require cluster admin or higher permissions.
(Found in Nutanix Settings in the Users And Roles category.)

• nutanix-hypervisor-vm-powerstatus-change
• nutanix-hypervisor-alert-acknowledge
• nutanix-hypervisor-alert-resolve
• nutanix-hypervisor-alerts-acknowledge-by-filter
• nutanix-hypervisor-alerts-resolve-by-filter

Commands

You can execute these commands from the Cortex XSOAR CLI, as part of an automation, or in a playbook.
After you successfully execute a command, a DBot message appears in the War Room with the command details.

nutanix-hypervisor-hosts-list

Gets the list of physical hosts configured in the cluster.

Base Command

nutanix-hypervisor-hosts-list

Input

Context Output

Command Example

!nutanix-hypervisor-hosts-list filter="num_vms==2" limit=3 page=1

Context Example

{
    "NutanixHypervisor": {
        "Host": {
            "boot_time": "2020-11-22T14:13:52.399817+00:00",
            "boot_time_in_usecs": 1606054432399817,
            "cluster_uuid": "asra1631-a234-zxd1-aa23-azxr124z23aq",
            "controller_vm_backplane_ip": "192.168.1.111",
            "cpu_model": "Intel(R) Xeon(R) Silver 4216 CPU @ 2.10GHz",
            "has_csr": false,
            "host_type": "HYPER_CONVERGED",
            "hypervisor_address": "192.168.1.111",
            "hypervisor_full_name": "Nutanix 20190916.321",
            "hypervisor_key": "192.168.1.111",
            "hypervisor_type": "kKvm",
            "hypervisor_username": "root",
            "is_degraded": false,
            "is_hardware_virtualized": false,
            "is_secure_booted": false,
            "management_server_name": "192.168.1.111",
            "monitored": true,
            "name": "NTNX-386a5fb4-A",
            "num_cpu_cores": 8,
            "num_cpu_sockets": 2,
            "num_cpu_threads": 8,
            "num_vms": 2,
            "reboot_pending": false,
            "serial": "59bc015e-a22d-41ab-9ce2-a96164955e9q",
            "service_vmexternal_ip": "192.168.1.111",
            "service_vmid": "asra1631-a234-zxd1-aa23-azxr124z23aq::2",
            "state": "NORMAL",
            "uuid": "59bc015e-a22d-41ab-9ce2-a96164955e9q",
            "vzone_name": ""
        }
    }
}

Human Readable Output

Nutanix Hosts List

is_hardware_virtualized	host_type	serial	boot_time	hypervisor_type	num_cpu_sockets	hypervisor_full_name	hypervisor_username	uuid	vzone_name	hypervisor_address	num_vms	is_secure_booted	management_server_name	monitored	is_degraded	state	num_cpu_cores	name	service_vmid	service_vmexternal_ip	reboot_pending	cluster_uuid	has_csr	hypervisor_key	cpu_model	num_cpu_threads	controller_vm_backplane_ip	boot_time_in_usecs
false	HYPER_CONVERGED	59bc015e-a22d-41ab-9ce2-a96164955e9q	2020-11-22T14:13:52.399817+00:00	kKvm	2	Nutanix 20190916.321	root	59bc015e-a22d-41ab-9ce2-a96164955e9q		192.168.1.111	2	false	192.168.1.111	true	false	NORMAL	8	NTNX-386a5fb4-A	asra1631-a234-zxd1-aa23-azxr124z23aq::2	192.168.1.111	false	asra1631-a234-zxd1-aa23-azxr124z23aq	false	192.168.1.111	Intel(R) Xeon(R) Silver 4216 CPU @ 2.10GHz	8	192.168.1.111	1606054432399817

nutanix-hypervisor-vms-list

Gets a list of virtual machines.

Base Command

nutanix-hypervisor-vms-list

Input

Context Output

Command Example

!nutanix-hypervisor-vms-list filter="machine_type==pc,power_state!=off" length=3 offset=0

Context Example

{
    "NutanixHypervisor": {
        "VM": {
            "affinity": {
                "host_uuids": [
                    "59bc015e-a22d-41ab-9ce2-a96164955e9q"
                ],
                "policy": "AFFINITY"
            },
            "allow_live_migrate": false,
            "boot": {
                "uefi_boot": false
            },
            "gpus_assigned": false,
            "ha_priority": 0,
            "host_uuid": "59bc015e-a22d-41ab-9ce2-a96164955e9q",
            "machine_type": "pc",
            "memory_mb": 4096,
            "name": "CentOS7_Test",
            "num_cores_per_vcpu": 2,
            "num_vcpus": 2,
            "power_state": "on",
            "timezone": "UTC",
            "uuid": "16c3d845-dc54-4fb1-bfc8-7671dd230967",
            "vm_features": {
                "AGENT_VM": false,
                "VGA_CONSOLE": true
            },
            "vm_logical_timestamp": 243
        }
    }
}

Human Readable Output

Nutanix Virtual Machines List

timezone	allow_live_migrate	name	ha_priority	machine_type	memory_mb	uuid	power_state	num_cores_per_vcpu	vm_logical_timestamp	gpus_assigned	host_uuid	num_vcpus
UTC	false	CentOS7_Test	0	pc	4096	16c3d845-dc54-4fb1-bfc8-7671dd230967	on	2	243	false	59bc015e-a22d-41ab-9ce2-a96164955e9q	2

nutanix-hypervisor-vm-powerstatus-change

Sets the power state of a virtual machine. If the virtual machine is being powered on and no host is specified, the host with
the most available CPU and memory will be chosen. Note that such a host may not be available. If the virtual machine is
being power cycled, a different host can be specified to start it on. The command returns a task UUID that can be
monitored by the nutanix-hypervisor-task-results-get command.

Base Command

nutanix-hypervisor-vm-powerstatus-change

Input

Context Output

Command Example

!nutanix-hypervisor-vm-powerstatus-change vm_uuid=16c3d845-dc54-4fb1-bfc8-7671dd230967 transition=ON

Context Example

{
    "NutanixHypervisor": {
        "VMPowerStatus": {
            "task_uuid": "7f522fb2-1b19-491a-ab49-763f48be8712"
        }
    }
}

Human Readable Output

Results

task_uuid
7f522fb2-1b19-491a-ab49-763f48be8712

nutanix-hypervisor-task-results-get

Returns the results of given tasks. If a task is not ready, its status will be returned.

Base Command

nutanix-hypervisor-task-results-get

Input

Context Output

Command Example

!nutanix-hypervisor-task-results-get task_ids=072f64d8-c737-4230-a1ec-199b449b9795

Context Example

{
    "NutanixHypervisor": {
        "Task": {
            "cluster_uuid": "asra1631-a234-zxd1-aa23-azxr124z23aq",
            "complete_time": "2021-02-03T15:51:26.579757+00:00",
            "complete_time_usecs": 1612367486579757,
            "create_time": "2021-02-03T15:51:26.346257+00:00",
            "create_time_usecs": 1612367486346257,
            "entity_list": [
                {
                    "entity_id": "16c3d845-dc54-4fb1-bfc8-7671dd230967",
                    "entity_type": "VM"
                }
            ],
            "last_updated": "2021-02-03T15:51:26.579757+00:00",
            "last_updated_time_usecs": 1612367486579757,
            "message": "",
            "meta_request": {
                "method_name": "VmChangePowerState"
            },
            "meta_response": {
              "error_code": 0
            },
            "operation_type": "VmChangePowerState",
            "percentage_complete": 100,
            "progress_status": "Succeeded",
            "start_time": "2021-02-03T15:51:26.376685+00:00",
            "start_time_usecs": 1612367486376685,
            "subtask_uuid_list": [
                "6f90a15d-ad76-4782-89bd-80811f162543"
            ],
            "uuid": "072f64d8-c737-4230-a1ec-199b449b9795"
        }
    }
}

Human Readable Output

Nutanix Hypervisor Tasks Status

cluster_uuid	complete_time	complete_time_usecs	create_time	create_time_usecs	entity_list	last_updated	last_updated_time_usecs	message	meta_request	meta_response	operation_type	percentage_complete	progress_status	start_time	start_time_usecs	subtask_uuid_list	uuid
asra1631-a234-zxd1-aa23-azxr124z23aq	2021-02-03T15:51:26.579757+00:00	1612367486579757	2021-02-03T15:51:26.346257+00:00	1612367486346257	{‘entity_id’: ‘16c3d845-dc54-4fb1-bfc8-7671dd230967’, ‘entity_type’: ‘VM’}	2021-02-03T15:51:26.579757+00:00	1612367486579757		method_name: VmChangePowerState	error_code: 17 error_detail: Cannot complete request in state InvalidVmState: Cannot complete request in state On	VmChangePowerState	100	Failed	2021-02-03T15:51:26.376685+00:00	1612367486376685	6f90a15d-ad76-4782-89bd-80811f162543	072f64d8-c737-4230-a1ec-199b449b9795

nutanix-hypervisor-alerts-list

Gets the list of alerts generated in the cluster that matches the filters. Nutanix fetches the latest alerts created if there are more than the defined maximum number of alerts.

Base Command

nutanix-hypervisor-alerts-list

Input

Context Output

Command Example

!nutanix-hypervisor-alerts-list acknowledged=true auto_resolved=true resolved=true start_time=2018-12-31T21:34:54 limit=4

Context Example

{
    "NutanixHypervisor": {
        "Alerts": [
            {
                "acknowledged": true,
                "acknowledged_by_username": "N/A",
                "acknowledged_time": "2020-11-25T15:28:02.804764+00:00",
                "acknowledged_time_stamp_in_usecs": 1606318082804764,
                "affected_entities": [
                    {
                        "entity_type": "host",
                        "id": "2",
                        "uuid": "59bc015e-a22d-41ab-9ce2-a96164955e9q"
                    }
                ],
                "alert_title": "{vm_type} time not synchronized with any external servers.",
                "alert_type_uuid": "A3026",
                "auto_resolved": true,
                "check_id": "asra1631-a234-zxd1-aa23-azxr124z23aq::3026",
                "classifications": [
                    "ControllerVM"
                ],
                "cluster_uuid": "asra1631-a234-zxd1-aa23-azxr124z23aq",
                "created_time": "2020-11-22T14:31:14.675609+00:00",
                "created_time_stamp_in_usecs": 1606055474675609,
                "detailed_message": "",
                "id": "4b12dc84-2a77-4b3a-a40a-2dc47c919caa",
                "impact_types": [
                    "Configuration"
                ],
                "last_occurrence": "2020-11-22T14:31:14.675609+00:00",
                "last_occurrence_time_stamp_in_usecs": 1606055474675609,
                "message": "The {vm_type} is not synchronizing time with any external servers. {alert_msg}",
                "node_uuid": "59bc015e-a22d-41ab-9ce2-a96164955e9q",
                "operation_type": "kCreate",
                "originating_cluster_uuid": "asra1631-a234-zxd1-aa23-azxr124z23aq",
                "resolved": true,
                "resolved_by_username": "N/A",
                "resolved_time": "2020-11-25T15:28:02.804758+00:00",
                "resolved_time_stamp_in_usecs": 1606318082804758,
                "service_vmid": "asra1631-a234-zxd1-aa23-azxr124z23aq::2",
                "severity": "kWarning",
                "user_defined": false
            },
            {
                "acknowledged": true,
                "acknowledged_by_username": "N/A",
                "acknowledged_time": "2020-11-25T15:28:02.851718+00:00",
                "acknowledged_time_stamp_in_usecs": 1606318082851718,
                "affected_entities": [
                    {
                        "entity_type": "host",
                        "id": "2",
                        "uuid": "59bc015e-a22d-41ab-9ce2-a96164955e9q"
                    }
                ],
                "alert_title": "Incorrect NTP Configuration",
                "alert_type_uuid": "A103076",
                "auto_resolved": true,
                "check_id": "asra1631-a234-zxd1-aa23-azxr124z23aq::103076",
                "classifications": [
                    "Cluster"
                ],
                "cluster_uuid": "asra1631-a234-zxd1-aa23-azxr124z23aq",
                "created_time": "2020-11-22T14:31:14.619018+00:00",
                "created_time_stamp_in_usecs": 1606055474619018,
                "detailed_message": "",
                "id": "1c63dcd9-3b36-45a6-8991-d28cc661c861",
                "impact_types": [
                    "SystemIndicator"
                ],
                "last_occurrence": "2020-11-22T14:31:14.619018+00:00",
                "last_occurrence_time_stamp_in_usecs": 1606055474619018,
                "message": "{alert_msg}",
                "node_uuid": "59bc015e-a22d-41ab-9ce2-a96164955e9q",
                "operation_type": "kCreate",
                "originating_cluster_uuid": "asra1631-a234-zxd1-aa23-azxr124z23aq",
                "resolved": true,
                "resolved_by_username": "N/A",
                "resolved_time": "2020-11-25T15:28:02.851706+00:00",
                "resolved_time_stamp_in_usecs": 1606318082851706,
                "service_vmid": "asra1631-a234-zxd1-aa23-azxr124z23aq::2",
                "severity": "kWarning",
                "user_defined": false
            }
        ]
    }
}

Human Readable Output

Nutanix Alert List

impact_types	created_time_stamp_in_usecs	created_time	severity	acknowledged_time_stamp_in_usecs	resolved	acknowledged_by_username	resolved_by_username	last_occurrence_time_stamp_in_usecs	acknowledged_time	check_id	alert_title	service_vmid	id	classifications	acknowledged	resolved_time	last_occurrence	alert_type_uuid	detailed_message	operation_type	originating_cluster_uuid	message	node_uuid	user_defined	cluster_uuid	auto_resolved	resolved_time_stamp_in_usecs
Configuration	1606055474675609	2020-11-22T14:31:14.675609+00:00	kWarning	1606318082804764	true	N/A	N/A	1606055474675609	2020-11-25T15:28:02.804764+00:00	asra1631-a234-zxd1-aa23-azxr124z23aq::3026	{vm_type} time not synchronized with any external servers.	asra1631-a234-zxd1-aa23-azxr124z23aq::2	4b12dc84-2a77-4b3a-a40a-2dc47c919caa	ControllerVM	true	2020-11-25T15:28:02.804758+00:00	2020-11-22T14:31:14.675609+00:00	A3026		kCreate	asra1631-a234-zxd1-aa23-azxr124z23aq	The {vm_type} is not synchronizing time with any external servers. {alert_msg}	59bc015e-a22d-41ab-9ce2-a96164955e9q	false	asra1631-a234-zxd1-aa23-azxr124z23aq	true	1606318082804758
SystemIndicator	1606055474619018	2020-11-22T14:31:14.619018+00:00	kWarning	1606318082851718	true	N/A	N/A	1606055474619018	2020-11-25T15:28:02.851718+00:00	asra1631-a234-zxd1-aa23-azxr124z23aq::103076	Incorrect NTP Configuration	asra1631-a234-zxd1-aa23-azxr124z23aq::2	1c63dcd9-3b36-45a6-8991-d28cc661c861	Cluster	true	2020-11-25T15:28:02.851706+00:00	2020-11-22T14:31:14.619018+00:00	A103076		kCreate	asra1631-a234-zxd1-aa23-azxr124z23aq	{alert_msg}	59bc015e-a22d-41ab-9ce2-a96164955e9q	false	asra1631-a234-zxd1-aa23-azxr124z23aq	true	1606318082851706

nutanix-hypervisor-alert-acknowledge

Acknowledges the alert with the specified alert_id.

Base Command

nutanix-hypervisor-alert-acknowledge

Input

Context Output

Command Example

!nutanix-hypervisor-alert-acknowledge alert_id=da53aaa3-8c29-4b68-9f27-e0927ca694ce

Context Example

{
    "NutanixHypervisor": {
        "AcknowledgedAlerts": {
            "id": "da53aaa3-8c29-4b68-9f27-e0927ca694ce",
            "message": null,
            "successful": true
        }
    }
}

Human Readable Output

Results

id	message	successful
da53aaa3-8c29-4b68-9f27-e0927ca694ce		true

nutanix-hypervisor-alert-resolve

Resolves the alert with the specified alert_id. Alert ID is the ‘id’ field returned for alerts by command ‘nutanix-hypervisor-alerts-list’

Base Command

nutanix-hypervisor-alert-resolve

Input

Context Output

Command Example

!nutanix-hypervisor-alert-resolve alert_id=da53aaa3-8c29-4b68-9f27-e0927ca694ce

Context Example

{
    "NutanixHypervisor": {
        "ResolvedAlerts": {
            "id": "da53aaa3-8c29-4b68-9f27-e0927ca694ce",
            "message": null,
            "successful": true
        }
    }
}

Human Readable Output

Results

id	message	successful
da53aaa3-8c29-4b68-9f27-e0927ca694ce		true

nutanix-hypervisor-alerts-acknowledge-by-filter

Acknowledges alerts using a filter.

Base Command

nutanix-hypervisor-alerts-acknowledge-by-filter

Input

Context Output

Command Example

!nutanix-hypervisor-alerts-acknowledge-by-filter end_time=2021-12-22T13:14:15 entity_types=Host severity=WARNING

Context Example

{
    "NutanixHypervisor": {
        "AcknowledgedFilterAlerts": {
            "num_failed_updates": 0,
            "num_successful_updates": 0
        }
    }
}

Human Readable Output

Results

num_failed_updates	num_successful_updates
0	0

nutanix-hypervisor-alerts-resolve-by-filter

Resolves alerts using a filter.

Base Command

nutanix-hypervisor-alerts-resolve-by-filter

Input

Context Output

Command Example

!nutanix-hypervisor-alerts-resolve-by-filter limit=2 impact_types=SystemIndicator entity_types=VM

Context Example

{
    "NutanixHypervisor": {
        "ResolvedFilterAlerts": {
            "num_failed_updates": 0,
            "num_successful_updates": 0
        }
    }
}

Human Readable Output

Results

num_failed_updates	num_successful_updates
0	0