PATCH /vimgrsevmruntime/{uuid}
/vimgrsevmruntime/{uuid}
UUID of the object to fetch
object name
Avi Tenant Header
Avi Tenant Header UUID
The caller is required to set Avi Version Header to the expected version of configuration. The response from the controller will provide and accept data according to the specified version. The controller will reject POST and PUT requests where the data is not compatible with the specified version.
Avi Controller may send back CSRF token in the response cookies. The caller should update the request headers with this token else controller will reject requests.
{
"_last_modified": "string",
"availability_zone": "string",
"azure_info": {
"availability_set": "string",
"fault_domain": "string",
"name": "string",
"resource_group": "string",
"subnet_id": "string",
"update_domain": "string",
"vm_uuid": "string",
"vnic_id": "string"
},
"cloud_name": "string",
"cloud_ref": "string",
"cluster_id": "string",
"cluster_vmgroup": "string",
"connection_state": "string",
"controller_cluster_uuid": "string",
"controller_ip_addr": "string",
"cookie": "string",
"creation_in_progress": false,
"deletion_in_progress": false,
"discovery_response": "string",
"discovery_status": 0,
"disk_gb": 0,
"flavor": "string",
"gcp_se_project_id": "string",
"guest_nic": [
{
"avi_internal_network": false,
"connected": false,
"del_pending": false,
"guest_ip": [
{
"fip_available": false,
"fip_subnet_uuids": [
"string"
],
"floatingip_subnets": [
{
"name": "string",
"prefix": {
"ip_addr": {
"addr": "string",
"type": "string"
},
"mask": 0
},
"uuid": "string"
}
],
"ip_subnet": "string",
"name": "string",
"prefix": {
"ip_addr": {
"addr": "string",
"type": "string"
},
"mask": 0
},
"primary": false,
"ref_count": 0,
"se_ref_count": 0,
"uuid": "string"
}
],
"label": "string",
"mac_addr": "string",
"mgmt_vnic": false,
"network_name": "string",
"network_uuid": "string",
"os_port_uuid": "string",
"type": "string"
}
],
"host": "string",
"host_ref": "string",
"hostid": "string",
"hypervisor": "string",
"init_vnics": 0,
"last_discovery": 0,
"managed_object_id": "string",
"memory_mb": 0,
"name": "string",
"nsxt_no_hotplug": false,
"powerstate": "string",
"security_group_uuid": "string",
"segroup_ref": "string",
"server_group_uuid": "string",
"tenant_ref": "string",
"type": "string",
"url": "string",
"uuid": "string",
"vcenter_datacenter_uuid": "string",
"vcenter_host_connection_state": "string",
"vcenter_host_ha_state": "string",
"vcenter_instance_uuid": "string",
"vcenter_ref": "string",
"vcenter_rm_cookie": "string",
"vcenter_se_type": "string",
"vcenter_template_vm": false,
"vcenter_url": "string",
"vcenter_vAppName": "string",
"vcenter_vAppVendor": "string",
"vcenter_vm_type": "string",
"vcpus": 0,
"vsphere_ha_enabled": false,
"vsphere_ha_inprogress": false
}UNIX time since epoch in microseconds. Units(MICROSECONDS).
Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
It is a reference to an object of type Cloud. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
ServiceEngine deployed on cluster.Ex MOB domain-c23. Field introduced in 20.1.7, 21.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
ServiceEngine added to cluster vmgroup. Field introduced in 20.1.7, 21.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
Service Engine Cookie set by the resource manager. Field introduced in 18.2.2. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
Disk space in GB for each service engine VM. Field introduced in 18.2.2. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
GCP Project ID in which SE is created. This field is applicable for GCP cloud type only. Field introduced in 20.1.7, 21.1.2, 21.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
It is a reference to an object of type VIMgrHostRuntime. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
Enum options - DEFAULT, VMWARE_ESX, KVM, VMWARE_VSAN, XEN. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
Memory in MB for each service engine VM. Field introduced in 18.2.2. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
If set to true for NSXT cloud, controller should not hotplug the VNICs. Field introduced in 30.2.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
It is a reference to an object of type ServiceEngineGroup. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
It is a reference to an object of type Tenant. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
Enum options - CLOUD_NONE, CLOUD_VCENTER, CLOUD_OPENSTACK, CLOUD_AWS, CLOUD_VCA, CLOUD_APIC, CLOUD_MESOS, CLOUD_LINUXSERVER, CLOUD_DOCKER_UCP, CLOUD_RANCHER, CLOUD_OSHIFT_K8S, CLOUD_AZURE, CLOUD_GCP, CLOUD_NSXT. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
url
Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
ServiceEngine host connection state in vCenter. Field introduced in 20.1.7, 21.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
VCenter Host HA state.Ex election, fdmUnreachable, hostDown, initializationError, networkIsolated, uninitializationError, uninitialized. Field introduced in 20.1.7, 21.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
ServiceEngine instance uuid from vCenter. Field introduced in 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
ServiceEngine belongs to VCenter. It is a reference to an object of type VCenterServer. Field introduced in 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
Enum options - VIMGR_SE_NETWORK_ADMIN, VIMGR_SE_UNIFIED_ADMIN. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
Service Engine deployed in vcenter. Field introduced in 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
Enum options - VMTYPE_SE_VM, VMTYPE_POOL_SRVR. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
Count of vcpus for each service engine VM. Field introduced in 18.2.2. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
VSphere HA on cluster enabled or not. Field introduced in 20.1.7, 21.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
If this flag is set to True, vCenter vSphere HA handles ServiceEngine failure. This flag is set dynamiclly based on underlying ESX HA state(connected, hostDown..etc). Field introduced in 20.1.7, 21.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
OK
{
"_last_modified": "string",
"availability_zone": "string",
"azure_info": {
"availability_set": "string",
"fault_domain": "string",
"name": "string",
"resource_group": "string",
"subnet_id": "string",
"update_domain": "string",
"vm_uuid": "string",
"vnic_id": "string"
},
"cloud_name": "string",
"cloud_ref": "string",
"cluster_id": "string",
"cluster_vmgroup": "string",
"connection_state": "string",
"controller_cluster_uuid": "string",
"controller_ip_addr": "string",
"cookie": "string",
"creation_in_progress": false,
"deletion_in_progress": false,
"discovery_response": "string",
"discovery_status": 0,
"disk_gb": 0,
"flavor": "string",
"gcp_se_project_id": "string",
"guest_nic": [
{
"avi_internal_network": false,
"connected": false,
"del_pending": false,
"guest_ip": [
{
"fip_available": false,
"fip_subnet_uuids": [
"string"
],
"floatingip_subnets": [
{
"name": "string",
"prefix": {
"ip_addr": {
"addr": "string",
"type": "string"
},
"mask": 0
},
"uuid": "string"
}
],
"ip_subnet": "string",
"name": "string",
"prefix": {
"ip_addr": {
"addr": "string",
"type": "string"
},
"mask": 0
},
"primary": false,
"ref_count": 0,
"se_ref_count": 0,
"uuid": "string"
}
],
"label": "string",
"mac_addr": "string",
"mgmt_vnic": false,
"network_name": "string",
"network_uuid": "string",
"os_port_uuid": "string",
"type": "string"
}
],
"host": "string",
"host_ref": "string",
"hostid": "string",
"hypervisor": "string",
"init_vnics": 0,
"last_discovery": 0,
"managed_object_id": "string",
"memory_mb": 0,
"name": "string",
"nsxt_no_hotplug": false,
"powerstate": "string",
"security_group_uuid": "string",
"segroup_ref": "string",
"server_group_uuid": "string",
"tenant_ref": "string",
"type": "string",
"url": "string",
"uuid": "string",
"vcenter_datacenter_uuid": "string",
"vcenter_host_connection_state": "string",
"vcenter_host_ha_state": "string",
"vcenter_instance_uuid": "string",
"vcenter_ref": "string",
"vcenter_rm_cookie": "string",
"vcenter_se_type": "string",
"vcenter_template_vm": false,
"vcenter_url": "string",
"vcenter_vAppName": "string",
"vcenter_vAppVendor": "string",
"vcenter_vm_type": "string",
"vcpus": 0,
"vsphere_ha_enabled": false,
"vsphere_ha_inprogress": false
}UNIX time since epoch in microseconds. Units(MICROSECONDS).
Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
It is a reference to an object of type Cloud. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
ServiceEngine deployed on cluster.Ex MOB domain-c23. Field introduced in 20.1.7, 21.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
ServiceEngine added to cluster vmgroup. Field introduced in 20.1.7, 21.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
Service Engine Cookie set by the resource manager. Field introduced in 18.2.2. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
Disk space in GB for each service engine VM. Field introduced in 18.2.2. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
GCP Project ID in which SE is created. This field is applicable for GCP cloud type only. Field introduced in 20.1.7, 21.1.2, 21.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
It is a reference to an object of type VIMgrHostRuntime. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
Enum options - DEFAULT, VMWARE_ESX, KVM, VMWARE_VSAN, XEN. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
Memory in MB for each service engine VM. Field introduced in 18.2.2. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
If set to true for NSXT cloud, controller should not hotplug the VNICs. Field introduced in 30.2.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
It is a reference to an object of type ServiceEngineGroup. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
It is a reference to an object of type Tenant. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
Enum options - CLOUD_NONE, CLOUD_VCENTER, CLOUD_OPENSTACK, CLOUD_AWS, CLOUD_VCA, CLOUD_APIC, CLOUD_MESOS, CLOUD_LINUXSERVER, CLOUD_DOCKER_UCP, CLOUD_RANCHER, CLOUD_OSHIFT_K8S, CLOUD_AZURE, CLOUD_GCP, CLOUD_NSXT. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
url
Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
ServiceEngine host connection state in vCenter. Field introduced in 20.1.7, 21.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
VCenter Host HA state.Ex election, fdmUnreachable, hostDown, initializationError, networkIsolated, uninitializationError, uninitialized. Field introduced in 20.1.7, 21.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
ServiceEngine instance uuid from vCenter. Field introduced in 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
ServiceEngine belongs to VCenter. It is a reference to an object of type VCenterServer. Field introduced in 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
Enum options - VIMGR_SE_NETWORK_ADMIN, VIMGR_SE_UNIFIED_ADMIN. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
Service Engine deployed in vcenter. Field introduced in 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
Enum options - VMTYPE_SE_VM, VMTYPE_POOL_SRVR. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
Count of vcpus for each service engine VM. Field introduced in 18.2.2. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
VSphere HA on cluster enabled or not. Field introduced in 20.1.7, 21.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
If this flag is set to True, vCenter vSphere HA handles ServiceEngine failure. This flag is set dynamiclly based on underlying ESX HA state(connected, hostDown..etc). Field introduced in 20.1.7, 21.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
log in failed