POST /vsvip-inventory
/vsvip-inventory
Request
URI
POST
https://{api_host}/api/vsvip-inventory
COPY
Header Parameters
string
X-Avi-Tenant
Optional
Avi Tenant Header
string
X-Avi-Tenant-UUID
Optional
Avi Tenant Header UUID
string
X-Avi-Version
Required
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.
string
X-CSRFToken
Optional
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.
Request Body
VsvipInventory object creation
VsvipInventory of type(s) application/json
Optional
Show optional properties
{
"config": {
"name": "string"
}
}{
"_last_modified": "string",
"config": {
"cloud_ref": "string",
"east_west_placement": false,
"name": "string",
"tenant_ref": "string",
"url": "string",
"uuid": "string",
"vip": [
{
"auto_allocate_floating_ip": false,
"auto_allocate_ip": false,
"auto_allocate_ip_type": "string",
"availability_zone": "string",
"avi_allocated_fip": false,
"avi_allocated_vip": false,
"discovered_networks": [
{
"network_ref": "string",
"subnet": [
{
"ip_addr": {
"addr": "string",
"type": "string"
},
"mask": 0
}
],
"subnet6": [
{
"ip_addr": {
"addr": "string",
"type": "string"
},
"mask": 0
}
]
}
],
"enabled": false,
"floating_ip": {
"addr": "string",
"type": "string"
},
"floating_ip6": {
"addr": "string",
"type": "string"
},
"floating_subnet6_uuid": "string",
"floating_subnet_uuid": "string",
"ip6_address": {
"addr": "string",
"type": "string"
},
"ip_address": {
"addr": "string",
"type": "string"
},
"ipam_network_subnet": {
"network_ref": "string",
"subnet": {
"ip_addr": {
"addr": "string",
"type": "string"
},
"mask": 0
},
"subnet6": {
"ip_addr": {
"addr": "string",
"type": "string"
},
"mask": 0
},
"subnet6_uuid": "string",
"subnet_uuid": "string"
},
"network_ref": "string",
"placement_networks": [
{
"network_ref": "string",
"subnet": {
"ip_addr": {
"addr": "string",
"type": "string"
},
"mask": 0
},
"subnet6": {
"ip_addr": {
"addr": "string",
"type": "string"
},
"mask": 0
}
}
],
"port_uuid": "string",
"prefix_length": 0,
"subnet": {
"ip_addr": {
"addr": "string",
"type": "string"
},
"mask": 0
},
"subnet6": {
"ip_addr": {
"addr": "string",
"type": "string"
},
"mask": 0
},
"subnet6_uuid": "string",
"subnet_uuid": "string",
"vip_id": "string"
}
],
"virtualservices": [
{
"ref": "string"
}
],
"vrf_context_ref": "string"
},
"runtime": {
"num_se_assigned": 0,
"num_se_requested": 0,
"oper_status": {
"last_changed_time": {
"secs": 0,
"usecs": 0
},
"reason": [
"string"
],
"reason_code": 0,
"reason_code_string": "string",
"state": "string"
},
"percent_ses_up": 0,
"service_engine": [
{
"active_on_cloud": false,
"active_on_se": false,
"admin_down_requested": false,
"attach_ip_in_progress": false,
"connected": false,
"detach_ip_in_progress": false,
"mgmt_ip": {
"addr": "string",
"type": "string"
},
"mgmt_ip6": {
"addr": "string",
"type": "string"
},
"name": "string",
"oper_status": {
"last_changed_time": {
"secs": 0,
"usecs": 0
},
"reason": [
"string"
],
"reason_code": 0,
"reason_code_string": "string",
"state": "string"
},
"primary": false,
"ref": "string",
"route_revoked_pool_down": false,
"scalein_in_progress": false,
"scaleout_in_progress": false,
"se_ready_in_progress": false,
"snat_ip": {
"addr": "string",
"type": "string"
},
"snat_ip6_address": {
"addr": "string",
"type": "string"
},
"standby": false
}
],
"vip_id": "string"
},
"url": "string",
"uuid": "string"
}
Responses
200
OK
Returns VsvipInventory of type(s) application/json
"VsvipInventory Object"string
_last_modified
Optional
UNIX time since epoch in microseconds. Units(MICROSECONDS).
object
config
Required
config
object
runtime
Optional
runtime
string
url
Optional
url
string
uuid
Optional
UUID of the vsvip. Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
401
log in failed
Operation doesn't return any data structure
Code Samples
COPY
curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"config:"object"}' https://{api_host}/api/vsvip-inventory