VsVip

Description

API


    POST /api/vsvip
    PUT /api/vsvip/&ltkey>
    DELETE /api/vsvip/&ltkey>
    GET /api/vsvip
    GET /api/vsvip/&ltkey>

CLI


    configure vsvip &ltkey>
    show vsvip &ltkey>

Data

VsVip

uuid

Type
string
Category
required
Description
UUID of the VsVip object.

name

Type
string
Category
required
Description
Name for the VsVip object.

vip

Type
Vip
Category
repeated
Description
List of Virtual Service IPs and other shareable entities.

dns_info

Type
DnsInfo
Category
repeated
Description
Service discovery specific data including fully qualified domain name, type and Time-To-Live of the DNS record.

vrf_context_ref

Type
Reference to VrfContext
Category
optional
Description
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.

east_west_placement

Type
bool
Category
optional
Description
Force placement on all Service Engines in the Service Engine Group (Container clouds only)
Default
False

tenant_ref

Type
Reference to Tenant
Category
required
Description

cloud_ref

Type
Reference to Cloud
Category
optional,readonly
Description
Default
/api/cloud?name=Default-Cloud

Vip

vip_id

Type
string
Category
optional
Description
Unique ID associated with the vip.

ip_address

Type
IpAddr
Category
optional
Description
IP Address of the Vip.

enabled

Type
bool
Category
optional
Description
Enable or disable the Vip.
Default
True

network_ref

Type
Reference to Network
Category
optional
Description
Manually override the network on which the Vip is placed.

port_uuid

Type
string
Category
optional
Description
(internal-use) Network port assigned to the Vip IP address.

subnet_uuid

Type
string
Category
optional
Description
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.

subnet

Type
IpAddrPrefix
Category
optional
Description
Subnet providing reachability for client facing Vip IP.

discovered_networks

Type
DiscoveredNetwork
Category
repeated
Description
Discovered networks providing reachability for client facing Vip IP.

availability_zone

Type
string
Category
optional
Description
Availability-zone to place the Virtual Service.

auto_allocate_ip

Type
bool
Category
optional
Description
Auto-allocate VIP from the provided subnet.
Default
False

floating_ip

Type
IpAddr
Category
optional
Description
Floating IP to associate with this Vip.

auto_allocate_floating_ip

Type
bool
Category
optional
Description
Auto-allocate floating/elastic IP from the Cloud infrastructure.
Default
False

floating_subnet_uuid

Type
string
Category
optional
Description
If auto_allocate_floating_ip is True and more than one floating-ip subnets exist, then the subnet for the floating IP address allocation.

avi_allocated_vip

Type
bool
Category
optional
Description
(internal-use) VIP allocated by Avi in the Cloud infrastructure.
Default
False

avi_allocated_fip

Type
bool
Category
optional
Description
(internal-use) FIP allocated by Avi in the Cloud infrastructure.
Default
False

ipam_network_subnet

Type
IPNetworkSubnet
Category
optional
Description
Subnet and/or Network for allocating VirtualService IP by IPAM Provider module.

IpAddr

addr

Type
string
Category
required
Description
IP address

type

Type
enum
Category
required
Description
Choices
V4, DNS

IpAddrPrefix

ip_addr

Type
IpAddr
Category
required
Description

mask

Type
int32
Category
required
Description

DiscoveredNetwork

network_ref

Type
Reference to Network
Category
required
Description
Discovered network for this IP.

subnet

Type
IpAddrPrefix
Category
repeated
Description
Discovered subnet for this IP.

IPNetworkSubnet

network_ref

Type
Reference to Network
Category
optional
Description
Network for VirtualService IP allocation with Vantage as the IPAM provider. Network should be created before this is configured.

subnet

Type
IpAddrPrefix
Category
optional
Description
Subnet for VirtualService IP allocation with Vantage or Infoblox as the IPAM provider. Only one of subnet or subnet_uuid configuration is allowed.

subnet_uuid

Type
string
Category
optional
Description
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.

DnsInfo

fqdn

Type
string
Category
optional
Description
Fully qualified domain name.

ttl

Type
uint32
Category
optional
Description
Time to live for fqdn record. Default value is chosen from DNS profile for this cloud if no value provided.

type

Type
enum
Category
optional
Description
DNS record type
Default
DNS_RECORD_A
Choices
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

num_records_in_response

Type
uint32
Category
optional
Description
Specifies the number of records returned for this FQDN. Enter 0 to return all records. Default is 0
Default
1

algorithm

Type
enum
Category
optional
Description
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.
Default
DNS_RECORD_RESPONSE_CONSISTENT_HASH
Choices
DNS_RECORD_RESPONSE_ROUND_ROBIN, DNS_RECORD_RESPONSE_CONSISTENT_HASH

References

Cloud Network Tenant VrfContext

Sub Objects