Avi ServiceEngine Object API
CLI ``` - configure serviceengine - show serviceengine - reboot serviceengine - delete serviceengine - forcedelete serviceengine - switchover serviceengine - clear serviceengine ```
Contact Info: support@avinetworks.com
Version: 21.1.6
BasePath:/api
All rights reserved
http://apache.org/licenses/LICENSE-2.0.html
Access
- HTTP Basic Authentication
[ Jump to Models ]
Table of Contents
post /serviceengine/clearget /serviceenginepost /serviceengineget /serviceengine/{uuid}/adaptiveevents/get /serviceengine/{uuid}/appmap/get /serviceengine/{uuid}/arpstat/get /serviceengine/{uuid}/arptable/get /serviceengine/{uuid}/bfd/session_status/get /serviceengine/{uuid}/bgp/advertised_routes/get /serviceengine/{uuid}/bgp/debug/get /serviceengine/{uuid}/bgp/get /serviceengine/{uuid}/bgp/peer_info/get /serviceengine/{uuid}/bgp/peer_state/get /serviceengine/{uuid}/bgp/peer_status/get /serviceengine/{uuid}/bgp/running_config/get /serviceengine/{uuid}/botuacacheruntime/get /serviceengine/{uuid}/botuacachestatsruntime/get /serviceengine/{uuid}/connected/get /serviceengine/{uuid}/consistenthash/get /serviceengine/{uuid}/cpu/detail/get /serviceengine/{uuid}/cpu/delete /serviceengine/{uuid}get /serviceengine/{uuid}/dosstat/post /serviceengine/{uuid}/faultinject/exhaust_cfg/clearpost /serviceengine/{uuid}/faultinject/exhaust_conn/clearpost /serviceengine/{uuid}/faultinject/exhaust_mbuf/clearpost /serviceengine/{uuid}/faultinject/exhaust_mcl/clearpost /serviceengine/{uuid}/faultinject/exhaust_mcl_small/clearpost /serviceengine/{uuid}/faultinject/exhaust_shm_cfg/clearpost /serviceengine/{uuid}/faultinject/exhaust_shm_conn/clearpost /serviceengine/{uuid}/faultinject/sefault/clearget /serviceengine/{uuid}/flowtable/get /serviceengine/{uuid}/flowtable_remote/get /serviceengine/{uuid}/flowtablestat/post /serviceengine/{uuid}/forcedeleteget /serviceengine/{uuid}get /serviceengine/{uuid}/graphdb/get /serviceengine/{uuid}/httpstats/get /serviceengine/{uuid}/icmp6stat/get /serviceengine/{uuid}/icmpstat/get /serviceengine/{uuid}/interface/get /serviceengine/{uuid}/interface/lacp/get /serviceengine/{uuid}/interfacesummary/get /serviceengine/{uuid}/ip6route/get /serviceengine/{uuid}/ip6stat/get /serviceengine/{uuid}/ipstat/get /serviceengine/{uuid}/l4policysetstats/get /serviceengine/{uuid}/lldp/get /serviceengine/{uuid}/mallocstats/get /serviceengine/{uuid}/mbufstats/get /serviceengine/{uuid}/memdist/get /serviceengine/{uuid}/meminfo/get /serviceengine/{uuid}/metrics/detail/get /serviceengine/{uuid}/metrics/get /serviceengine/{uuid}/microservice/get /serviceengine/{uuid}/nat-flows/get /serviceengine/{uuid}/natpolicystats/get /serviceengine/{uuid}/natstat/get /serviceengine/{uuid}/ndtable/get /serviceengine/{uuid}/network-service/get /serviceengine/{uuid}/objsync/patch /serviceengine/{uuid}get /serviceengine/{uuid}/placement/detail/get /serviceengine/{uuid}/placement/get /serviceengine/{uuid}/placement/summary/put /serviceengine/{uuid}get /serviceengine/{uuid}/ratelimiting/msf/internal/get /serviceengine/{uuid}/ratelimiting/rl/internal/post /serviceengine/{uuid}/rebootget /serviceengine/{uuid}/reservedvs/get /serviceengine/{uuid}/resolverdb/get /serviceengine/{uuid}/resolverdbsummary/get /serviceengine/{uuid}/resourcemap/get /serviceengine/{uuid}/route-flows/get /serviceengine/{uuid}/route/get /serviceengine/{uuid}/routestat/get /serviceengine/{uuid}/rteringstat/get /serviceengine/{uuid}/runtime/detail/get /serviceengine/{uuid}/runtime/get /serviceengine/{uuid}/seagent/get /serviceengine/{uuid}/seassertstats/ag/get /serviceengine/{uuid}/seassertstats/dp/get /serviceengine/{uuid}/seauthstats/get /serviceengine/{uuid}/sehmprobedisable/get /serviceengine/{uuid}/selogstats/get /serviceengine/{uuid}/seruminsertionstats/get /serviceengine/{uuid}/sevshbstats/get /serviceengine/{uuid}/sevssplacement/get /serviceengine/{uuid}/shardclientevents/get /serviceengine/{uuid}/shmallocstats/post /serviceengine/{uuid}/switchoverget /serviceengine/{uuid}/tcp-flows/detail/get /serviceengine/{uuid}/tcp-flows/get /serviceengine/{uuid}/vnicdb/get /serviceengine/{uuid}/vnicdbhistory/get /serviceengine/{uuid}/vshash/
Up
post /serviceengine/clear
(serviceengineClearPost)
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (required)
Body Parameter — empty
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
200
OK
String
401
log in failed
(serviceengineGet)
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" : [ {
"availability_zone" : "aeiou",
"controller_ip" : "aeiou",
"host_ref" : "aeiou",
"enable_state" : "aeiou",
"resources" : {
"disk" : 123,
"memory" : 123,
"num_vcpus" : 123,
"sockets" : 123,
"cores_per_socket" : 123,
"num_datapath_processes" : 123,
"hyper_threading" : true,
"hypervisor_mode" : true
},
"uuid" : "aeiou",
"url" : "aeiou",
"_last_modified" : "aeiou",
"se_group_ref" : "aeiou",
"flavor" : "aeiou",
"cloud_ref" : "aeiou",
"hypervisor" : "aeiou",
"mgmt_vnic" : "",
"tenant_ref" : "aeiou",
"container_type" : "aeiou",
"controller_created" : true,
"name" : "aeiou",
"container_mode" : true,
"data_vnics" : [ {
"vlan_id" : 123,
"vrf_id" : 123,
"is_hsm" : true,
"port_uuid" : "aeiou",
"delete_vnic" : true,
"if_name" : "aeiou",
"is_asm" : true,
"can_se_dp_takeover" : true,
"vrf_ref" : "aeiou",
"aggregator_chgd" : true,
"linux_name" : "aeiou",
"enabled" : true,
"link_up" : true,
"vnic_networks" : [ "" ],
"is_avi_internal_network" : true,
"mac_address" : "aeiou",
"members" : [ {
"mac_address" : "aeiou",
"if_name" : "aeiou",
"active" : true
} ],
"network_ref" : "aeiou",
"adapter" : "aeiou",
"pci_id" : "aeiou",
"network_name" : "aeiou",
"ip6_autocfg_enabled" : true,
"del_pending" : true,
"is_mgmt" : true,
"mtu" : 123,
"connected" : true,
"dhcp_enabled" : true,
"dp_deletion_done" : true,
"vlan_interfaces" : [ {
"dhcp_enabled" : true,
"vlan_id" : 123,
"if_name" : "aeiou",
"ip6_autocfg_enabled" : true,
"vrf_ref" : "aeiou",
"enabled" : true,
"is_mgmt" : true,
"vnic_networks" : [ {
"mode" : "aeiou",
"ip" : {
"ip_addr" : {
"addr" : "aeiou",
"type" : "aeiou"
},
"mask" : 123
},
"ctlr_alloc" : true
} ]
} ],
"is_portchannel" : true
} ]
} ]
}
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
ServiceEngineApiResponse
401
log in failed
(serviceenginePost)
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (required)
Body Parameter — ServiceEngine object creation
Return type
Example data
Content-Type: application/json
{
"availability_zone" : "aeiou",
"controller_ip" : "aeiou",
"host_ref" : "aeiou",
"enable_state" : "aeiou",
"resources" : {
"disk" : 123,
"memory" : 123,
"num_vcpus" : 123,
"sockets" : 123,
"cores_per_socket" : 123,
"num_datapath_processes" : 123,
"hyper_threading" : true,
"hypervisor_mode" : true
},
"uuid" : "aeiou",
"url" : "aeiou",
"_last_modified" : "aeiou",
"se_group_ref" : "aeiou",
"flavor" : "aeiou",
"cloud_ref" : "aeiou",
"hypervisor" : "aeiou",
"mgmt_vnic" : "",
"tenant_ref" : "aeiou",
"container_type" : "aeiou",
"controller_created" : true,
"name" : "aeiou",
"container_mode" : true,
"data_vnics" : [ {
"vlan_id" : 123,
"vrf_id" : 123,
"is_hsm" : true,
"port_uuid" : "aeiou",
"delete_vnic" : true,
"if_name" : "aeiou",
"is_asm" : true,
"can_se_dp_takeover" : true,
"vrf_ref" : "aeiou",
"aggregator_chgd" : true,
"linux_name" : "aeiou",
"enabled" : true,
"link_up" : true,
"vnic_networks" : [ "" ],
"is_avi_internal_network" : true,
"mac_address" : "aeiou",
"members" : [ {
"mac_address" : "aeiou",
"if_name" : "aeiou",
"active" : true
} ],
"network_ref" : "aeiou",
"adapter" : "aeiou",
"pci_id" : "aeiou",
"network_name" : "aeiou",
"ip6_autocfg_enabled" : true,
"del_pending" : true,
"is_mgmt" : true,
"mtu" : 123,
"connected" : true,
"dhcp_enabled" : true,
"dp_deletion_done" : true,
"vlan_interfaces" : [ {
"dhcp_enabled" : true,
"vlan_id" : 123,
"if_name" : "aeiou",
"ip6_autocfg_enabled" : true,
"vrf_ref" : "aeiou",
"enabled" : true,
"is_mgmt" : true,
"vnic_networks" : [ {
"mode" : "aeiou",
"ip" : {
"ip_addr" : {
"addr" : "aeiou",
"type" : "aeiou"
},
"mask" : 123
},
"ctlr_alloc" : true
} ]
} ],
"is_portchannel" : true
} ]
}
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
ServiceEngine
401
log in failed
Up
get /serviceengine/{uuid}/adaptiveevents/
(serviceengineUuidAdaptiveeventsGet)
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:
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
200
OK
String
401
log in failed
Up
get /serviceengine/{uuid}/appmap/
(serviceengineUuidAppmapGet)
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:
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
200
OK
String
401
log in failed
Up
get /serviceengine/{uuid}/arpstat/
(serviceengineUuidArpstatGet)
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:
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
200
OK
String
401
log in failed
Up
get /serviceengine/{uuid}/arptable/
(serviceengineUuidArptableGet)
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:
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
200
OK
String
401
log in failed
Up
get /serviceengine/{uuid}/bfd/session_status/
(serviceengineUuidBfdSessionStatusGet)
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:
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
200
OK
String
401
log in failed
Up
get /serviceengine/{uuid}/bgp/advertised_routes/
(serviceengineUuidBgpAdvertisedRoutesGet)
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:
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
200
OK
String
401
log in failed
Up
get /serviceengine/{uuid}/bgp/debug/
(serviceengineUuidBgpDebugGet)
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:
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
200
OK
String
401
log in failed
Up
get /serviceengine/{uuid}/bgp/
(serviceengineUuidBgpGet)
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:
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
200
OK
String
401
log in failed
Up
get /serviceengine/{uuid}/bgp/peer_info/
(serviceengineUuidBgpPeerInfoGet)
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:
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
200
OK
String
401
log in failed
Up
get /serviceengine/{uuid}/bgp/peer_state/
(serviceengineUuidBgpPeerStateGet)
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:
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
200
OK
String
401
log in failed
Up
get /serviceengine/{uuid}/bgp/peer_status/
(serviceengineUuidBgpPeerStatusGet)
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:
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
200
OK
String
401
log in failed
Up
get /serviceengine/{uuid}/bgp/running_config/
(serviceengineUuidBgpRunningConfigGet)
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:
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
200
OK
String
401
log in failed
Up
get /serviceengine/{uuid}/botuacacheruntime/
(serviceengineUuidBotuacacheruntimeGet)
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:
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
200
OK
String
401
log in failed
Up
get /serviceengine/{uuid}/botuacachestatsruntime/
(serviceengineUuidBotuacachestatsruntimeGet)
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:
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
200
OK
String
401
log in failed
Up
get /serviceengine/{uuid}/connected/
(serviceengineUuidConnectedGet)
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:
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
200
OK
String
401
log in failed
Up
get /serviceengine/{uuid}/consistenthash/
(serviceengineUuidConsistenthashGet)
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:
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
200
OK
String
401
log in failed
Up
get /serviceengine/{uuid}/cpu/detail/
(serviceengineUuidCpuDetailGet)
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:
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
200
OK
String
401
log in failed
Up
get /serviceengine/{uuid}/cpu/
(serviceengineUuidCpuGet)
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:
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
200
OK
String
401
log in failed
Up
delete /serviceengine/{uuid}
(serviceengineUuidDelete)
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 /serviceengine/{uuid}/dosstat/
(serviceengineUuidDosstatGet)
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:
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
200
OK
String
401
log in failed
Up
post /serviceengine/{uuid}/faultinject/exhaust_cfg/clear
(serviceengineUuidFaultinjectExhaustCfgClearPost)
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 — SEFaultInjectExhaustParam
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
200
OK
String
401
log in failed
Up
post /serviceengine/{uuid}/faultinject/exhaust_conn/clear
(serviceengineUuidFaultinjectExhaustConnClearPost)
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 — SEFaultInjectExhaustParam
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
200
OK
String
401
log in failed
Up
post /serviceengine/{uuid}/faultinject/exhaust_mbuf/clear
(serviceengineUuidFaultinjectExhaustMbufClearPost)
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 — SEFaultInjectExhaustParam
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
200
OK
String
401
log in failed
Up
post /serviceengine/{uuid}/faultinject/exhaust_mcl/clear
(serviceengineUuidFaultinjectExhaustMclClearPost)
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 — SEFaultInjectExhaustParam
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
200
OK
String
401
log in failed
Up
post /serviceengine/{uuid}/faultinject/exhaust_mcl_small/clear
(serviceengineUuidFaultinjectExhaustMclSmallClearPost)
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 — SEFaultInjectExhaustParam
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
200
OK
String
401
log in failed
Up
post /serviceengine/{uuid}/faultinject/exhaust_shm_cfg/clear
(serviceengineUuidFaultinjectExhaustShmCfgClearPost)
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 — SEFaultInjectExhaustParam
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
200
OK
String
401
log in failed
Up
post /serviceengine/{uuid}/faultinject/exhaust_shm_conn/clear
(serviceengineUuidFaultinjectExhaustShmConnClearPost)
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 — SEFaultInjectExhaustParam
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
200
OK
String
401
log in failed
Up
post /serviceengine/{uuid}/faultinject/sefault/clear
(serviceengineUuidFaultinjectSefaultClearPost)
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 — SEFaultInjectSeParam
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
200
OK
String
401
log in failed
Up
get /serviceengine/{uuid}/flowtable/
(serviceengineUuidFlowtableGet)
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:
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
200
OK
String
401
log in failed
Up
get /serviceengine/{uuid}/flowtable_remote/
(serviceengineUuidFlowtableRemoteGet)
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:
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
200
OK
String
401
log in failed
Up
get /serviceengine/{uuid}/flowtablestat/
(serviceengineUuidFlowtablestatGet)
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:
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
200
OK
String
401
log in failed
Up
post /serviceengine/{uuid}/forcedelete
(serviceengineUuidForcedeletePost)
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 — empty
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
200
OK
String
401
log in failed
Up
get /serviceengine/{uuid}
(serviceengineUuidGet)
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
{
"availability_zone" : "aeiou",
"controller_ip" : "aeiou",
"host_ref" : "aeiou",
"enable_state" : "aeiou",
"resources" : {
"disk" : 123,
"memory" : 123,
"num_vcpus" : 123,
"sockets" : 123,
"cores_per_socket" : 123,
"num_datapath_processes" : 123,
"hyper_threading" : true,
"hypervisor_mode" : true
},
"uuid" : "aeiou",
"url" : "aeiou",
"_last_modified" : "aeiou",
"se_group_ref" : "aeiou",
"flavor" : "aeiou",
"cloud_ref" : "aeiou",
"hypervisor" : "aeiou",
"mgmt_vnic" : "",
"tenant_ref" : "aeiou",
"container_type" : "aeiou",
"controller_created" : true,
"name" : "aeiou",
"container_mode" : true,
"data_vnics" : [ {
"vlan_id" : 123,
"vrf_id" : 123,
"is_hsm" : true,
"port_uuid" : "aeiou",
"delete_vnic" : true,
"if_name" : "aeiou",
"is_asm" : true,
"can_se_dp_takeover" : true,
"vrf_ref" : "aeiou",
"aggregator_chgd" : true,
"linux_name" : "aeiou",
"enabled" : true,
"link_up" : true,
"vnic_networks" : [ "" ],
"is_avi_internal_network" : true,
"mac_address" : "aeiou",
"members" : [ {
"mac_address" : "aeiou",
"if_name" : "aeiou",
"active" : true
} ],
"network_ref" : "aeiou",
"adapter" : "aeiou",
"pci_id" : "aeiou",
"network_name" : "aeiou",
"ip6_autocfg_enabled" : true,
"del_pending" : true,
"is_mgmt" : true,
"mtu" : 123,
"connected" : true,
"dhcp_enabled" : true,
"dp_deletion_done" : true,
"vlan_interfaces" : [ {
"dhcp_enabled" : true,
"vlan_id" : 123,
"if_name" : "aeiou",
"ip6_autocfg_enabled" : true,
"vrf_ref" : "aeiou",
"enabled" : true,
"is_mgmt" : true,
"vnic_networks" : [ {
"mode" : "aeiou",
"ip" : {
"ip_addr" : {
"addr" : "aeiou",
"type" : "aeiou"
},
"mask" : 123
},
"ctlr_alloc" : true
} ]
} ],
"is_portchannel" : true
} ]
}
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
ServiceEngine
401
log in failed
Up
get /serviceengine/{uuid}/graphdb/
(serviceengineUuidGraphdbGet)
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:
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
200
OK
String
401
log in failed
Up
get /serviceengine/{uuid}/httpstats/
(serviceengineUuidHttpstatsGet)
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:
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
200
OK
String
401
log in failed
Up
get /serviceengine/{uuid}/icmp6stat/
(serviceengineUuidIcmp6statGet)
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:
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
200
OK
String
401
log in failed
Up
get /serviceengine/{uuid}/icmpstat/
(serviceengineUuidIcmpstatGet)
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:
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
200
OK
String
401
log in failed
Up
get /serviceengine/{uuid}/interface/
(serviceengineUuidInterfaceGet)
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:
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
200
OK
String
401
log in failed
Up
get /serviceengine/{uuid}/interface/lacp/
(serviceengineUuidInterfaceLacpGet)
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:
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
200
OK
String
401
log in failed
Up
get /serviceengine/{uuid}/interfacesummary/
(serviceengineUuidInterfacesummaryGet)
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:
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
200
OK
String
401
log in failed
Up
get /serviceengine/{uuid}/ip6route/
(serviceengineUuidIp6routeGet)
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:
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
200
OK
String
401
log in failed
Up
get /serviceengine/{uuid}/ip6stat/
(serviceengineUuidIp6statGet)
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:
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
200
OK
String
401
log in failed
Up
get /serviceengine/{uuid}/ipstat/
(serviceengineUuidIpstatGet)
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:
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
200
OK
String
401
log in failed
Up
get /serviceengine/{uuid}/l4policysetstats/
(serviceengineUuidL4policysetstatsGet)
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:
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
200
OK
String
401
log in failed
Up
get /serviceengine/{uuid}/lldp/
(serviceengineUuidLldpGet)
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:
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
200
OK
String
401
log in failed
Up
get /serviceengine/{uuid}/mallocstats/
(serviceengineUuidMallocstatsGet)
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:
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
200
OK
String
401
log in failed
Up
get /serviceengine/{uuid}/mbufstats/
(serviceengineUuidMbufstatsGet)
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:
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
200
OK
String
401
log in failed
Up
get /serviceengine/{uuid}/memdist/
(serviceengineUuidMemdistGet)
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:
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
200
OK
String
401
log in failed
Up
get /serviceengine/{uuid}/meminfo/
(serviceengineUuidMeminfoGet)
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:
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
200
OK
String
401
log in failed
Up
get /serviceengine/{uuid}/metrics/detail/
(serviceengineUuidMetricsDetailGet)
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:
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
200
OK
String
401
log in failed
Up
get /serviceengine/{uuid}/metrics/
(serviceengineUuidMetricsGet)
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:
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
200
OK
String
401
log in failed
Up
get /serviceengine/{uuid}/microservice/
(serviceengineUuidMicroserviceGet)
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:
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
200
OK
String
401
log in failed
Up
get /serviceengine/{uuid}/nat-flows/
(serviceengineUuidNatFlowsGet)
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:
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
200
OK
String
401
log in failed
Up
get /serviceengine/{uuid}/natpolicystats/
(serviceengineUuidNatpolicystatsGet)
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:
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
200
OK
String
401
log in failed
Up
get /serviceengine/{uuid}/natstat/
(serviceengineUuidNatstatGet)
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:
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
200
OK
String
401
log in failed
Up
get /serviceengine/{uuid}/ndtable/
(serviceengineUuidNdtableGet)
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:
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
200
OK
String
401
log in failed
Up
get /serviceengine/{uuid}/network-service/
(serviceengineUuidNetworkServiceGet)
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:
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
200
OK
String
401
log in failed
Up
get /serviceengine/{uuid}/objsync/
(serviceengineUuidObjsyncGet)
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:
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
200
OK
String
401
log in failed
Up
patch /serviceengine/{uuid}
(serviceengineUuidPatch)
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 — ServiceEngine object creation
Query parameters
name (optional)
Query Parameter — object name
Return type
Example data
Content-Type: application/json
{
"availability_zone" : "aeiou",
"controller_ip" : "aeiou",
"host_ref" : "aeiou",
"enable_state" : "aeiou",
"resources" : {
"disk" : 123,
"memory" : 123,
"num_vcpus" : 123,
"sockets" : 123,
"cores_per_socket" : 123,
"num_datapath_processes" : 123,
"hyper_threading" : true,
"hypervisor_mode" : true
},
"uuid" : "aeiou",
"url" : "aeiou",
"_last_modified" : "aeiou",
"se_group_ref" : "aeiou",
"flavor" : "aeiou",
"cloud_ref" : "aeiou",
"hypervisor" : "aeiou",
"mgmt_vnic" : "",
"tenant_ref" : "aeiou",
"container_type" : "aeiou",
"controller_created" : true,
"name" : "aeiou",
"container_mode" : true,
"data_vnics" : [ {
"vlan_id" : 123,
"vrf_id" : 123,
"is_hsm" : true,
"port_uuid" : "aeiou",
"delete_vnic" : true,
"if_name" : "aeiou",
"is_asm" : true,
"can_se_dp_takeover" : true,
"vrf_ref" : "aeiou",
"aggregator_chgd" : true,
"linux_name" : "aeiou",
"enabled" : true,
"link_up" : true,
"vnic_networks" : [ "" ],
"is_avi_internal_network" : true,
"mac_address" : "aeiou",
"members" : [ {
"mac_address" : "aeiou",
"if_name" : "aeiou",
"active" : true
} ],
"network_ref" : "aeiou",
"adapter" : "aeiou",
"pci_id" : "aeiou",
"network_name" : "aeiou",
"ip6_autocfg_enabled" : true,
"del_pending" : true,
"is_mgmt" : true,
"mtu" : 123,
"connected" : true,
"dhcp_enabled" : true,
"dp_deletion_done" : true,
"vlan_interfaces" : [ {
"dhcp_enabled" : true,
"vlan_id" : 123,
"if_name" : "aeiou",
"ip6_autocfg_enabled" : true,
"vrf_ref" : "aeiou",
"enabled" : true,
"is_mgmt" : true,
"vnic_networks" : [ {
"mode" : "aeiou",
"ip" : {
"ip_addr" : {
"addr" : "aeiou",
"type" : "aeiou"
},
"mask" : 123
},
"ctlr_alloc" : true
} ]
} ],
"is_portchannel" : true
} ]
}
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
ServiceEngine
401
log in failed
Up
get /serviceengine/{uuid}/placement/detail/
(serviceengineUuidPlacementDetailGet)
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:
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
200
OK
String
401
log in failed
Up
get /serviceengine/{uuid}/placement/
(serviceengineUuidPlacementGet)
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:
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
200
OK
String
401
log in failed
Up
get /serviceengine/{uuid}/placement/summary/
(serviceengineUuidPlacementSummaryGet)
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:
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
200
OK
String
401
log in failed
Up
put /serviceengine/{uuid}
(serviceengineUuidPut)
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 — ServiceEngine object creation
Query parameters
name (optional)
Query Parameter — object name
Return type
Example data
Content-Type: application/json
{
"availability_zone" : "aeiou",
"controller_ip" : "aeiou",
"host_ref" : "aeiou",
"enable_state" : "aeiou",
"resources" : {
"disk" : 123,
"memory" : 123,
"num_vcpus" : 123,
"sockets" : 123,
"cores_per_socket" : 123,
"num_datapath_processes" : 123,
"hyper_threading" : true,
"hypervisor_mode" : true
},
"uuid" : "aeiou",
"url" : "aeiou",
"_last_modified" : "aeiou",
"se_group_ref" : "aeiou",
"flavor" : "aeiou",
"cloud_ref" : "aeiou",
"hypervisor" : "aeiou",
"mgmt_vnic" : "",
"tenant_ref" : "aeiou",
"container_type" : "aeiou",
"controller_created" : true,
"name" : "aeiou",
"container_mode" : true,
"data_vnics" : [ {
"vlan_id" : 123,
"vrf_id" : 123,
"is_hsm" : true,
"port_uuid" : "aeiou",
"delete_vnic" : true,
"if_name" : "aeiou",
"is_asm" : true,
"can_se_dp_takeover" : true,
"vrf_ref" : "aeiou",
"aggregator_chgd" : true,
"linux_name" : "aeiou",
"enabled" : true,
"link_up" : true,
"vnic_networks" : [ "" ],
"is_avi_internal_network" : true,
"mac_address" : "aeiou",
"members" : [ {
"mac_address" : "aeiou",
"if_name" : "aeiou",
"active" : true
} ],
"network_ref" : "aeiou",
"adapter" : "aeiou",
"pci_id" : "aeiou",
"network_name" : "aeiou",
"ip6_autocfg_enabled" : true,
"del_pending" : true,
"is_mgmt" : true,
"mtu" : 123,
"connected" : true,
"dhcp_enabled" : true,
"dp_deletion_done" : true,
"vlan_interfaces" : [ {
"dhcp_enabled" : true,
"vlan_id" : 123,
"if_name" : "aeiou",
"ip6_autocfg_enabled" : true,
"vrf_ref" : "aeiou",
"enabled" : true,
"is_mgmt" : true,
"vnic_networks" : [ {
"mode" : "aeiou",
"ip" : {
"ip_addr" : {
"addr" : "aeiou",
"type" : "aeiou"
},
"mask" : 123
},
"ctlr_alloc" : true
} ]
} ],
"is_portchannel" : true
} ]
}
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
ServiceEngine
401
log in failed
Up
get /serviceengine/{uuid}/ratelimiting/msf/internal/
(serviceengineUuidRatelimitingMsfInternalGet)
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:
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
200
OK
String
401
log in failed
Up
get /serviceengine/{uuid}/ratelimiting/rl/internal/
(serviceengineUuidRatelimitingRlInternalGet)
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:
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
200
OK
String
401
log in failed
Up
post /serviceengine/{uuid}/reboot
(serviceengineUuidRebootPost)
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 — empty
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
200
OK
String
401
log in failed
Up
get /serviceengine/{uuid}/reservedvs/
(serviceengineUuidReservedvsGet)
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:
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
200
OK
String
401
log in failed
Up
get /serviceengine/{uuid}/resolverdb/
(serviceengineUuidResolverdbGet)
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:
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
200
OK
String
401
log in failed
Up
get /serviceengine/{uuid}/resolverdbsummary/
(serviceengineUuidResolverdbsummaryGet)
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:
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
200
OK
String
401
log in failed
Up
get /serviceengine/{uuid}/resourcemap/
(serviceengineUuidResourcemapGet)
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:
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
200
OK
String
401
log in failed
Up
get /serviceengine/{uuid}/route-flows/
(serviceengineUuidRouteFlowsGet)
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:
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
200
OK
String
401
log in failed
Up
get /serviceengine/{uuid}/route/
(serviceengineUuidRouteGet)
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:
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
200
OK
String
401
log in failed
Up
get /serviceengine/{uuid}/routestat/
(serviceengineUuidRoutestatGet)
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:
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
200
OK
String
401
log in failed
Up
get /serviceengine/{uuid}/rteringstat/
(serviceengineUuidRteringstatGet)
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:
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
200
OK
String
401
log in failed
Up
get /serviceengine/{uuid}/runtime/detail/
(serviceengineUuidRuntimeDetailGet)
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:
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
200
OK
String
401
log in failed
Up
get /serviceengine/{uuid}/runtime/
(serviceengineUuidRuntimeGet)
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:
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
200
OK
String
401
log in failed
Up
get /serviceengine/{uuid}/seagent/
(serviceengineUuidSeagentGet)
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:
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
200
OK
String
401
log in failed
Up
get /serviceengine/{uuid}/seassertstats/ag/
(serviceengineUuidSeassertstatsAgGet)
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:
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
200
OK
String
401
log in failed
Up
get /serviceengine/{uuid}/seassertstats/dp/
(serviceengineUuidSeassertstatsDpGet)
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:
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
200
OK
String
401
log in failed
Up
get /serviceengine/{uuid}/seauthstats/
(serviceengineUuidSeauthstatsGet)
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:
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
200
OK
String
401
log in failed
Up
get /serviceengine/{uuid}/sehmprobedisable/
(serviceengineUuidSehmprobedisableGet)
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:
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
200
OK
String
401
log in failed
Up
get /serviceengine/{uuid}/selogstats/
(serviceengineUuidSelogstatsGet)
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:
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
200
OK
String
401
log in failed
Up
get /serviceengine/{uuid}/seruminsertionstats/
(serviceengineUuidSeruminsertionstatsGet)
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:
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
200
OK
String
401
log in failed
Up
get /serviceengine/{uuid}/sevshbstats/
(serviceengineUuidSevshbstatsGet)
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:
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
200
OK
String
401
log in failed
Up
get /serviceengine/{uuid}/sevssplacement/
(serviceengineUuidSevssplacementGet)
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:
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
200
OK
String
401
log in failed
Up
get /serviceengine/{uuid}/shardclientevents/
(serviceengineUuidShardclienteventsGet)
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:
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
200
OK
String
401
log in failed
Up
get /serviceengine/{uuid}/shmallocstats/
(serviceengineUuidShmallocstatsGet)
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:
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
200
OK
String
401
log in failed
Up
post /serviceengine/{uuid}/switchover
(serviceengineUuidSwitchoverPost)
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 — empty
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
200
OK
String
401
log in failed
Up
get /serviceengine/{uuid}/tcp-flows/detail/
(serviceengineUuidTcpFlowsDetailGet)
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:
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
200
OK
String
401
log in failed
Up
get /serviceengine/{uuid}/tcp-flows/
(serviceengineUuidTcpFlowsGet)
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:
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
200
OK
String
401
log in failed
Up
get /serviceengine/{uuid}/vnicdb/
(serviceengineUuidVnicdbGet)
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:
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
200
OK
String
401
log in failed
Up
get /serviceengine/{uuid}/vnicdbhistory/
(serviceengineUuidVnicdbhistoryGet)
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:
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
200
OK
String
401
log in failed
Up
get /serviceengine/{uuid}/vshash/
(serviceengineUuidVshashGet)
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:
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
200
OK
String
401
log in failed
[ Jump to Methods ]
Table of Contents
ArpTableFilterDispatcherTableDumpClearIpAddrIpAddrPrefixMemberInterfaceSEFaultInjectExhaustParamSEFaultInjectSeParamSeResourcesServiceEngineServiceEngineApiResponsevNICvNICNetworkVlanInterface
ip_address (optional)
IpAddr IP address. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
se_uuid (optional)
String 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
active (optional)
Boolean Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
if_name
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
mac_address (optional)
String Field introduced in 17.1.5. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
leak (optional)
Boolean Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
num
Long Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int64
core (optional)
Integer Inject fault in specific core. Field introduced in 18.1.5,18.2.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
obj_names (optional)
array[String] Inject Fault on Objects. Field introduced in 21.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
random_core (optional)
Boolean Inject fault in random no of cores. Field introduced in 18.1.5,18.2.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
se_agent_fault (optional)
String Set se-agent fault type. Enum options - SE_AGENT_FAULT_DISABLED, SE_AGENT_PRE_PROCESS_FAULT, SE_AGENT_POST_PROCESS_FAULT, SE_AGENT_DP_RESPONSE_FAULT, SE_AGENT_RANDOM_PROCESS_FAULT. Field introduced in 18.1.5,18.2.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
se_dp_fault (optional)
String Set se-dp fault type. Enum options - SE_DP_FAULT_DISABLED. Field introduced in 18.1.5,18.2.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
cores_per_socket (optional)
Integer Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
disk
Integer Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
hyper_threading (optional)
Boolean Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
hypervisor_mode (optional)
Boolean Indicates that the SE is running on a Virtual Machine. Field introduced in 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
memory
Integer Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
num_datapath_processes (optional)
Integer Indicates the number of active datapath processes. Field introduced in 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
num_vcpus
Integer Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
sockets (optional)
Integer Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
_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.
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.
container_mode (optional)
Boolean Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
container_type (optional)
String Enum options - CONTAINER_TYPE_BRIDGE, CONTAINER_TYPE_HOST, CONTAINER_TYPE_HOST_DPDK. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
controller_created (optional)
Boolean Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
controller_ip (optional)
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
data_vnics (optional)
array[vNIC] Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
enable_state (optional)
String inorder to disable SE set this field appropriately. Enum options - SE_STATE_ENABLED, SE_STATE_DISABLED_FOR_PLACEMENT, SE_STATE_DISABLED, SE_STATE_DISABLED_FORCE. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
flavor (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.
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.
mgmt_vnic (optional)
vNIC 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.
resources (optional)
SeResources Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
se_group_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.
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.
url (optional)
uuid (optional)
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
count
results
next (optional)
adapter (optional)
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
aggregator_chgd (optional)
Boolean Field introduced in 17.2.7. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
can_se_dp_takeover (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.
delete_vnic (optional)
Boolean Delete this VNIC. Please confirm dp_deletion_done before removing the VNIC from the cloud. Field introduced in 18.2.5. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
dhcp_enabled (optional)
Boolean Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
dp_deletion_done (optional)
Boolean The VNIC has been cleaned up in the datapath. Field introduced in 18.2.3. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
enabled (optional)
Boolean Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
if_name (optional)
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
ip6_autocfg_enabled (optional)
Boolean Enable IPv6 auto configuration. Field introduced in 18.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
is_asm (optional)
Boolean Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
is_avi_internal_network (optional)
Boolean Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
is_hsm (optional)
Boolean Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
is_mgmt (optional)
Boolean Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
is_portchannel (optional)
Boolean Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
link_up (optional)
Boolean The link is operationally up. Field introduced in 18.2.8, 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
linux_name (optional)
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
mac_address
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
members (optional)
array[MemberInterface] Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
mtu (optional)
Integer Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
network_name (optional)
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
network_ref (optional)
String It is a reference to an object of type Network. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
pci_id (optional)
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
port_uuid (optional)
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
vlan_id (optional)
Integer Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
vlan_interfaces (optional)
array[VlanInterface] Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
vnic_networks (optional)
array[vNICNetwork] Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
vrf_id (optional)
Integer Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
vrf_ref (optional)
String It is a reference to an object of type VrfContext. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
ctlr_alloc (optional)
Boolean Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
ip
IpAddrPrefix Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
mode
String Enum options - DHCP, STATIC, VIP, DOCKER_HOST. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
dhcp_enabled (optional)
Boolean Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
enabled (optional)
Boolean Enable the interface. Field introduced in 18.2.5. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
if_name
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
ip6_autocfg_enabled (optional)
Boolean Enable IPv6 auto configuration. Field introduced in 18.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
is_mgmt (optional)
Boolean Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
vlan_id (optional)
Integer VLAN ID. Allowed values are 0-4096. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
vnic_networks (optional)
array[vNICNetwork] Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
vrf_ref (optional)
String It is a reference to an object of type VrfContext. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.