GET /serviceengine/{uuid}/placement/
/serviceengine/{uuid}/placement/
UUID of the object to fetch
Avi Tenant Header
Avi Tenant Header UUID
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.
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.
OK
{
"_last_modified": "string",
"active_tags": [
"string"
],
"at_curr_ver": false,
"az": "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"
},
"bgp_peers_up": false,
"bootup_consumers": [
"string"
],
"bootup_failed": false,
"came_online_at": 0,
"container_mode": false,
"container_type": "string",
"controller_created": false,
"create_cookie": "string",
"created_at": 0,
"del_pending": false,
"del_start_ticks": 0,
"disconnected": false,
"disk_gb": 0,
"down_during_warmstart": false,
"enable_state": "string",
"failover_consumer_uuids": [
"string"
],
"flavor": "string",
"gateway_up": false,
"host_uuid": "string",
"hypervisor": "string",
"in_use": false,
"ip_mac_addr": [
"string"
],
"ip_masks": [
0
],
"ips": [
{
"addr": "string",
"type": "string"
}
],
"last_reboot_ticks": 0,
"masked_ips": [
{
"addr": "string",
"type": "string"
}
],
"max_ips_per_vnic": 0,
"max_vnics": 0,
"memory": 0,
"memory_free": 0,
"memory_inuse": 0,
"mgmt_ip": {
"addr": "string",
"type": "string"
},
"mgmt_ip6": {
"addr": "string",
"type": "string"
},
"mgmt_net_uuid": "string",
"name": "string",
"next_vnic_gc_ticks": 0,
"next_vnic_op_ticks": 0,
"nsxt_no_hotplug": false,
"online": false,
"pending_consumers": [
{
"cookie": "string",
"name": "string",
"state": "string",
"ticks": 0,
"uuid": "string"
}
],
"ping_cookie": "string",
"placement_ineligible_reason": "string",
"placement_ineligible_reason_str": "string",
"placement_ineligible_timestamp": {
"secs": 0,
"usecs": 0
},
"reason_code": "string",
"reboot_attempts": 0,
"resources_consumed": [
{
"active_on_cloud": false,
"admin_down": false,
"attach_ip_cookie": "string",
"attach_ip_fail_cnt": 0,
"attach_ip_fail_str": "string",
"attach_ip_fail_syserr": "string",
"attach_ip_in_progress": false,
"cloud_programming_done": false,
"consumer_name": "string",
"consumer_ref": "string",
"cookie": "string",
"detach_ip_cookie": "string",
"detach_ip_fail_cnt": 0,
"detach_ip_fail_str": "string",
"detach_ip_fail_syserr": "string",
"detach_ip_in_progress": false,
"failover_attempts": 0,
"floating_intf_ip": [
{
"addr": "string",
"type": "string"
}
],
"floating_intf_ip6_addresses": [
{
"addr": "string",
"type": "string"
}
],
"is_primary": false,
"is_stby": false,
"last_attach_ip_fail_ticks": 0,
"last_attach_ip_start_ticks": 0,
"last_detach_ip_fail_ticks": 0,
"last_detach_ip_start_ticks": 0,
"last_failover_attempt_ticks": 0,
"marked_for_delete": false,
"marked_for_scalein": false,
"memory": 0,
"res_name": "string",
"res_ref": "string",
"route_revoked_pool_down": false,
"se_programming_done": false,
"sec_idx": 0,
"state": "string",
"static_se_binding": false,
"vcpus": 0,
"vip": {
"addr": "string",
"type": "string"
},
"vip6": {
"addr": "string",
"type": "string"
},
"vip_intf_list": [
{
"is_portchannel": false,
"networks": [
{
"network_ref": "string",
"subnet": [
{
"ip_addr": {
"addr": "string",
"type": "string"
},
"mask": 0
}
],
"subnet6": [
{
"ip_addr": {
"addr": "string",
"type": "string"
},
"mask": 0
}
]
}
],
"vip_intf_ip": {
"addr": "string",
"type": "string"
},
"vip_intf_ip6": {
"addr": "string",
"type": "string"
},
"vip_intf_mac": "string",
"vlan_id": 0
}
],
"vnics": [
{
"connected": false,
"del_retries": 0,
"dp_deletion_done": false,
"enabled": false,
"in_use": false,
"is_avi_internal_network": false,
"last_vnic_op_ticks": 0,
"lif": "string",
"linux_name": "string",
"mac_addr": "string",
"marked_for_del": false,
"port_uuid": "string",
"subnet": {
"ip_addr": {
"addr": "string",
"type": "string"
},
"mask": 0
},
"tepless_ip": {
"addr": "string",
"type": "string"
},
"vips": [
"string"
],
"virtual_network_id": "string",
"vnic_type": "string",
"vrf_uuid": "string"
}
]
}
],
"se_group_ref": "string",
"se_grp_reboot_pending": false,
"static_ip": {
"addr": "string",
"type": "string"
},
"sufficient_memory": false,
"unused_since": 0,
"upgrading": false,
"url": "string",
"uuid": "string",
"vcpus": 0,
"vcpus_free": 0,
"vcpus_inuse": 0,
"version": "string",
"vinfra_discovered": false,
"vnic_op": {
"cc_vnic_op_success": false,
"cookie": "string",
"macs": [
"string"
],
"oper_start_ticks": 0,
"oper_start_time": "string",
"se_uuid": "string",
"se_vm_name": "string",
"virtual_network_ids": [
"string"
],
"vnic_op_infra": "string",
"vnic_op_type": "string",
"vrf_uuids": [
"string"
]
},
"vnic_op_consumers": [
"string"
],
"vnics": [
{
"connected": false,
"del_retries": 0,
"dp_deletion_done": false,
"enabled": false,
"in_use": false,
"is_avi_internal_network": false,
"last_vnic_op_ticks": 0,
"lif": "string",
"linux_name": "string",
"mac_addr": "string",
"marked_for_del": false,
"port_uuid": "string",
"subnet": {
"ip_addr": {
"addr": "string",
"type": "string"
},
"mask": 0
},
"tepless_ip": {
"addr": "string",
"type": "string"
},
"vips": [
"string"
],
"virtual_network_id": "string",
"vnic_type": "string",
"vrf_uuid": "string"
}
],
"vsphere_ha_active": false,
"warm_starting": false,
"went_headless_at": 0,
"went_offline_at": 0
}UNIX time since epoch in microseconds. Units(MICROSECONDS).
Enum options - ACTIVE_STANDBY_SE_1, ACTIVE_STANDBY_SE_2. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.
Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.
Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.
azure_info
Indicates if at least 1 BGP peer with advertise_vip is UP and at least 1 BGP peer with advertise_snat_ip is UP if there are such peers configured. Flag will be set to false if the condition above is not true for any of the VRFs configured on the SE. Field introduced in 21.1.3. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.
Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.
Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.
Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.
Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.
Enum options - CONTAINER_TYPE_BRIDGE, CONTAINER_TYPE_HOST, CONTAINER_TYPE_HOST_DPDK. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.
Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.
Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.
Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.
Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.
Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.
Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.
Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.
SE went down during warmstart. Field introduced in 18.2.8. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.
Enum options - SE_STATE_ENABLED, SE_STATE_DISABLED_FOR_PLACEMENT, SE_STATE_DISABLED, SE_STATE_DISABLED_FORCE, SE_STATE_DISABLED_WITH_SCALEIN, SE_STATE_DISABLED_NO_TRAFFIC, SE_STATE_DISABLED_FORCE_WITH_MIGRATE. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.
List of consumers attempting failover to this SE. Field introduced in 18.2.5. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.
Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.
Indicates if SE is able to connect to gateway. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.
Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.
Enum options - DEFAULT, VMWARE_ESX, KVM, VMWARE_VSAN, XEN. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.
Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.
Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.
Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.
Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.
Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.
Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.
Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.
Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.
Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.
Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.
Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.
mgmt_ip
mgmt_ip6
Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.
Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.
Ticks after which the next SE vnic garbage collection operation can be executed. Field introduced in 17.2.3. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.
Allowed with any value in Enterprise, 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 with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.
Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.
Field introduced in 17.2.2. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.
Cookie of the ping request to the SE. Field introduced in 18.2.5. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.
Reason code for why SE is not a placement candidate for any VSs. Enum options - PLACEMENT_INELIGIBLE_UPGRADE_IN_PROGRESS, PLACEMENT_INELIGIBLE_SE_GRP_UPGRADE_IN_PROGRESS, PLACEMENT_INELIGIBLE_CLOUD_NOT_READY, PLACEMENT_INELIGIBLE_CLOUD_API_NOT_READY, PLACEMENT_INELIGIBLE_VS_ELIGIBLE, PLACEMENT_INELIGIBLE_MULTIPLE_SE_CRASHES, PLACEMENT_INELIGIBLE_SPAWN_FAIL_MAX_LIMIT, PLACEMENT_INELIGIBLE_SPAWN_FAIL_UNRECOVERABLE, PLACEMENT_INELIGIBLE_BOOTUP_FAIL, PLACEMENT_INELIGIBLE_VNIC_FAIL, PLACEMENT_INELIGIBLE_VNIC_FAIL_MAX_LIMIT, PLACEMENT_INELIGIBLE_VNIC_IP_FAIL, PLACEMENT_INELIGIBLE_ATTACH_IP_FAIL_MAX_LIMIT, PLACEMENT_INELIGIBLE_ATTACH_IP_FAIL_UNRECOVERABLE, PLACEMENT_INELIGIBLE_VIP_MULTIPLE_NETWORKS, PLACEMENT_INELIGIBLE_SRVR_MULTIPLE_NETWORKS, PLACEMENT_INELIGIBLE_NO_VIP_NETWORK, PLACEMENT_INELIGIBLE_NO_SRVR_NETWORK, PLACEMENT_INELIGIBLE_VIP_NETWORK_DOES_NOT_EXIST, PLACEMENT_INELIGIBLE_SRVR_NETWORK_DOES_NOT_EXIST, PLACEMENT_INELIGIBLE_BGP_NETWORK_DOES_NOT_EXIST, PLACEMENT_INELIGIBLE_OTHER_SHARED_VIP_VS_PENDING, PLACEMENT_INELIGIBLE_OTHER_ACTIVE_STANDBY_VS_PENDING, PLACEMENT_INELIGIBLE_CONCURRENT_SE_CREATION_LIMIT, PLACEMENT_INELIGIBLE_SE_ELIGIBLE, PLACEMENT_INELIGIBLE_SE_DISABLED, PLACEMENT_INELIGIBLE_SE_DOWN, PLACEMENT_INELIGIBLE_SE_GATEWAY_DOWN, PLACEMENT_INELIGIBLE_SE_DISCONNECTED, PLACEMENT_INELIGIBLE_SE_MAX_VS_PER_SE_LIMIT, PLACEMENT_INELIGIBLE_SE_DEL_PENDING, PLACEMENT_INELIGIBLE_SE_GRP_REBOOT_PENDING, PLACEMENT_INELIGIBLE_NO_FRONTEND_REACH, PLACEMENT_INELIGIBLE_NO_BACKEND_REACH, PLACEMENT_INELIGIBLE_NO_FRONTEND_BACKEND_REACH, PLACEMENT_INELIGIBLE_MAX_VNIC_PER_SE_LIMIT, PLACEMENT_INELIGIBLE_MAX_IPS_PER_VNIC_LIMIT, PLACEMENT_INELIGIBLE_AZ_MISMATCH, PLACEMENT_INELIGIBLE_VNIC_DISCONNECTED, PLACEMENT_INELIGIBLE_VNIC_DISABLED, PLACEMENT_INELIGIBLE_VNIC_DEL_PENDING, PLACEMENT_INELIGIBLE_GCP_VNIC_NOT_ETH0, PLACEMENT_INELIGIBLE_SNI_CONSTRAINTS, PLACEMENT_INELIGIBLE_ACTIVE_STANDBY_CONSTRAINTS, PLACEMENT_INELIGIBLE_SHARED_VIP_CONSTRAINTS, PLACEMENT_INELIGIBLE_OTHER_VIP_ON_VS_PENDING, PLACEMENT_INELIGIBLE_NOT_ALL_BGP_PEERS_REACHABLE_VIP, PLACEMENT_INELIGIBLE_NO_BGP_PEER_REACHABLE_VIP, PLACEMENT_INELIGIBLE_NOT_ALL_BGP_PEERS_REACHABLE_SNAT, PLACEMENT_INELIGIBLE_NO_BGP_PEER_REACHABLE_SNAT, PLACEMENT_INELIGIBLE_SE_HOST_NO_NETWORK_CONNECTIVITY, PLACEMENT_INELIGIBLE_INSUFFICIENT_VNIC_SLOTS, PLACEMENT_INELIGIBLE_EXCLUDED_IP_CANDIDATE, PLACEMENT_INELIGIBLE_CON_IDLE_PENDING_VNIC_OP, PLACEMENT_INELIGIBLE_CON_IDLE_VNICS_IN_COOLDOWN, PLACEMENT_INELIGIBLE_IP_CANDIDATE_PENDING_VNIC_OP, PLACEMENT_INELIGIBLE_IP_CANDIDATE_VNICS_IN_COOLDOWN, PLACEMENT_INELIGIBLE_VNIC_CANDIDATE_PENDING_VNIC_OP, PLACEMENT_INELIGIBLE_VNIC_CANDIDATE_VNICS_IN_COOLDOWN, PLACEMENT_INELIGIBLE_VNIC_CANDIDATE_HOST_DISCONNECTED, PLACEMENT_INELIGIBLE_NO_BACKEND_REACH_VNIC_DEL_PENDING, PLACEMENT_INELIGIBLE_NO_BACKEND_REACH_VNIC_DISCONNECTED, PLACEMENT_INELIGIBLE_NO_BACKEND_REACH_VNIC_DISABLED. Field introduced in 20.1.5. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.
Reason string for why SE is not a placement candidate for any VSs. Field introduced in 20.1.5. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.
placement_ineligible_timestamp
Enum options - SE_DEREG_HB_FAILURE, SE_DEREG_POWERED_OFF, SE_DEREG_SUSPENDED, SE_DEREG_FATAL_ERROR, SE_DEREG_UNREACHABLE, SE_DEREG_VM_DELETED, SE_DEREG_REBOOTED, SE_DEREG_PURGE, SE_DEREG_HEALTH_CHECK, SE_DEREG_VINFRA_POWERED_OFF, SE_DEREG_UPGRADING, SE_DEREG_DP_HB_FAIL, SE_DEREG_DISABLED_FORCE, SE_DEREG_SWITCHOVER_FORCE, SE_DEREG_NEWLY_DISCOVERED, SE_DEREG_SE_GRP_CHANGE, SE_DEREG_UPGRADING_UNREACHABLE, SE_DEREG_VSPHERE_HA_HOST_FAILURE. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.
Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.
Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.
It is a reference to an object of type ServiceEngineGroup. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.
Indicates SE reboot following SE group change is pending. Field introduced in 18.2.3. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.
static_ip
Indicates if SE has sufficient memory. Field introduced in 18.1.2. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.
Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.
Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.
url
It is a reference to an object of type ServiceEngine. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.
Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.
Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.
Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.
Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.
Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.
vnic_op
Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.
Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.
If vSphere HA is enabled, this flag is set while CC is checking for ESX host failure (before the timeout of 120 secs), or when ESX host failure has been detected. When this flag is set, new VSs will not be placed on this SE, but no corrective actions (make before break, removing VSs, reboot) will occur in Resource Manager even while the SE is disconnected or down. Field introduced in 20.1.7, 21.1.3. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.
Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.
Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.
Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.
log in failed
object not found
curl -H 'Authorization: <value>' https://{api_host}/api/serviceengine/{uuid}/placement