Update Virtual Machine
Updates the properties of an existing VM.
External Documentation
To learn more, visit the Nutanix Hypervisor documentation.
Parameters
| Parameter | Description |
|---|---|
| Metadata | The VM metadata. Please refer to Nutanix Hypervisor Documentation for more information regarding the metadata structure. For example: <br/>{<br/> "use_categories_mapping": false,<br/> "uuid": "string",<br/> "project_reference": {<br/> "uuid": "string"<br/> },<br/> "spec_version": 0,<br/> "spec_hash": "string",<br/> "categories_mapping": {<br/> "property1": [<br/> "string"<br/> ],<br/> "property2": [<br/> "string"<br/> ]<br/> },<br/> "should_force_translate": true,<br/> "owner_reference": {<br/> "uuid": "string"<br/> },<br/> "categories": {<br/> "property1": "string",<br/> "property2": "string"<br/> }<br/>}<br/> |
| Specification | A representation of a VM spec. Please refer to Nutanix Hypervisor Documentation for more information regarding the specification structure. For example: <br/>{<br/> "name": "string",<br/> "availability_zone_reference": {<br/> "uuid": "string"<br/> },<br/> "description": "string",<br/> "resources": {<br/> "num_threads_per_core": 1,<br/> "is_agent_vm": true,<br/> "memory_size_mib": 1,<br/> "boot_config": {<br/> "boot_device_order_list": [<br/> "string"<br/> ],<br/> "boot_device": {<br/> "disk_address": {<br/> "device_index": 0,<br/> "adapter_type": "string"<br/> },<br/> "mac_address": "string"<br/> },<br/> "data_source_reference": {<br/> "url": "string",<br/> "kind": "string",<br/> "uuid": "string"<br/> },<br/> "boot_type": "string"<br/> },<br/> "disk_list": [<br/> {<br/> "uuid": "string",<br/> "disk_size_bytes": 1,<br/> "storage_config": {<br/> "flash_mode": "string",<br/> "storage_container_reference": {<br/> "url": "string",<br/> "kind": "string",<br/> "uuid": "string"<br/> }<br/> },<br/> "device_properties": {<br/> "device_type": "DISK",<br/> "disk_address": {<br/> "device_index": 0,<br/> "adapter_type": "string"<br/> }<br/> },<br/> "data_source_reference": {<br/> "is_direct_attach": true,<br/> "url": "string",<br/> "kind": "string",<br/> "uuid": "string"<br/> },<br/> "disk_size_mib": 1,<br/> "volume_group_reference": {<br/> "url": "string",<br/> "kind": "string",<br/> "uuid": "string"<br/> }<br/> }<br/> ],<br/> "serial_port_list": [<br/> {<br/> "index": 0,<br/> "is_connected": true<br/> }<br/> ],<br/> "generation_uuid": "string",<br/> "bios_uuid": "string",<br/> "is_vcpu_hard_pinned": true,<br/> "guest_tools": {<br/> "nutanix_guest_tools": {<br/> "ngt_state": "string",<br/> "iso_mount_state": "string",<br/> "state": "string",<br/> "version": "string",<br/> "enabled_capability_list": [<br/> "string"<br/> ],<br/> "credentials": {<br/> "username": "string",<br/> "password": "string"<br/> }<br/> }<br/> },<br/> "power_state": "string",<br/> "num_vcpus_per_socket": 1,<br/> "num_sockets": 1,<br/> "hardware_virtualization_enabled": true,<br/> "storage_config": {<br/> "qos_policy": {<br/> "throttled_iops": -1<br/> },<br/> "flash_mode": "string"<br/> },<br/> "machine_type": "string",<br/> "hardware_clock_timezone": "string",<br/> "guest_customization": {<br/> "cloud_init": {<br/> "meta_data": "string",<br/> "user_data": "string",<br/> "custom_key_values": {<br/> "property1": "string",<br/> "property2": "string"<br/> }<br/> },<br/> "is_overridable": false,<br/> "sysprep": {<br/> "install_type": "PREPARED",<br/> "unattend_xml": "string",<br/> "custom_key_values": {<br/> "property1": "string",<br/> "property2": "string"<br/> }<br/> },<br/> "property1": "string",<br/> "property2": "string"<br/> },<br/> "power_state_mechanism": {<br/> "guest_transition_config": {<br/> "should_fail_on_script_failure": true,<br/> "enable_script_exec": true<br/> },<br/> "mechanism": "string"<br/> },<br/> "vga_console_enabled": true,<br/> "memory_overcommit_enabled": true,<br/> "vnuma_config": {<br/> "num_vnuma_nodes": 0<br/> },<br/> "nic_list": [<br/> {<br/> "nic_type": "string",<br/> "uuid": "string",<br/> "ip_endpoint_list": [<br/> {<br/> "ip": "string",<br/> "type": "string",<br/> "gateway_address_list": [<br/> "string"<br/> ],<br/> "prefix_length": 32,<br/> "ip_type": "string"<br/> }<br/> ],<br/> "num_queues": 0,<br/> "secondary_ip_address_list": [<br/> "string"<br/> ],<br/> "network_function_nic_type": "string",<br/> "network_function_chain_reference": {<br/> "uuid": "string"<br/> },<br/> "vlan_mode": "string",<br/> "mac_address": "string",<br/> "subnet_reference": {<br/> "uuid": "string"<br/> },<br/> "model": "string",<br/> "is_connected": true,<br/> "trunked_vlan_list": [<br/> 0<br/> ]<br/> }<br/> ],<br/> "guest_os_id": "string",<br/> "gpu_list": [<br/> {<br/> "vendor": "string",<br/> "mode": "string",<br/> "device_id": 0<br/> }<br/> ],<br/> "gpu_console_enabled": true,<br/> "vtpm_config": {<br/> "vtpm_enabled": true,<br/> "data_source_reference": {<br/> "url": "string",<br/> "kind": "string",<br/> "uuid": "string"<br/> },<br/> "vtpm_secret": "string"<br/> },<br/> "enable_cpu_passthrough": true,<br/> "parent_reference": {<br/> "url": "string",<br/> "kind": "string",<br/> "uuid": "string"<br/> },<br/> "disable_branding": true<br/> },<br/> "cluster_reference": {<br/> "uuid": "string"<br/> }<br/>}<br/> |
| Virtual Machine ID | The UUID of the VM. |
Example Output
{
"status": {
"name": "string",
"state": "string",
"availability_zone_reference": {
"kind": "availability_zone",
"name": "string",
"uuid": "string"
},
"message_list": [
{
"message": "string",
"reason": "string",
"details": {
"property1": "string",
"property2": "string"
}
}
],
"cluster_reference": {
"kind": "cluster",
"name": "string",
"uuid": "string"
},
"resources": {
"num_threads_per_core": 1,
"is_agent_vm": true,
"protection_policy_state": {
"policy_reference": {
"url": "string",
"kind": "string",
"uuid": "string",
"name": "string"
},
"policy_info": {
"replication_status": "string"
},
"compliance_status": "string",
"enforcement_mode": "string",
"error_message_list": [
{
"message": "string",
"reason": "string",
"details": {
"property1": "string",
"property2": "string"
}
}
]
},
"memory_size_mib": 1,
"boot_config": {
"boot_device_order_list": [
"string"
],
"boot_device": {
"disk_address": {
"device_index": 0,
"adapter_type": "string"
},
"mac_address": "string"
},
"data_source_reference": {
"url": "string",
"kind": "string",
"uuid": "string",
"name": "string"
},
"boot_type": "string"
},
"disk_list": [
{
"uuid": "string",
"is_encryption_in_progress": false,
"is_migration_in_progress": false,
"disk_size_bytes": 1,
"storage_config": {
"flash_mode": "string",
"storage_container_reference": {
"url": "string",
"kind": "string",
"uuid": "string",
"name": "string"
}
},
"device_properties": {
"device_type": "DISK",
"disk_address": {
"device_index": 0,
"adapter_type": "string"
}
},
"data_source_reference": {
"is_direct_attach": true,
"url": "string",
"kind": "string",
"uuid": "string",
"name": "string"
},
"disk_size_mib": 1,
"volume_group_reference": {
"url": "string",
"kind": "string",
"uuid": "string",
"name": "string"
}
}
],
"serial_port_list": [
{
"index": 0,
"is_connected": true
}
],
"generation_uuid": "string",
"bios_uuid": "string",
"vga_console_enabled": true,
"power_state": "string",
"recovery_plan_state_list": [
{
"policy_reference": {
"url": "string",
"kind": "string",
"uuid": "string",
"name": "string"
},
"policy_info": {
"recoverability": {
"status": "string",
"reason": "string"
}
},
"compliance_status": "string",
"enforcement_mode": "string",
"error_message_list": [
{
"message": "string",
"reason": "string",
"details": {
"property1": "string",
"property2": "string"
}
}
]
}
],
"effective_storage_config": {
"compression_delay_secs": 0,
"compression_enabled": true,
"throttled_iops": 0,
"active_storage_policy_reference_list": [
{
"url": "string",
"kind": "string",
"uuid": "string",
"name": "string"
}
],
"encryption_enabled": true
},
"num_vcpus_per_socket": 0,
"num_sockets": 0,
"hardware_virtualization_enabled": true,
"storage_config": {
"qos_policy": {
"throttled_iops": 0
},
"flash_mode": "string"
},
"protection_type": "string",
"gpu_list": [
{
"frame_buffer_size_mib": 0,
"vendor": "string",
"uuid": "string",
"name": "string",
"pci_address": "string",
"fraction": 0,
"mode": "string",
"num_virtual_display_heads": 0,
"guest_driver_version": "string",
"max_instances_per_vm": 0,
"device_id": 0
}
],
"machine_type": "string",
"hardware_clock_timezone": "string",
"guest_customization": {
"cloud_init": {
"meta_data": "string",
"user_data": "string",
"custom_key_values": {
"property1": "string",
"property2": "string"
}
},
"is_overridable": true,
"sysprep": {
"install_type": "PREPARED",
"unattend_xml": "string",
"custom_key_values": {
"property1": "string",
"property2": "string"
}
},
"property1": "string",
"property2": "string"
},
"power_state_mechanism": {
"guest_transition_config": {
"should_fail_on_script_failure": true,
"enable_script_exec": true
},
"mechanism": "string"
},
"is_vcpu_hard_pinned": true,
"memory_overcommit_enabled": true,
"vnuma_config": {
"num_vnuma_nodes": 0
},
"nic_list": [
{
"dns_ip_addresses_list": [
"string"
],
"nic_type": "string",
"subnet_reference": {
"kind": "subnet",
"name": "string",
"uuid": "string"
},
"uuid": "string",
"ip_endpoint_list": [
{
"ip": "string",
"type": "string",
"gateway_address_list": [
"string"
],
"prefix_length": 32,
"ip_type": "string"
}
],
"network_function_chain_reference": {
"kind": "network_function_chain",
"name": "string",
"uuid": "string"
},
"secondary_ip_address_list": [
"string"
],
"floating_ip": "string",
"mac_address": "string",
"network_function_nic_type": "string",
"vlan_mode": "string",
"num_queues": 0,
"default_gateway_address_list": [
"string"
],
"dhcp_server_ip": "string",
"model": "string",
"is_connected": true,
"trunked_vlan_list": [
0
]
}
],
"host_reference": {
"url": "string",
"kind": "string",
"uuid": "string",
"name": "string"
},
"guest_os_id": "string",
"guest_tools": {
"nutanix_guest_tools": {
"available_version": "string",
"ngt_state": "string",
"iso_mount_state": "string",
"guest_os_version": "string",
"state": "string",
"version": "string",
"enabled_capability_list": [
"string"
],
"credentials": {
"username": "string",
"password": "string"
},
"vss_snapshot_capable": true,
"is_reachable": true,
"vm_mobility_drivers_installed": true
}
},
"gpu_console_enabled": true,
"vtpm_config": {
"vtpm_enabled": true,
"data_source_reference": {
"url": "string",
"kind": "string",
"uuid": "string",
"name": "string"
},
"version": "string"
},
"enable_cpu_passthrough": true,
"parent_reference": {
"url": "string",
"kind": "string",
"uuid": "string",
"name": "string"
},
"hypervisor_type": "string",
"disable_branding": true
},
"description": "string"
},
"spec": {
"name": "string",
"availability_zone_reference": {
"kind": "availability_zone",
"name": "string",
"uuid": "string"
},
"description": "string",
"resources": {
"num_threads_per_core": 1,
"is_agent_vm": true,
"memory_size_mib": 1,
"boot_config": {
"boot_device_order_list": [
"string"
],
"boot_device": {
"disk_address": {
"device_index": 0,
"adapter_type": "string"
},
"mac_address": "string"
},
"data_source_reference": {
"url": "string",
"kind": "string",
"uuid": "string",
"name": "string"
},
"boot_type": "string"
},
"disk_list": [
{
"uuid": "string",
"disk_size_bytes": 1,
"storage_config": {
"flash_mode": "string",
"storage_container_reference": {
"url": "string",
"kind": "string",
"uuid": "string",
"name": "string"
}
},
"device_properties": {
"device_type": "DISK",
"disk_address": {
"device_index": 0,
"adapter_type": "string"
}
},
"data_source_reference": {
"is_direct_attach": true,
"url": "string",
"kind": "string",
"uuid": "string",
"name": "string"
},
"disk_size_mib": 1,
"volume_group_reference": {
"url": "string",
"kind": "string",
"uuid": "string",
"name": "string"
}
}
],
"serial_port_list": [
{
"index": 0,
"is_connected": true
}
],
"generation_uuid": "string",
"bios_uuid": "string",
"is_vcpu_hard_pinned": true,
"guest_tools": {
"nutanix_guest_tools": {
"ngt_state": "string",
"iso_mount_state": "string",
"state": "string",
"version": "string",
"enabled_capability_list": [
"string"
],
"credentials": {
"username": "string",
"password": "string"
}
}
},
"power_state": "string",
"num_vcpus_per_socket": 1,
"num_sockets": 1,
"hardware_virtualization_enabled": true,
"storage_config": {
"qos_policy": {
"throttled_iops": -1
},
"flash_mode": "string"
},
"machine_type": "string",
"hardware_clock_timezone": "string",
"guest_customization": {
"cloud_init": {
"meta_data": "string",
"user_data": "string",
"custom_key_values": {
"property1": "string",
"property2": "string"
}
},
"is_overridable": false,
"sysprep": {
"install_type": "PREPARED",
"unattend_xml": "string",
"custom_key_values": {
"property1": "string",
"property2": "string"
}
},
"property1": "string",
"property2": "string"
},
"power_state_mechanism": {
"guest_transition_config": {
"should_fail_on_script_failure": true,
"enable_script_exec": true
},
"mechanism": "string"
},
"vga_console_enabled": true,
"memory_overcommit_enabled": true,
"vnuma_config": {
"num_vnuma_nodes": 0
},
"nic_list": [
{
"nic_type": "string",
"uuid": "string",
"ip_endpoint_list": [
{
"ip": "string",
"type": "string",
"gateway_address_list": [
"string"
],
"prefix_length": 32,
"ip_type": "string"
}
],
"num_queues": 0,
"secondary_ip_address_list": [
"string"
],
"network_function_nic_type": "string",
"network_function_chain_reference": {
"kind": "network_function_chain",
"name": "string",
"uuid": "string"
},
"vlan_mode": "string",
"mac_address": "string",
"subnet_reference": {
"kind": "subnet",
"name": "string",
"uuid": "string"
},
"model": "string",
"is_connected": true,
"trunked_vlan_list": [
0
]
}
],
"guest_os_id": "string",
"gpu_list": [
{
"vendor": "string",
"mode": "string",
"device_id": 0
}
],
"gpu_console_enabled": true,
"vtpm_config": {
"vtpm_enabled": true,
"data_source_reference": {
"url": "string",
"kind": "string",
"uuid": "string",
"name": "string"
},
"vtpm_secret": "string"
},
"enable_cpu_passthrough": true,
"parent_reference": {
"url": "string",
"kind": "string",
"uuid": "string",
"name": "string"
},
"disable_branding": true
},
"cluster_reference": {
"kind": "cluster",
"name": "string",
"uuid": "string"
}
},
"api_version": "3.1.0",
"metadata": {
"last_update_time": "2019-08-24T14:15:22Z",
"use_categories_mapping": false,
"kind": "vm",
"uuid": "string",
"project_reference": {
"kind": "project",
"name": "string",
"uuid": "string"
},
"creation_time": "2019-08-24T14:15:22Z",
"spec_version": 0,
"spec_hash": "string",
"categories_mapping": {
"property1": [
"string"
],
"property2": [
"string"
]
},
"should_force_translate": true,
"entity_version": "string",
"owner_reference": {
"kind": "user",
"name": "string",
"uuid": "string"
},
"categories": {
"property1": "string",
"property2": "string"
},
"name": "string"
}
}
Workflow Library Example
Update Virtual Machine with Nutanix Hypervisor and Send Results Via Email
Preview this Workflow on desktop