Avi VIMgrSEVMRuntime Object API
CLI ``` - show vinfra serviceengine ```
Version: 22.1.5
BasePath:/api
All rights reserved
http://apache.org/licenses/LICENSE-2.0.html
Access
- HTTP Basic Authentication
[ Jump to Models ]
Table of Contents
get /vimgrsevmruntimepost /vimgrsevmruntimedelete /vimgrsevmruntime/{uuid}get /vimgrsevmruntime/{uuid}patch /vimgrsevmruntime/{uuid}put /vimgrsevmruntime/{uuid}
(vimgrsevmruntimeGet)
Consumes
This API call consumes the following media types via the
Content-Type request header:
Query parameters
name (optional)
Query Parameter — object name
refers_to (optional)
Query Parameter — Filter to request all objects that refers to another Avi resource. Its syntax is refers_to=<obj_type>:<obj_uuid>. Eg. get all virtual services referring to pool p1 will be refers_to=pool:pool_p1_uuid
referred_by (optional)
Query Parameter — Filter to request all objects that are referred by another Avi resource. Its syntax is referred_by=<obj_type>:<obj_uuid>. Eg. get all pools referred_by virtual service vs1 - referred_by=virtualservice:vs_vs1_uuid
fields (optional)
Query Parameter — List of fields to be returned for the resource. Some fields like name, URL, uuid etc. are always returned.
include_name (optional)
Query Parameter — All the Avi REST reference URIs have a name suffix as URI#name. It is useful to get the referenced resource name without performing get on that object.
skip_default (optional)
Query Parameter — Default values are not set.
join_subresources (optional)
Query Parameter — It automatically returns additional dependent resources like runtime. Eg. join_subresources=runtime.
cloud_uuid (optional)
Query Parameter — Filter to get objects that belongs to a specific cloud using its uuid. Eg. cloud_uuid=cloud-xyz.
cloud_ref.name (optional)
Query Parameter — Filter to get objects that belongs to a specific cloud usings its name. This uses cloud name rather than uuid. Eg. cloud_ref.name=Default-Cloud.
Return type
Example data
Content-Type: application/json
{
"next" : "aeiou",
"count" : 123,
"results" : [ {
"vcenter_host_ha_state" : "aeiou",
"deletion_in_progress" : true,
"hostid" : "aeiou",
"type" : "aeiou",
"uuid" : "aeiou",
"vcenter_vAppName" : "aeiou",
"vcenter_vAppVendor" : "aeiou",
"vcenter_datacenter_uuid" : "aeiou",
"vcenter_instance_uuid" : "aeiou",
"cloud_ref" : "aeiou",
"segroup_ref" : "aeiou",
"host" : "aeiou",
"security_group_uuid" : "aeiou",
"disk_gb" : 123,
"server_group_uuid" : "aeiou",
"cookie" : "aeiou",
"discovery_response" : "aeiou",
"vcenter_ref" : "aeiou",
"flavor" : "aeiou",
"guest_nic" : [ {
"connected" : true,
"mac_addr" : "aeiou",
"mgmt_vnic" : true,
"guest_ip" : [ {
"fip_subnet_uuids" : [ "aeiou" ],
"ip_subnet" : "aeiou",
"fip_available" : true,
"prefix" : "",
"name" : "aeiou",
"floatingip_subnets" : [ {
"prefix" : {
"ip_addr" : {
"addr" : "aeiou",
"type" : "aeiou"
},
"mask" : 123
},
"name" : "aeiou",
"uuid" : "aeiou"
} ],
"ref_count" : 123,
"uuid" : "aeiou",
"se_ref_count" : 123,
"primary" : true
} ],
"network_name" : "aeiou",
"label" : "aeiou",
"network_uuid" : "aeiou",
"avi_internal_network" : true,
"type" : "aeiou",
"del_pending" : true,
"os_port_uuid" : "aeiou"
} ],
"discovery_status" : 123,
"name" : "aeiou",
"controller_ip_addr" : "aeiou",
"vsphere_ha_inprogress" : true,
"vcenter_host_connection_state" : "aeiou",
"vsphere_ha_enabled" : true,
"vcenter_url" : "aeiou",
"connection_state" : "aeiou",
"powerstate" : "aeiou",
"_last_modified" : "aeiou",
"gcp_se_project_id" : "aeiou",
"cluster_id" : "aeiou",
"creation_in_progress" : true,
"hypervisor" : "aeiou",
"vcenter_se_type" : "aeiou",
"cluster_vmgroup" : "aeiou",
"vcenter_rm_cookie" : "aeiou",
"availability_zone" : "aeiou",
"cloud_name" : "aeiou",
"host_ref" : "aeiou",
"last_discovery" : 123,
"vcpus" : 123,
"vcenter_vm_type" : "aeiou",
"url" : "aeiou",
"controller_cluster_uuid" : "aeiou",
"init_vnics" : 123,
"tenant_ref" : "aeiou",
"azure_info" : {
"availability_set" : "aeiou",
"vm_uuid" : "aeiou",
"vnic_id" : "aeiou",
"resource_group" : "aeiou",
"name" : "aeiou",
"subnet_id" : "aeiou",
"fault_domain" : "aeiou",
"update_domain" : "aeiou"
},
"memory_mb" : 123,
"vcenter_template_vm" : true,
"managed_object_id" : "aeiou"
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
VIMgrSEVMRuntimeApiResponse
401
log in failed
Up
post /vimgrsevmruntime
(vimgrsevmruntimePost)
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (required)
Body Parameter — VIMgrSEVMRuntime object creation
Return type
Example data
Content-Type: application/json
{
"vcenter_host_ha_state" : "aeiou",
"deletion_in_progress" : true,
"hostid" : "aeiou",
"type" : "aeiou",
"uuid" : "aeiou",
"vcenter_vAppName" : "aeiou",
"vcenter_vAppVendor" : "aeiou",
"vcenter_datacenter_uuid" : "aeiou",
"vcenter_instance_uuid" : "aeiou",
"cloud_ref" : "aeiou",
"segroup_ref" : "aeiou",
"host" : "aeiou",
"security_group_uuid" : "aeiou",
"disk_gb" : 123,
"server_group_uuid" : "aeiou",
"cookie" : "aeiou",
"discovery_response" : "aeiou",
"vcenter_ref" : "aeiou",
"flavor" : "aeiou",
"guest_nic" : [ {
"connected" : true,
"mac_addr" : "aeiou",
"mgmt_vnic" : true,
"guest_ip" : [ {
"fip_subnet_uuids" : [ "aeiou" ],
"ip_subnet" : "aeiou",
"fip_available" : true,
"prefix" : "",
"name" : "aeiou",
"floatingip_subnets" : [ {
"prefix" : {
"ip_addr" : {
"addr" : "aeiou",
"type" : "aeiou"
},
"mask" : 123
},
"name" : "aeiou",
"uuid" : "aeiou"
} ],
"ref_count" : 123,
"uuid" : "aeiou",
"se_ref_count" : 123,
"primary" : true
} ],
"network_name" : "aeiou",
"label" : "aeiou",
"network_uuid" : "aeiou",
"avi_internal_network" : true,
"type" : "aeiou",
"del_pending" : true,
"os_port_uuid" : "aeiou"
} ],
"discovery_status" : 123,
"name" : "aeiou",
"controller_ip_addr" : "aeiou",
"vsphere_ha_inprogress" : true,
"vcenter_host_connection_state" : "aeiou",
"vsphere_ha_enabled" : true,
"vcenter_url" : "aeiou",
"connection_state" : "aeiou",
"powerstate" : "aeiou",
"_last_modified" : "aeiou",
"gcp_se_project_id" : "aeiou",
"cluster_id" : "aeiou",
"creation_in_progress" : true,
"hypervisor" : "aeiou",
"vcenter_se_type" : "aeiou",
"cluster_vmgroup" : "aeiou",
"vcenter_rm_cookie" : "aeiou",
"availability_zone" : "aeiou",
"cloud_name" : "aeiou",
"host_ref" : "aeiou",
"last_discovery" : 123,
"vcpus" : 123,
"vcenter_vm_type" : "aeiou",
"url" : "aeiou",
"controller_cluster_uuid" : "aeiou",
"init_vnics" : 123,
"tenant_ref" : "aeiou",
"azure_info" : {
"availability_set" : "aeiou",
"vm_uuid" : "aeiou",
"vnic_id" : "aeiou",
"resource_group" : "aeiou",
"name" : "aeiou",
"subnet_id" : "aeiou",
"fault_domain" : "aeiou",
"update_domain" : "aeiou"
},
"memory_mb" : 123,
"vcenter_template_vm" : true,
"managed_object_id" : "aeiou"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
VIMgrSEVMRuntime
401
log in failed
Up
delete /vimgrsevmruntime/{uuid}
(vimgrsevmruntimeUuidDelete)
Path parameters
uuid (required)
Path Parameter — UUID of the object to fetch
Consumes
This API call consumes the following media types via the
Content-Type request header:
Query parameters
name (optional)
Query Parameter — object name
Return type
String
Example data
Content-Type: application/json
"aeiou"
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
204
object deleted
String
404
not found
Up
get /vimgrsevmruntime/{uuid}
(vimgrsevmruntimeUuidGet)
Path parameters
uuid (required)
Path Parameter — UUID of the object to fetch
Consumes
This API call consumes the following media types via the
Content-Type request header:
Query parameters
name (optional)
Query Parameter — object name
fields (optional)
Query Parameter — List of fields to be returned for the resource. Some fields like name, URL, uuid etc. are always returned.
include_name (optional)
Query Parameter — All the Avi REST reference URIs have a name suffix as URI#name. It is useful to get the referenced resource name without performing get on that object.
skip_default (optional)
Query Parameter — Default values are not set.
join_subresources (optional)
Query Parameter — It automatically returns additional dependent resources like runtime. Eg. join_subresources=runtime.
Return type
Example data
Content-Type: application/json
{
"vcenter_host_ha_state" : "aeiou",
"deletion_in_progress" : true,
"hostid" : "aeiou",
"type" : "aeiou",
"uuid" : "aeiou",
"vcenter_vAppName" : "aeiou",
"vcenter_vAppVendor" : "aeiou",
"vcenter_datacenter_uuid" : "aeiou",
"vcenter_instance_uuid" : "aeiou",
"cloud_ref" : "aeiou",
"segroup_ref" : "aeiou",
"host" : "aeiou",
"security_group_uuid" : "aeiou",
"disk_gb" : 123,
"server_group_uuid" : "aeiou",
"cookie" : "aeiou",
"discovery_response" : "aeiou",
"vcenter_ref" : "aeiou",
"flavor" : "aeiou",
"guest_nic" : [ {
"connected" : true,
"mac_addr" : "aeiou",
"mgmt_vnic" : true,
"guest_ip" : [ {
"fip_subnet_uuids" : [ "aeiou" ],
"ip_subnet" : "aeiou",
"fip_available" : true,
"prefix" : "",
"name" : "aeiou",
"floatingip_subnets" : [ {
"prefix" : {
"ip_addr" : {
"addr" : "aeiou",
"type" : "aeiou"
},
"mask" : 123
},
"name" : "aeiou",
"uuid" : "aeiou"
} ],
"ref_count" : 123,
"uuid" : "aeiou",
"se_ref_count" : 123,
"primary" : true
} ],
"network_name" : "aeiou",
"label" : "aeiou",
"network_uuid" : "aeiou",
"avi_internal_network" : true,
"type" : "aeiou",
"del_pending" : true,
"os_port_uuid" : "aeiou"
} ],
"discovery_status" : 123,
"name" : "aeiou",
"controller_ip_addr" : "aeiou",
"vsphere_ha_inprogress" : true,
"vcenter_host_connection_state" : "aeiou",
"vsphere_ha_enabled" : true,
"vcenter_url" : "aeiou",
"connection_state" : "aeiou",
"powerstate" : "aeiou",
"_last_modified" : "aeiou",
"gcp_se_project_id" : "aeiou",
"cluster_id" : "aeiou",
"creation_in_progress" : true,
"hypervisor" : "aeiou",
"vcenter_se_type" : "aeiou",
"cluster_vmgroup" : "aeiou",
"vcenter_rm_cookie" : "aeiou",
"availability_zone" : "aeiou",
"cloud_name" : "aeiou",
"host_ref" : "aeiou",
"last_discovery" : 123,
"vcpus" : 123,
"vcenter_vm_type" : "aeiou",
"url" : "aeiou",
"controller_cluster_uuid" : "aeiou",
"init_vnics" : 123,
"tenant_ref" : "aeiou",
"azure_info" : {
"availability_set" : "aeiou",
"vm_uuid" : "aeiou",
"vnic_id" : "aeiou",
"resource_group" : "aeiou",
"name" : "aeiou",
"subnet_id" : "aeiou",
"fault_domain" : "aeiou",
"update_domain" : "aeiou"
},
"memory_mb" : 123,
"vcenter_template_vm" : true,
"managed_object_id" : "aeiou"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
VIMgrSEVMRuntime
401
log in failed
Up
patch /vimgrsevmruntime/{uuid}
(vimgrsevmruntimeUuidPatch)
Path parameters
uuid (required)
Path Parameter — UUID of the object to fetch
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (required)
Body Parameter — VIMgrSEVMRuntime object creation
Query parameters
name (optional)
Query Parameter — object name
Return type
Example data
Content-Type: application/json
{
"vcenter_host_ha_state" : "aeiou",
"deletion_in_progress" : true,
"hostid" : "aeiou",
"type" : "aeiou",
"uuid" : "aeiou",
"vcenter_vAppName" : "aeiou",
"vcenter_vAppVendor" : "aeiou",
"vcenter_datacenter_uuid" : "aeiou",
"vcenter_instance_uuid" : "aeiou",
"cloud_ref" : "aeiou",
"segroup_ref" : "aeiou",
"host" : "aeiou",
"security_group_uuid" : "aeiou",
"disk_gb" : 123,
"server_group_uuid" : "aeiou",
"cookie" : "aeiou",
"discovery_response" : "aeiou",
"vcenter_ref" : "aeiou",
"flavor" : "aeiou",
"guest_nic" : [ {
"connected" : true,
"mac_addr" : "aeiou",
"mgmt_vnic" : true,
"guest_ip" : [ {
"fip_subnet_uuids" : [ "aeiou" ],
"ip_subnet" : "aeiou",
"fip_available" : true,
"prefix" : "",
"name" : "aeiou",
"floatingip_subnets" : [ {
"prefix" : {
"ip_addr" : {
"addr" : "aeiou",
"type" : "aeiou"
},
"mask" : 123
},
"name" : "aeiou",
"uuid" : "aeiou"
} ],
"ref_count" : 123,
"uuid" : "aeiou",
"se_ref_count" : 123,
"primary" : true
} ],
"network_name" : "aeiou",
"label" : "aeiou",
"network_uuid" : "aeiou",
"avi_internal_network" : true,
"type" : "aeiou",
"del_pending" : true,
"os_port_uuid" : "aeiou"
} ],
"discovery_status" : 123,
"name" : "aeiou",
"controller_ip_addr" : "aeiou",
"vsphere_ha_inprogress" : true,
"vcenter_host_connection_state" : "aeiou",
"vsphere_ha_enabled" : true,
"vcenter_url" : "aeiou",
"connection_state" : "aeiou",
"powerstate" : "aeiou",
"_last_modified" : "aeiou",
"gcp_se_project_id" : "aeiou",
"cluster_id" : "aeiou",
"creation_in_progress" : true,
"hypervisor" : "aeiou",
"vcenter_se_type" : "aeiou",
"cluster_vmgroup" : "aeiou",
"vcenter_rm_cookie" : "aeiou",
"availability_zone" : "aeiou",
"cloud_name" : "aeiou",
"host_ref" : "aeiou",
"last_discovery" : 123,
"vcpus" : 123,
"vcenter_vm_type" : "aeiou",
"url" : "aeiou",
"controller_cluster_uuid" : "aeiou",
"init_vnics" : 123,
"tenant_ref" : "aeiou",
"azure_info" : {
"availability_set" : "aeiou",
"vm_uuid" : "aeiou",
"vnic_id" : "aeiou",
"resource_group" : "aeiou",
"name" : "aeiou",
"subnet_id" : "aeiou",
"fault_domain" : "aeiou",
"update_domain" : "aeiou"
},
"memory_mb" : 123,
"vcenter_template_vm" : true,
"managed_object_id" : "aeiou"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
VIMgrSEVMRuntime
401
log in failed
Up
put /vimgrsevmruntime/{uuid}
(vimgrsevmruntimeUuidPut)
Path parameters
uuid (required)
Path Parameter — UUID of the object to fetch
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (required)
Body Parameter — VIMgrSEVMRuntime object creation
Query parameters
name (optional)
Query Parameter — object name
Return type
Example data
Content-Type: application/json
{
"vcenter_host_ha_state" : "aeiou",
"deletion_in_progress" : true,
"hostid" : "aeiou",
"type" : "aeiou",
"uuid" : "aeiou",
"vcenter_vAppName" : "aeiou",
"vcenter_vAppVendor" : "aeiou",
"vcenter_datacenter_uuid" : "aeiou",
"vcenter_instance_uuid" : "aeiou",
"cloud_ref" : "aeiou",
"segroup_ref" : "aeiou",
"host" : "aeiou",
"security_group_uuid" : "aeiou",
"disk_gb" : 123,
"server_group_uuid" : "aeiou",
"cookie" : "aeiou",
"discovery_response" : "aeiou",
"vcenter_ref" : "aeiou",
"flavor" : "aeiou",
"guest_nic" : [ {
"connected" : true,
"mac_addr" : "aeiou",
"mgmt_vnic" : true,
"guest_ip" : [ {
"fip_subnet_uuids" : [ "aeiou" ],
"ip_subnet" : "aeiou",
"fip_available" : true,
"prefix" : "",
"name" : "aeiou",
"floatingip_subnets" : [ {
"prefix" : {
"ip_addr" : {
"addr" : "aeiou",
"type" : "aeiou"
},
"mask" : 123
},
"name" : "aeiou",
"uuid" : "aeiou"
} ],
"ref_count" : 123,
"uuid" : "aeiou",
"se_ref_count" : 123,
"primary" : true
} ],
"network_name" : "aeiou",
"label" : "aeiou",
"network_uuid" : "aeiou",
"avi_internal_network" : true,
"type" : "aeiou",
"del_pending" : true,
"os_port_uuid" : "aeiou"
} ],
"discovery_status" : 123,
"name" : "aeiou",
"controller_ip_addr" : "aeiou",
"vsphere_ha_inprogress" : true,
"vcenter_host_connection_state" : "aeiou",
"vsphere_ha_enabled" : true,
"vcenter_url" : "aeiou",
"connection_state" : "aeiou",
"powerstate" : "aeiou",
"_last_modified" : "aeiou",
"gcp_se_project_id" : "aeiou",
"cluster_id" : "aeiou",
"creation_in_progress" : true,
"hypervisor" : "aeiou",
"vcenter_se_type" : "aeiou",
"cluster_vmgroup" : "aeiou",
"vcenter_rm_cookie" : "aeiou",
"availability_zone" : "aeiou",
"cloud_name" : "aeiou",
"host_ref" : "aeiou",
"last_discovery" : 123,
"vcpus" : 123,
"vcenter_vm_type" : "aeiou",
"url" : "aeiou",
"controller_cluster_uuid" : "aeiou",
"init_vnics" : 123,
"tenant_ref" : "aeiou",
"azure_info" : {
"availability_set" : "aeiou",
"vm_uuid" : "aeiou",
"vnic_id" : "aeiou",
"resource_group" : "aeiou",
"name" : "aeiou",
"subnet_id" : "aeiou",
"fault_domain" : "aeiou",
"update_domain" : "aeiou"
},
"memory_mb" : 123,
"vcenter_template_vm" : true,
"managed_object_id" : "aeiou"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
VIMgrSEVMRuntime
401
log in failed
[ Jump to Methods ]
Table of Contents
AzureInfoFloatingIpSubnetIpAddrIpAddrPrefixVIMgrGuestNicRuntimeVIMgrIPSubnetRuntimeVIMgrSEVMRuntimeVIMgrSEVMRuntimeApiResponse
availability_set (optional)
String Name of the availability set of which the VM is a part of. Field introduced in 17.2.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
fault_domain (optional)
String Fault domain within the availability set the VM is a part of. Field introduced in 17.2.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
name (optional)
String Name of the Azure VM. Field introduced in 17.2.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
resource_group (optional)
String Resource group name for the VM. Field introduced in 17.2.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
subnet_id (optional)
String Subnet ID of the primary nic of the VM. Field introduced in 17.2.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
update_domain (optional)
String Update domain within the availability set the VM is a part of. Field introduced in 17.2.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
vm_uuid (optional)
String Azure VM uuid for the SE VM. Field introduced in 17.2.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
vnic_id (optional)
String VNIC id of the primary nic of the VM. Field introduced in 17.2.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
name
String FloatingIp subnet name if available, else uuid. Field introduced in 17.2.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
prefix (optional)
IpAddrPrefix FloatingIp subnet prefix. Field introduced in 17.2.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
uuid (optional)
String FloatingIp subnet uuid. Field introduced in 17.2.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
addr
String IP address. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
type
String Enum options - V4, DNS, V6. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
ip_addr
IpAddr Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
mask
Integer Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
avi_internal_network (optional)
Boolean Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
connected (optional)
Boolean Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
del_pending (optional)
Boolean Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
guest_ip (optional)
label (optional)
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
mac_addr
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
mgmt_vnic (optional)
Boolean Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
network_name (optional)
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
network_uuid (optional)
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
os_port_uuid (optional)
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
type
String 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.
fip_available (optional)
Boolean If true, capable of floating/elastic IP association. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
fip_subnet_uuids (optional)
array[String] If fip_available is True, this is list of supported FIP subnets, possibly empty if Cloud does not support such a network list. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
floatingip_subnets (optional)
array[FloatingIpSubnet] If fip_available is True, the list of associated FloatingIP subnets, possibly empty if unsupported or implictly defined by the Cloud. Field introduced in 17.2.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
ip_subnet (optional)
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
name (optional)
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
prefix
IpAddrPrefix Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
primary (optional)
Boolean True if prefix is primary IP on interface, else false. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
ref_count (optional)
Integer Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
se_ref_count (optional)
Integer Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
uuid (optional)
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
_last_modified (optional)
String UNIX time since epoch in microseconds. Units(MICROSECONDS).
availability_zone (optional)
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
azure_info (optional)
AzureInfo Field introduced in 17.2.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
cloud_name (optional)
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
cloud_ref (optional)
String It is a reference to an object of type Cloud. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
cluster_id (optional)
String 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.
cluster_vmgroup (optional)
String 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.
connection_state (optional)
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
controller_cluster_uuid (optional)
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
controller_ip_addr (optional)
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
cookie (optional)
String 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.
creation_in_progress (optional)
Boolean Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
deletion_in_progress (optional)
Boolean Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
discovery_response (optional)
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
discovery_status (optional)
Integer Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
disk_gb (optional)
Integer 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. format: int32
flavor (optional)
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
gcp_se_project_id (optional)
String 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.
guest_nic (optional)
host (optional)
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
host_ref (optional)
String It is a reference to an object of type VIMgrHostRuntime. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
hostid (optional)
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
hypervisor (optional)
String Enum options - DEFAULT, VMWARE_ESX, KVM, VMWARE_VSAN, XEN. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
init_vnics (optional)
Integer Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
last_discovery (optional)
Integer Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
managed_object_id
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
memory_mb (optional)
Integer 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. format: int32
name
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
powerstate (optional)
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
security_group_uuid (optional)
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
segroup_ref (optional)
String It is a reference to an object of type ServiceEngineGroup. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
server_group_uuid (optional)
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
tenant_ref (optional)
String It is a reference to an object of type Tenant. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
type
String 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 (optional)
uuid (optional)
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
vcenter_datacenter_uuid (optional)
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
vcenter_host_connection_state (optional)
String 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 (optional)
String 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.
vcenter_instance_uuid (optional)
String 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.
vcenter_ref (optional)
String 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.
vcenter_rm_cookie (optional)
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
vcenter_se_type (optional)
String Enum options - VIMGR_SE_NETWORK_ADMIN, VIMGR_SE_UNIFIED_ADMIN. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
vcenter_template_vm (optional)
Boolean Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
vcenter_url (optional)
String 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.
vcenter_vAppName (optional)
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
vcenter_vAppVendor (optional)
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
vcenter_vm_type (optional)
String Enum options - VMTYPE_SE_VM, VMTYPE_POOL_SRVR. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
vcpus (optional)
Integer 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. format: int32
vsphere_ha_enabled (optional)
Boolean 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.
vsphere_ha_inprogress (optional)
Boolean 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.
count
results
next (optional)