Avi VsvipInventory Object API
CLI ``` - show vsvipinventory ```
Version: 22.1.5
BasePath:/api
All rights reserved
http://apache.org/licenses/LICENSE-2.0.html
Access
- HTTP Basic Authentication
[ Jump to Models ]
Table of Contents
get /vsvipinventorypost /vsvipinventorydelete /vsvipinventory/{uuid}get /vsvipinventory/{uuid}patch /vsvipinventory/{uuid}put /vsvipinventory/{uuid}
(vsvipinventoryGet)
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.
Return type
Example data
Content-Type: application/json
{
"next" : "aeiou",
"count" : 123,
"results" : [ {
"runtime" : {
"percent_ses_up" : 123,
"num_se_requested" : 123,
"service_engine" : [ {
"mgmt_ip6" : "",
"standby" : true,
"mgmt_ip" : "",
"scalein_in_progress" : true,
"se_ready_in_progress" : true,
"admin_down_requested" : true,
"oper_status" : "",
"connected" : true,
"active_on_cloud" : true,
"ref" : "aeiou",
"snat_ip" : "",
"attach_ip_in_progress" : true,
"name" : "aeiou",
"scaleout_in_progress" : true,
"detach_ip_in_progress" : true,
"active_on_se" : true,
"primary" : true
} ],
"num_se_assigned" : 123,
"vip_id" : "aeiou",
"oper_status" : {
"reason_code" : 123456789,
"reason" : [ "aeiou" ],
"last_changed_time" : {
"usecs" : 123456789,
"secs" : 123456789
},
"state" : "aeiou",
"reason_code_string" : "aeiou"
}
},
"config" : {
"vrf_context_ref" : "aeiou",
"virtualservices" : [ {
"ref" : "aeiou"
} ],
"cloud_ref" : "aeiou",
"tenant_ref" : "aeiou",
"name" : "aeiou",
"vip" : [ {
"availability_zone" : "aeiou",
"ip6_address" : "",
"subnet" : "",
"port_uuid" : "aeiou",
"subnet_uuid" : "aeiou",
"placement_networks" : [ {
"subnet" : "",
"subnet6" : "",
"network_ref" : "aeiou"
} ],
"avi_allocated_vip" : true,
"vip_id" : "aeiou",
"ip_address" : "",
"auto_allocate_floating_ip" : true,
"enabled" : true,
"auto_allocate_ip_type" : "aeiou",
"floating_subnet6_uuid" : "aeiou",
"auto_allocate_ip" : true,
"subnet6" : "",
"floating_ip" : "",
"floating_subnet_uuid" : "aeiou",
"avi_allocated_fip" : true,
"subnet6_uuid" : "aeiou",
"floating_ip6" : "",
"ipam_network_subnet" : {
"subnet" : "",
"subnet_uuid" : "aeiou",
"subnet6" : "",
"subnet6_uuid" : "aeiou",
"network_ref" : "aeiou"
},
"network_ref" : "aeiou",
"prefix_length" : 123,
"discovered_networks" : [ {
"subnet" : [ {
"ip_addr" : {
"addr" : "aeiou",
"type" : "aeiou"
},
"mask" : 123
} ],
"subnet6" : [ "" ],
"network_ref" : "aeiou"
} ]
} ],
"east_west_placement" : true,
"uuid" : "aeiou",
"url" : "aeiou"
},
"uuid" : "aeiou",
"url" : "aeiou",
"_last_modified" : "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
VsvipInventoryApiResponse
401
log in failed
(vsvipinventoryPost)
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (required)
Body Parameter — VsvipInventory object creation
Return type
Example data
Content-Type: application/json
{
"runtime" : {
"percent_ses_up" : 123,
"num_se_requested" : 123,
"service_engine" : [ {
"mgmt_ip6" : "",
"standby" : true,
"mgmt_ip" : "",
"scalein_in_progress" : true,
"se_ready_in_progress" : true,
"admin_down_requested" : true,
"oper_status" : "",
"connected" : true,
"active_on_cloud" : true,
"ref" : "aeiou",
"snat_ip" : "",
"attach_ip_in_progress" : true,
"name" : "aeiou",
"scaleout_in_progress" : true,
"detach_ip_in_progress" : true,
"active_on_se" : true,
"primary" : true
} ],
"num_se_assigned" : 123,
"vip_id" : "aeiou",
"oper_status" : {
"reason_code" : 123456789,
"reason" : [ "aeiou" ],
"last_changed_time" : {
"usecs" : 123456789,
"secs" : 123456789
},
"state" : "aeiou",
"reason_code_string" : "aeiou"
}
},
"config" : {
"vrf_context_ref" : "aeiou",
"virtualservices" : [ {
"ref" : "aeiou"
} ],
"cloud_ref" : "aeiou",
"tenant_ref" : "aeiou",
"name" : "aeiou",
"vip" : [ {
"availability_zone" : "aeiou",
"ip6_address" : "",
"subnet" : "",
"port_uuid" : "aeiou",
"subnet_uuid" : "aeiou",
"placement_networks" : [ {
"subnet" : "",
"subnet6" : "",
"network_ref" : "aeiou"
} ],
"avi_allocated_vip" : true,
"vip_id" : "aeiou",
"ip_address" : "",
"auto_allocate_floating_ip" : true,
"enabled" : true,
"auto_allocate_ip_type" : "aeiou",
"floating_subnet6_uuid" : "aeiou",
"auto_allocate_ip" : true,
"subnet6" : "",
"floating_ip" : "",
"floating_subnet_uuid" : "aeiou",
"avi_allocated_fip" : true,
"subnet6_uuid" : "aeiou",
"floating_ip6" : "",
"ipam_network_subnet" : {
"subnet" : "",
"subnet_uuid" : "aeiou",
"subnet6" : "",
"subnet6_uuid" : "aeiou",
"network_ref" : "aeiou"
},
"network_ref" : "aeiou",
"prefix_length" : 123,
"discovered_networks" : [ {
"subnet" : [ {
"ip_addr" : {
"addr" : "aeiou",
"type" : "aeiou"
},
"mask" : 123
} ],
"subnet6" : [ "" ],
"network_ref" : "aeiou"
} ]
} ],
"east_west_placement" : true,
"uuid" : "aeiou",
"url" : "aeiou"
},
"uuid" : "aeiou",
"url" : "aeiou",
"_last_modified" : "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
VsvipInventory
401
log in failed
Up
delete /vsvipinventory/{uuid}
(vsvipinventoryUuidDelete)
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 /vsvipinventory/{uuid}
(vsvipinventoryUuidGet)
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
{
"runtime" : {
"percent_ses_up" : 123,
"num_se_requested" : 123,
"service_engine" : [ {
"mgmt_ip6" : "",
"standby" : true,
"mgmt_ip" : "",
"scalein_in_progress" : true,
"se_ready_in_progress" : true,
"admin_down_requested" : true,
"oper_status" : "",
"connected" : true,
"active_on_cloud" : true,
"ref" : "aeiou",
"snat_ip" : "",
"attach_ip_in_progress" : true,
"name" : "aeiou",
"scaleout_in_progress" : true,
"detach_ip_in_progress" : true,
"active_on_se" : true,
"primary" : true
} ],
"num_se_assigned" : 123,
"vip_id" : "aeiou",
"oper_status" : {
"reason_code" : 123456789,
"reason" : [ "aeiou" ],
"last_changed_time" : {
"usecs" : 123456789,
"secs" : 123456789
},
"state" : "aeiou",
"reason_code_string" : "aeiou"
}
},
"config" : {
"vrf_context_ref" : "aeiou",
"virtualservices" : [ {
"ref" : "aeiou"
} ],
"cloud_ref" : "aeiou",
"tenant_ref" : "aeiou",
"name" : "aeiou",
"vip" : [ {
"availability_zone" : "aeiou",
"ip6_address" : "",
"subnet" : "",
"port_uuid" : "aeiou",
"subnet_uuid" : "aeiou",
"placement_networks" : [ {
"subnet" : "",
"subnet6" : "",
"network_ref" : "aeiou"
} ],
"avi_allocated_vip" : true,
"vip_id" : "aeiou",
"ip_address" : "",
"auto_allocate_floating_ip" : true,
"enabled" : true,
"auto_allocate_ip_type" : "aeiou",
"floating_subnet6_uuid" : "aeiou",
"auto_allocate_ip" : true,
"subnet6" : "",
"floating_ip" : "",
"floating_subnet_uuid" : "aeiou",
"avi_allocated_fip" : true,
"subnet6_uuid" : "aeiou",
"floating_ip6" : "",
"ipam_network_subnet" : {
"subnet" : "",
"subnet_uuid" : "aeiou",
"subnet6" : "",
"subnet6_uuid" : "aeiou",
"network_ref" : "aeiou"
},
"network_ref" : "aeiou",
"prefix_length" : 123,
"discovered_networks" : [ {
"subnet" : [ {
"ip_addr" : {
"addr" : "aeiou",
"type" : "aeiou"
},
"mask" : 123
} ],
"subnet6" : [ "" ],
"network_ref" : "aeiou"
} ]
} ],
"east_west_placement" : true,
"uuid" : "aeiou",
"url" : "aeiou"
},
"uuid" : "aeiou",
"url" : "aeiou",
"_last_modified" : "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
VsvipInventory
401
log in failed
Up
patch /vsvipinventory/{uuid}
(vsvipinventoryUuidPatch)
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 — VsvipInventory object creation
Query parameters
name (optional)
Query Parameter — object name
Return type
Example data
Content-Type: application/json
{
"runtime" : {
"percent_ses_up" : 123,
"num_se_requested" : 123,
"service_engine" : [ {
"mgmt_ip6" : "",
"standby" : true,
"mgmt_ip" : "",
"scalein_in_progress" : true,
"se_ready_in_progress" : true,
"admin_down_requested" : true,
"oper_status" : "",
"connected" : true,
"active_on_cloud" : true,
"ref" : "aeiou",
"snat_ip" : "",
"attach_ip_in_progress" : true,
"name" : "aeiou",
"scaleout_in_progress" : true,
"detach_ip_in_progress" : true,
"active_on_se" : true,
"primary" : true
} ],
"num_se_assigned" : 123,
"vip_id" : "aeiou",
"oper_status" : {
"reason_code" : 123456789,
"reason" : [ "aeiou" ],
"last_changed_time" : {
"usecs" : 123456789,
"secs" : 123456789
},
"state" : "aeiou",
"reason_code_string" : "aeiou"
}
},
"config" : {
"vrf_context_ref" : "aeiou",
"virtualservices" : [ {
"ref" : "aeiou"
} ],
"cloud_ref" : "aeiou",
"tenant_ref" : "aeiou",
"name" : "aeiou",
"vip" : [ {
"availability_zone" : "aeiou",
"ip6_address" : "",
"subnet" : "",
"port_uuid" : "aeiou",
"subnet_uuid" : "aeiou",
"placement_networks" : [ {
"subnet" : "",
"subnet6" : "",
"network_ref" : "aeiou"
} ],
"avi_allocated_vip" : true,
"vip_id" : "aeiou",
"ip_address" : "",
"auto_allocate_floating_ip" : true,
"enabled" : true,
"auto_allocate_ip_type" : "aeiou",
"floating_subnet6_uuid" : "aeiou",
"auto_allocate_ip" : true,
"subnet6" : "",
"floating_ip" : "",
"floating_subnet_uuid" : "aeiou",
"avi_allocated_fip" : true,
"subnet6_uuid" : "aeiou",
"floating_ip6" : "",
"ipam_network_subnet" : {
"subnet" : "",
"subnet_uuid" : "aeiou",
"subnet6" : "",
"subnet6_uuid" : "aeiou",
"network_ref" : "aeiou"
},
"network_ref" : "aeiou",
"prefix_length" : 123,
"discovered_networks" : [ {
"subnet" : [ {
"ip_addr" : {
"addr" : "aeiou",
"type" : "aeiou"
},
"mask" : 123
} ],
"subnet6" : [ "" ],
"network_ref" : "aeiou"
} ]
} ],
"east_west_placement" : true,
"uuid" : "aeiou",
"url" : "aeiou"
},
"uuid" : "aeiou",
"url" : "aeiou",
"_last_modified" : "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
VsvipInventory
401
log in failed
Up
put /vsvipinventory/{uuid}
(vsvipinventoryUuidPut)
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 — VsvipInventory object creation
Query parameters
name (optional)
Query Parameter — object name
Return type
Example data
Content-Type: application/json
{
"runtime" : {
"percent_ses_up" : 123,
"num_se_requested" : 123,
"service_engine" : [ {
"mgmt_ip6" : "",
"standby" : true,
"mgmt_ip" : "",
"scalein_in_progress" : true,
"se_ready_in_progress" : true,
"admin_down_requested" : true,
"oper_status" : "",
"connected" : true,
"active_on_cloud" : true,
"ref" : "aeiou",
"snat_ip" : "",
"attach_ip_in_progress" : true,
"name" : "aeiou",
"scaleout_in_progress" : true,
"detach_ip_in_progress" : true,
"active_on_se" : true,
"primary" : true
} ],
"num_se_assigned" : 123,
"vip_id" : "aeiou",
"oper_status" : {
"reason_code" : 123456789,
"reason" : [ "aeiou" ],
"last_changed_time" : {
"usecs" : 123456789,
"secs" : 123456789
},
"state" : "aeiou",
"reason_code_string" : "aeiou"
}
},
"config" : {
"vrf_context_ref" : "aeiou",
"virtualservices" : [ {
"ref" : "aeiou"
} ],
"cloud_ref" : "aeiou",
"tenant_ref" : "aeiou",
"name" : "aeiou",
"vip" : [ {
"availability_zone" : "aeiou",
"ip6_address" : "",
"subnet" : "",
"port_uuid" : "aeiou",
"subnet_uuid" : "aeiou",
"placement_networks" : [ {
"subnet" : "",
"subnet6" : "",
"network_ref" : "aeiou"
} ],
"avi_allocated_vip" : true,
"vip_id" : "aeiou",
"ip_address" : "",
"auto_allocate_floating_ip" : true,
"enabled" : true,
"auto_allocate_ip_type" : "aeiou",
"floating_subnet6_uuid" : "aeiou",
"auto_allocate_ip" : true,
"subnet6" : "",
"floating_ip" : "",
"floating_subnet_uuid" : "aeiou",
"avi_allocated_fip" : true,
"subnet6_uuid" : "aeiou",
"floating_ip6" : "",
"ipam_network_subnet" : {
"subnet" : "",
"subnet_uuid" : "aeiou",
"subnet6" : "",
"subnet6_uuid" : "aeiou",
"network_ref" : "aeiou"
},
"network_ref" : "aeiou",
"prefix_length" : 123,
"discovered_networks" : [ {
"subnet" : [ {
"ip_addr" : {
"addr" : "aeiou",
"type" : "aeiou"
},
"mask" : 123
} ],
"subnet6" : [ "" ],
"network_ref" : "aeiou"
} ]
} ],
"east_west_placement" : true,
"uuid" : "aeiou",
"url" : "aeiou"
},
"uuid" : "aeiou",
"url" : "aeiou",
"_last_modified" : "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
VsvipInventory
401
log in failed
[ Jump to Methods ]
Table of Contents
DiscoveredNetworkIPNetworkSubnetIpAddrIpAddrPrefixOperationalStatusTimeStampVipVipPlacementNetworkVipSeAssignedVsRefsVsvipConfigVsvipConfigApiResponseVsvipInventoryVsvipInventoryApiResponseVsvipRuntimeSummary
network_ref
String Discovered network for this IP. It is a reference to an object of type Network. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
subnet (optional)
array[IpAddrPrefix] Discovered subnet for this IP. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
subnet6 (optional)
array[IpAddrPrefix] Discovered IPv6 subnet for this IP. Field introduced in 18.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
network_ref (optional)
String Network for VirtualService IP allocation with Vantage as the IPAM provider. Network should be created before this is configured. It is a reference to an object of type Network. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
subnet (optional)
IpAddrPrefix Subnet for VirtualService IP allocation with Vantage or Infoblox as the IPAM provider. Only one of subnet or subnet_uuid configuration is allowed. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
subnet6 (optional)
IpAddrPrefix Subnet for VirtualService IPv6 allocation with Vantage or Infoblox as the IPAM provider. Only one of subnet or subnet_uuid configuration is allowed. Field introduced in 18.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
subnet6_uuid (optional)
String Subnet UUID or Name or Prefix for VirtualService IPv6 allocation with AWS or OpenStack as the IPAM provider. Only one of subnet or subnet_uuid configuration is allowed. Field introduced in 18.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
subnet_uuid (optional)
String Subnet UUID or Name or Prefix for VirtualService IP allocation with AWS or OpenStack as the IPAM provider. Only one of subnet or subnet_uuid configuration is allowed. Allowed in Enterprise edition with any value, 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
last_changed_time (optional)
TimeStamp Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
reason (optional)
array[String] Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
reason_code (optional)
Long Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int64
reason_code_string (optional)
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
state (optional)
String Enum options - OPER_UP, OPER_DOWN, OPER_CREATING, OPER_RESOURCES, OPER_INACTIVE, OPER_DISABLED, OPER_UNUSED, OPER_UNKNOWN, OPER_PROCESSING, OPER_INITIALIZING, OPER_ERROR_DISABLED, OPER_AWAIT_MANUAL_PLACEMENT, OPER_UPGRADING, OPER_SE_PROCESSING, OPER_PARTITIONED, OPER_DISABLING, OPER_FAILED, OPER_UNAVAIL, OPER_AGGREGATE_DOWN. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
secs
Long Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int64
usecs
Long Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int64
auto_allocate_floating_ip (optional)
Boolean Auto-allocate floating/elastic IP from the Cloud infrastructure. Field introduced in 17.1.1. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- false), Basic edition(Allowed values- false), Enterprise with Cloud Services edition.
auto_allocate_ip (optional)
Boolean Auto-allocate VIP from the provided subnet. Field introduced in 17.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
auto_allocate_ip_type (optional)
String Specifies whether to auto-allocate only a V4 address, only a V6 address, or one of each type. Enum options - V4_ONLY, V6_ONLY, V4_V6. Field introduced in 18.1.1. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- V4_ONLY), Basic edition(Allowed values- V4_ONLY), Enterprise with Cloud Services edition.
availability_zone (optional)
String Availability-zone to place the Virtual Service. Field introduced in 17.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
avi_allocated_fip (optional)
Boolean (internal-use) FIP allocated by Avi in the Cloud infrastructure. Field introduced in 17.1.1. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- false), Basic edition(Allowed values- false), Enterprise with Cloud Services edition.
avi_allocated_vip (optional)
Boolean (internal-use) VIP allocated by Avi in the Cloud infrastructure. Field introduced in 17.1.1. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- false), Basic edition(Allowed values- false), Enterprise with Cloud Services edition.
discovered_networks (optional)
array[DiscoveredNetwork] Discovered networks providing reachability for client facing Vip IP. Field introduced in 17.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
enabled (optional)
Boolean Enable or disable the Vip. Field introduced in 17.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
floating_ip (optional)
IpAddr Floating IPv4 to associate with this Vip. Field introduced in 17.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
floating_ip6 (optional)
IpAddr Floating IPv6 address to associate with this Vip. Field introduced in 18.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
floating_subnet6_uuid (optional)
String If auto_allocate_floating_ip is True and more than one floating-ip subnets exist, then the subnet for the floating IPv6 address allocation. Field introduced in 18.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
floating_subnet_uuid (optional)
String If auto_allocate_floating_ip is True and more than one floating-ip subnets exist, then the subnet for the floating IP address allocation. Field introduced in 17.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
ip6_address (optional)
IpAddr IPv6 Address of the Vip. Field introduced in 18.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
ip_address (optional)
IpAddr IPv4 Address of the VIP. Field introduced in 17.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
ipam_network_subnet (optional)
IPNetworkSubnet Subnet and/or Network for allocating VirtualService IP by IPAM Provider module. Field introduced in 17.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
network_ref (optional)
String Manually override the network on which the Vip is placed. It is a reference to an object of type Network. Field introduced in 17.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
placement_networks (optional)
array[VipPlacementNetwork] Placement networks/subnets to use for vip placement. Field introduced in 18.2.5. Maximum of 10 items allowed. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
port_uuid (optional)
String (internal-use) Network port assigned to the Vip IP address. Field introduced in 17.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
prefix_length (optional)
Integer Mask applied for the Vip, non-default mask supported only for wildcard Vip. Allowed values are 0-32. Field introduced in 20.1.1. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- 32), Basic edition(Allowed values- 32), Enterprise with Cloud Services edition. format: int32
subnet (optional)
IpAddrPrefix Subnet providing reachability for client facing Vip IP. Field introduced in 17.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
subnet6 (optional)
IpAddrPrefix Subnet providing reachability for client facing Vip IPv6. Field introduced in 18.1.1. Allowed in Enterprise edition with any value, Basic, Enterprise with Cloud Services edition.
subnet6_uuid (optional)
String If auto_allocate_ip is True, then the subnet for the Vip IPv6 address allocation. This field is applicable only if the VirtualService belongs to an Openstack or AWS cloud, in which case it is mandatory, if auto_allocate is selected. Field introduced in 18.1.1. Allowed in Enterprise edition with any value, Basic, Enterprise with Cloud Services edition.
subnet_uuid (optional)
String If auto_allocate_ip is True, then the subnet for the Vip IP address allocation. This field is applicable only if the VirtualService belongs to an Openstack or AWS cloud, in which case it is mandatory, if auto_allocate is selected. Field introduced in 17.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
vip_id
String Unique ID associated with the vip. Field introduced in 17.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
network_ref (optional)
String Network to use for vip placement. It is a reference to an object of type Network. Field introduced in 18.2.5. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
subnet (optional)
IpAddrPrefix IPv4 Subnet to use for vip placement. Field introduced in 18.2.5. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
subnet6 (optional)
IpAddrPrefix IPv6 subnet to use for vip placement. Field introduced in 18.2.5. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
active_on_cloud (optional)
Boolean Vip is Active on Cloud. Field introduced in 21.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
active_on_se (optional)
Boolean Vip is Active on this ServiceEngine. Field introduced in 21.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
admin_down_requested (optional)
Boolean Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
attach_ip_in_progress (optional)
Boolean Attach IP is in progress. Field introduced in 21.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
connected (optional)
Boolean Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
detach_ip_in_progress (optional)
Boolean Detach IP is in progress. Field introduced in 21.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
mgmt_ip (optional)
IpAddr Management IPv4 address of SE. Field introduced in 20.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
mgmt_ip6 (optional)
IpAddr Management IPv6 address of SE. Field introduced in 20.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
name (optional)
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
oper_status (optional)
OperationalStatus Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
primary (optional)
Boolean Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
ref (optional)
String It is a reference to an object of type ServiceEngine. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
scalein_in_progress (optional)
Boolean Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
scaleout_in_progress (optional)
Boolean Vip is awaiting scaleout response from this ServiceEngine. Field introduced in 21.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
se_ready_in_progress (optional)
Boolean Vip is awaiting response from this ServiceEngine. Field introduced in 21.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
snat_ip (optional)
IpAddr Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
standby (optional)
Boolean Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
ref (optional)
String UUID of the Virtual Service. It is a reference to an object of type VirtualService. Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
cloud_ref (optional)
String It is a reference to an object of type Cloud. Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
east_west_placement (optional)
Boolean Force placement on all Service Engines in the Service Engine Group (Container clouds only). Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
name
String Name for the VsVip object. Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
tenant_ref (optional)
String It is a reference to an object of type Tenant. Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
url (optional)
String URL of the VsVip. Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
uuid (optional)
String UUID of the VsVip object. Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
vip (optional)
array[Vip] List of Virtual Service IPs and other shareable entities. Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
virtualservices (optional)
array[VsRefs] List of virtual services the pool is assigned to. Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
vrf_context_ref (optional)
String Virtual Routing Context that the Virtual Service is bound to. This is used to provide the isolation of the set of networks the application is attached to. It is a reference to an object of type VrfContext. Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
count
results
next (optional)
_last_modified (optional)
String UNIX time since epoch in microseconds. Units(MICROSECONDS).
config
VsvipConfig Configuration summary of the vsvip. Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
runtime (optional)
VsvipRuntimeSummary Runtime summary of the vsvip. Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
url (optional)
uuid (optional)
String UUID of the vsvip. Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
count
results
next (optional)
num_se_assigned (optional)
Integer Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition. format: int32
num_se_requested (optional)
Integer Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition. format: int32
oper_status (optional)
OperationalStatus Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
percent_ses_up (optional)
Integer Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition. format: int32
service_engine (optional)
array[VipSeAssigned] Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
vip_id
String This field is used to uniquely identify the vip. Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.