Updates the properties of an existing VM.
External DocumentationTo learn more, visit the Nutanix Hypervisor documentation.

​
Parameters

ParameterDescription
MetadataThe VM metadata. Please refer to Nutanix Hypervisor Documentation for more information regarding the metadata structure.

For example:
{
  “use_categories_mapping”: false,
  “uuid”: “string”,
  “project_reference”: {
    “uuid”: “string”
  },
  “spec_version”: 0,
  “spec_hash”: “string”,
  “categories_mapping”: {
    “property1”: [
      “string”
    ],
    “property2”: [
      “string”
    ]
  },
  “should_force_translate”: true,
  “owner_reference”: {
    “uuid”: “string”
  },
  “categories”: {
    “property1”: “string”,
    “property2”: “string”
  }
}
SpecificationA representation of a VM spec. Please refer to Nutanix Hypervisor Documentation for more information regarding the specification structure.

For example:
{
  “name”: “string”,
  “availability_zone_reference”: {
    “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”
      },
      “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”
          }
        },
        “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”
        },
        “disk_size_mib”: 1,
        “volume_group_reference”: {
          “url”: “string”,
          “kind”: “string”,
          “uuid”: “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”: {
          “uuid”: “string”
        },
        “vlan_mode”: “string”,
        “mac_address”: “string”,
        “subnet_reference”: {
          “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”
      },
      “vtpm_secret”: “string”
    },
    “enable_cpu_passthrough”: true,
    “parent_reference”: {
      “url”: “string”,
      “kind”: “string”,
      “uuid”: “string”
    },
    “disable_branding”: true
  },
  “cluster_reference”: {
    “uuid”: “string”
  }
}
Virtual Machine IDThe 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
Workflow LibraryPreview this Workflow on desktop