Avi VsVip Object API
CLI ``` - configure vsvip - show vsvip ``` Examples - **vsvip_example_1**: To create a basic vsvip object ```json {'name': 'production_vsvip', 'vip': [{'subnet': {'ip_addr': {'addr': '10.10.10.0', 'type': 'V4'}}, 'auto_allocate_ip': True}], 'east_west_placement': False} ```
Contact Info: support@avinetworks.com
Version: 20.1.9
BasePath:/api
All rights reserved
http://apache.org/licenses/LICENSE-2.0.html
Access
- HTTP Basic Authentication
[ Jump to Models ]
Table of Contents
get /vsvippost /vsvipdelete /vsvip/{uuid}get /vsvip/{uuid}patch /vsvip/{uuid}put /vsvip/{uuid}
(vsvipGet)
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" : [ {
"use_standard_alb" : true,
"ipam_selector" : {
"type" : "aeiou",
"labels" : [ {
"value" : "aeiou",
"key" : "aeiou"
} ]
},
"vrf_context_ref" : "aeiou",
"dns_info" : [ {
"metadata" : "aeiou",
"fqdn" : "aeiou",
"num_records_in_response" : 123,
"cname" : {
"cname" : "aeiou"
},
"type" : "aeiou",
"ttl" : 123,
"algorithm" : "aeiou"
} ],
"uuid" : "aeiou",
"url" : "aeiou",
"_last_modified" : "aeiou",
"bgp_peer_labels" : [ "aeiou" ],
"labels" : [ {
"value" : "aeiou",
"key" : "aeiou"
} ],
"cloud_ref" : "aeiou",
"tenant_ref" : "aeiou",
"name" : "aeiou",
"tier1_lr" : "aeiou",
"markers" : [ {
"values" : [ "aeiou" ],
"key" : "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"
} ]
} ],
"vsvip_cloud_config_cksum" : "aeiou",
"east_west_placement" : 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
VsVipApiResponse
401
log in failed
(vsvipPost)
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (required)
Body Parameter — VsVip object creation
Return type
Example data
Content-Type: application/json
{
"use_standard_alb" : true,
"ipam_selector" : {
"type" : "aeiou",
"labels" : [ {
"value" : "aeiou",
"key" : "aeiou"
} ]
},
"vrf_context_ref" : "aeiou",
"dns_info" : [ {
"metadata" : "aeiou",
"fqdn" : "aeiou",
"num_records_in_response" : 123,
"cname" : {
"cname" : "aeiou"
},
"type" : "aeiou",
"ttl" : 123,
"algorithm" : "aeiou"
} ],
"uuid" : "aeiou",
"url" : "aeiou",
"_last_modified" : "aeiou",
"bgp_peer_labels" : [ "aeiou" ],
"labels" : [ {
"value" : "aeiou",
"key" : "aeiou"
} ],
"cloud_ref" : "aeiou",
"tenant_ref" : "aeiou",
"name" : "aeiou",
"tier1_lr" : "aeiou",
"markers" : [ {
"values" : [ "aeiou" ],
"key" : "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"
} ]
} ],
"vsvip_cloud_config_cksum" : "aeiou",
"east_west_placement" : 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
VsVip
401
log in failed
(vsvipUuidDelete)
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
(vsvipUuidGet)
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
{
"use_standard_alb" : true,
"ipam_selector" : {
"type" : "aeiou",
"labels" : [ {
"value" : "aeiou",
"key" : "aeiou"
} ]
},
"vrf_context_ref" : "aeiou",
"dns_info" : [ {
"metadata" : "aeiou",
"fqdn" : "aeiou",
"num_records_in_response" : 123,
"cname" : {
"cname" : "aeiou"
},
"type" : "aeiou",
"ttl" : 123,
"algorithm" : "aeiou"
} ],
"uuid" : "aeiou",
"url" : "aeiou",
"_last_modified" : "aeiou",
"bgp_peer_labels" : [ "aeiou" ],
"labels" : [ {
"value" : "aeiou",
"key" : "aeiou"
} ],
"cloud_ref" : "aeiou",
"tenant_ref" : "aeiou",
"name" : "aeiou",
"tier1_lr" : "aeiou",
"markers" : [ {
"values" : [ "aeiou" ],
"key" : "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"
} ]
} ],
"vsvip_cloud_config_cksum" : "aeiou",
"east_west_placement" : 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
VsVip
401
log in failed
(vsvipUuidPatch)
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 — VsVip object creation
Query parameters
name (optional)
Query Parameter — object name
Return type
Example data
Content-Type: application/json
{
"use_standard_alb" : true,
"ipam_selector" : {
"type" : "aeiou",
"labels" : [ {
"value" : "aeiou",
"key" : "aeiou"
} ]
},
"vrf_context_ref" : "aeiou",
"dns_info" : [ {
"metadata" : "aeiou",
"fqdn" : "aeiou",
"num_records_in_response" : 123,
"cname" : {
"cname" : "aeiou"
},
"type" : "aeiou",
"ttl" : 123,
"algorithm" : "aeiou"
} ],
"uuid" : "aeiou",
"url" : "aeiou",
"_last_modified" : "aeiou",
"bgp_peer_labels" : [ "aeiou" ],
"labels" : [ {
"value" : "aeiou",
"key" : "aeiou"
} ],
"cloud_ref" : "aeiou",
"tenant_ref" : "aeiou",
"name" : "aeiou",
"tier1_lr" : "aeiou",
"markers" : [ {
"values" : [ "aeiou" ],
"key" : "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"
} ]
} ],
"vsvip_cloud_config_cksum" : "aeiou",
"east_west_placement" : 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
VsVip
401
log in failed
(vsvipUuidPut)
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 — VsVip object creation
Query parameters
name (optional)
Query Parameter — object name
Return type
Example data
Content-Type: application/json
{
"use_standard_alb" : true,
"ipam_selector" : {
"type" : "aeiou",
"labels" : [ {
"value" : "aeiou",
"key" : "aeiou"
} ]
},
"vrf_context_ref" : "aeiou",
"dns_info" : [ {
"metadata" : "aeiou",
"fqdn" : "aeiou",
"num_records_in_response" : 123,
"cname" : {
"cname" : "aeiou"
},
"type" : "aeiou",
"ttl" : 123,
"algorithm" : "aeiou"
} ],
"uuid" : "aeiou",
"url" : "aeiou",
"_last_modified" : "aeiou",
"bgp_peer_labels" : [ "aeiou" ],
"labels" : [ {
"value" : "aeiou",
"key" : "aeiou"
} ],
"cloud_ref" : "aeiou",
"tenant_ref" : "aeiou",
"name" : "aeiou",
"tier1_lr" : "aeiou",
"markers" : [ {
"values" : [ "aeiou" ],
"key" : "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"
} ]
} ],
"vsvip_cloud_config_cksum" : "aeiou",
"east_west_placement" : 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
VsVip
401
log in failed
[ Jump to Methods ]
Table of Contents
DiscoveredNetworkDnsCnameRdataDnsInfoIPNetworkSubnetIpAddrIpAddrPrefixKeyValueKeyValueTupleRoleFilterMatchLabelSelectorVipVipPlacementNetworkVsVipVsVipApiResponse
network_ref
String Discovered network for this IP. It is a reference to an object of type Network.
subnet (optional)
subnet6 (optional)
algorithm (optional)
String Specifies the algorithm to pick the IP address(es) to be returned, when multiple entries are configured. This does not apply if num_records_in_response is 0. Default is consistent hash. Enum options - DNS_RECORD_RESPONSE_ROUND_ROBIN, DNS_RECORD_RESPONSE_CONSISTENT_HASH. Field introduced in 17.1.1.
cname (optional)
DnsCnameRdata Canonical name in CNAME record. Field introduced in 17.2.1.
fqdn (optional)
String Fully qualified domain name.
metadata (optional)
String Any metadata associated with this record. Field introduced in 17.2.2.
num_records_in_response (optional)
Integer Specifies the number of records returned for this FQDN. Enter 0 to return all records. Default is 0. Allowed values are 0-20. Special values are 0- 'Return all records'. Field introduced in 17.1.1. format: int32
ttl (optional)
Integer Time to live for fqdn record. Default value is chosen from DNS profile for this cloud if no value provided. format: int32
type (optional)
String DNS record type. Enum options - DNS_RECORD_OTHER, DNS_RECORD_A, DNS_RECORD_NS, DNS_RECORD_CNAME, DNS_RECORD_SOA, DNS_RECORD_PTR, DNS_RECORD_HINFO, DNS_RECORD_MX, DNS_RECORD_TXT, DNS_RECORD_RP, DNS_RECORD_DNSKEY, DNS_RECORD_AAAA, DNS_RECORD_SRV, DNS_RECORD_OPT, DNS_RECORD_RRSIG, DNS_RECORD_AXFR, DNS_RECORD_ANY.
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.
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.
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 Basic edition, Essentials edition, Enterprise 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 Basic edition, Essentials edition, Enterprise 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.
addr
type
String Enum options - V4, DNS, V6.
ip_addr
IpAddr Placeholder for description of property ip_addr of obj type IpAddrPrefix field type str type object
mask
Integer Number of mask. format: int32
key
String Key. Field introduced in 20.1.3.
value (optional)
String Value. Field introduced in 20.1.3.
key
String Key for filter match. Field introduced in 20.1.3.
values (optional)
array[String] Values for filter match. Multiple values will be evaluated as OR. Example key = value1 OR key = value2. Behavior for match is key = * if this field is empty. Field introduced in 20.1.3.
labels (optional)
array[KeyValueTuple] Labels as key value pairs to select on. Field introduced in 20.1.3. Minimum of 1 items required.
type
String Selector type. Enum options - SELECTOR_IPAM. Field introduced in 20.1.3.
auto_allocate_floating_ip (optional)
Boolean Auto-allocate floating/elastic IP from the Cloud infrastructure. Field introduced in 17.1.1. Allowed in Basic(Allowed values- false) edition, Essentials(Allowed values- false) edition, Enterprise edition.
auto_allocate_ip (optional)
Boolean Auto-allocate VIP from the provided subnet. Field introduced in 17.1.1.
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 Basic(Allowed values- V4_ONLY) edition, Essentials(Allowed values- V4_ONLY) edition, Enterprise edition.
availability_zone (optional)
String Availability-zone to place the Virtual Service. Field introduced in 17.1.1. Allowed in Basic edition, Essentials edition, Enterprise edition.
avi_allocated_fip (optional)
Boolean (internal-use) FIP allocated by Avi in the Cloud infrastructure. Field introduced in 17.1.1. Allowed in Basic(Allowed values- false) edition, Essentials(Allowed values- false) edition, Enterprise edition.
avi_allocated_vip (optional)
Boolean (internal-use) VIP allocated by Avi in the Cloud infrastructure. Field introduced in 17.1.1. Allowed in Basic(Allowed values- false) edition, Essentials(Allowed values- false) edition, Enterprise edition.
discovered_networks (optional)
array[DiscoveredNetwork] Discovered networks providing reachability for client facing Vip IP. Field introduced in 17.1.1.
enabled (optional)
Boolean Enable or disable the Vip. Field introduced in 17.1.1.
floating_ip (optional)
IpAddr Floating IPv4 to associate with this Vip. Field introduced in 17.1.1. Allowed in Basic edition, Essentials edition, Enterprise edition.
floating_ip6 (optional)
IpAddr Floating IPv6 address to associate with this Vip. Field introduced in 18.1.1. Allowed in Basic edition, Essentials edition, Enterprise 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 Basic edition, Essentials edition, Enterprise 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 Basic edition, Essentials edition, Enterprise edition.
ip6_address (optional)
IpAddr IPv6 Address of the Vip. Field introduced in 18.1.1.
ip_address (optional)
IpAddr IPv4 Address of the VIP. Field introduced in 17.1.1.
ipam_network_subnet (optional)
IPNetworkSubnet Subnet and/or Network for allocating VirtualService IP by IPAM Provider module. Field introduced in 17.1.1.
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.
placement_networks (optional)
array[VipPlacementNetwork] Placement networks/subnets to use for vip placement. Field introduced in 18.2.5. Maximum of 10 items allowed.
port_uuid (optional)
String (internal-use) Network port assigned to the Vip IP address. Field introduced in 17.1.1.
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 Basic(Allowed values- 32) edition, Essentials(Allowed values- 32) edition, Enterprise edition. format: int32
subnet (optional)
IpAddrPrefix Subnet providing reachability for client facing Vip IP. Field introduced in 17.1.1.
subnet6 (optional)
IpAddrPrefix Subnet providing reachability for client facing Vip IPv6. Field introduced in 18.1.1. Allowed in Essentials edition, Enterprise 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 Essentials edition, Enterprise 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.
vip_id
String Unique ID associated with the vip. Field introduced in 17.1.1.
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.
subnet (optional)
IpAddrPrefix IPv4 Subnet to use for vip placement. Field introduced in 18.2.5.
subnet6 (optional)
IpAddrPrefix IPv6 subnet to use for vip placement. Field introduced in 18.2.5.
_last_modified (optional)
String UNIX time since epoch in microseconds. Units(MICROSECONDS).
bgp_peer_labels (optional)
array[String] Select BGP peers, using peer label, for VsVip advertisement. Field introduced in 20.1.5. Maximum of 128 items allowed.
cloud_ref (optional)
String It is a reference to an object of type Cloud. Field introduced in 17.1.1.
dns_info (optional)
array[DnsInfo] Service discovery specific data including fully qualified domain name, type and Time-To-Live of the DNS record. Field introduced in 17.1.1. Maximum of 1000 items allowed. Allowed in Basic edition, Essentials edition, Enterprise edition.
east_west_placement (optional)
Boolean Force placement on all Service Engines in the Service Engine Group (Container clouds only). Field introduced in 17.1.1. Allowed in Basic(Allowed values- false) edition, Essentials(Allowed values- false) edition, Enterprise edition.
ipam_selector (optional)
Selector Determines the set of IPAM networks to use for this VsVip. Selector type must be SELECTOR_IPAM and only one label is supported. Field introduced in 20.1.3.
labels (optional)
array[KeyValue] Key value pairs for granular object access control. Also allows for classification and tagging of similar objects. Field deprecated in 20.1.5. Field introduced in 20.1.2. Maximum of 4 items allowed.
markers (optional)
array[RoleFilterMatchLabel] List of labels to be used for granular RBAC. Field introduced in 20.1.5. Allowed in Basic edition, Essentials edition, Enterprise edition.
name
String Name for the VsVip object. Field introduced in 17.1.1.
tenant_ref (optional)
String It is a reference to an object of type Tenant. Field introduced in 17.1.1.
tier1_lr (optional)
String This sets the placement scope of virtualservice to given tier1 logical router in Nsx-t. Field introduced in 20.1.1.
url (optional)
use_standard_alb (optional)
Boolean This overrides the cloud level default and needs to match the SE Group value in which it will be used if the SE Group use_standard_alb value is set. This is only used when FIP is used for VS on Azure Cloud. Field introduced in 18.2.3. Allowed in Basic edition, Essentials edition, Enterprise edition.
uuid (optional)
String UUID of the VsVip object. Field introduced in 17.1.1.
vip (optional)
array[Vip] List of Virtual Service IPs and other shareable entities. Field introduced in 17.1.1.
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 17.1.1.
vsvip_cloud_config_cksum (optional)
String Checksum of cloud configuration for VsVip. Internally set by cloud connector. Field introduced in 17.2.9, 18.1.2.
count
results
next (optional)