Avi VsVip Object API

##CLI## ``` - configure vsvip - show vsvip ```
More information: https://avinetworks.com/contact-us
Contact Info: support@avinetworks.com
Version: 17.2.4
BasePath:/api
All rights reserved
http://apache.org/licenses/LICENSE-2.0.html

Access

  1. HTTP Basic Authentication

Methods

[ Jump to Models ]

Table of Contents

  1. get /vsvip
  2. post /vsvip
  3. delete /vsvip/{uuid}
  4. get /vsvip/{uuid}
  5. patch /vsvip/{uuid}
  6. put /vsvip/{uuid}
Up
get /vsvip
( 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.
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

VsVipApiResponse

Example data

Content-Type: application/json
{
  "count" : 123,
  "results" : [ {
    "vrf_context_ref" : "aeiou",
    "cloud_ref" : "aeiou",
    "tenant_ref" : "aeiou",
    "dns_info" : [ {
      "metadata" : "aeiou",
      "fqdn" : "aeiou",
      "num_records_in_response" : 123,
      "cname" : {
        "cname" : "aeiou"
      },
      "type" : "aeiou",
      "ttl" : 123,
      "algorithm" : "aeiou"
    } ],
    "name" : "aeiou",
    "vip" : [ {
      "availability_zone" : "aeiou",
      "ip6_address" : "",
      "subnet" : "",
      "port_uuid" : "aeiou",
      "subnet_uuid" : "aeiou",
      "avi_allocated_vip" : true,
      "vip_id" : "aeiou",
      "ip_address" : "",
      "auto_allocate_floating_ip" : true,
      "enabled" : true,
      "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",
      "discovered_networks" : [ {
        "subnet" : [ {
          "ip_addr" : {
            "addr" : "aeiou",
            "type" : "aeiou"
          },
          "mask" : 123
        } ],
        "network_ref" : "aeiou"
      } ]
    } ],
    "east_west_placement" : true,
    "uuid" : "aeiou",
    "url" : "aeiou"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK VsVipApiResponse

401

log in failed

Up
post /vsvip
( 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

VsVip

Example data

Content-Type: application/json
{
  "vrf_context_ref" : "aeiou",
  "cloud_ref" : "aeiou",
  "tenant_ref" : "aeiou",
  "dns_info" : [ {
    "metadata" : "aeiou",
    "fqdn" : "aeiou",
    "num_records_in_response" : 123,
    "cname" : {
      "cname" : "aeiou"
    },
    "type" : "aeiou",
    "ttl" : 123,
    "algorithm" : "aeiou"
  } ],
  "name" : "aeiou",
  "vip" : [ {
    "availability_zone" : "aeiou",
    "ip6_address" : "",
    "subnet" : "",
    "port_uuid" : "aeiou",
    "subnet_uuid" : "aeiou",
    "avi_allocated_vip" : true,
    "vip_id" : "aeiou",
    "ip_address" : "",
    "auto_allocate_floating_ip" : true,
    "enabled" : true,
    "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",
    "discovered_networks" : [ {
      "subnet" : [ {
        "ip_addr" : {
          "addr" : "aeiou",
          "type" : "aeiou"
        },
        "mask" : 123
      } ],
      "network_ref" : "aeiou"
    } ]
  } ],
  "east_west_placement" : true,
  "uuid" : "aeiou",
  "url" : "aeiou"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK VsVip

401

log in failed

Up
delete /vsvip/{uuid}
( 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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

object deleted String

404

not found

Up
get /vsvip/{uuid}
( 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.
join_subresources (optional)
Query Parameter — It automatically returns additional dependent resources like runtime. Eg. join_subresources=runtime.

Return type

VsVip

Example data

Content-Type: application/json
{
  "vrf_context_ref" : "aeiou",
  "cloud_ref" : "aeiou",
  "tenant_ref" : "aeiou",
  "dns_info" : [ {
    "metadata" : "aeiou",
    "fqdn" : "aeiou",
    "num_records_in_response" : 123,
    "cname" : {
      "cname" : "aeiou"
    },
    "type" : "aeiou",
    "ttl" : 123,
    "algorithm" : "aeiou"
  } ],
  "name" : "aeiou",
  "vip" : [ {
    "availability_zone" : "aeiou",
    "ip6_address" : "",
    "subnet" : "",
    "port_uuid" : "aeiou",
    "subnet_uuid" : "aeiou",
    "avi_allocated_vip" : true,
    "vip_id" : "aeiou",
    "ip_address" : "",
    "auto_allocate_floating_ip" : true,
    "enabled" : true,
    "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",
    "discovered_networks" : [ {
      "subnet" : [ {
        "ip_addr" : {
          "addr" : "aeiou",
          "type" : "aeiou"
        },
        "mask" : 123
      } ],
      "network_ref" : "aeiou"
    } ]
  } ],
  "east_west_placement" : true,
  "uuid" : "aeiou",
  "url" : "aeiou"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK VsVip

401

log in failed

Up
patch /vsvip/{uuid}
( 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

VsVip

Example data

Content-Type: application/json
{
  "vrf_context_ref" : "aeiou",
  "cloud_ref" : "aeiou",
  "tenant_ref" : "aeiou",
  "dns_info" : [ {
    "metadata" : "aeiou",
    "fqdn" : "aeiou",
    "num_records_in_response" : 123,
    "cname" : {
      "cname" : "aeiou"
    },
    "type" : "aeiou",
    "ttl" : 123,
    "algorithm" : "aeiou"
  } ],
  "name" : "aeiou",
  "vip" : [ {
    "availability_zone" : "aeiou",
    "ip6_address" : "",
    "subnet" : "",
    "port_uuid" : "aeiou",
    "subnet_uuid" : "aeiou",
    "avi_allocated_vip" : true,
    "vip_id" : "aeiou",
    "ip_address" : "",
    "auto_allocate_floating_ip" : true,
    "enabled" : true,
    "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",
    "discovered_networks" : [ {
      "subnet" : [ {
        "ip_addr" : {
          "addr" : "aeiou",
          "type" : "aeiou"
        },
        "mask" : 123
      } ],
      "network_ref" : "aeiou"
    } ]
  } ],
  "east_west_placement" : true,
  "uuid" : "aeiou",
  "url" : "aeiou"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK VsVip

401

log in failed

Up
put /vsvip/{uuid}
( 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

VsVip

Example data

Content-Type: application/json
{
  "vrf_context_ref" : "aeiou",
  "cloud_ref" : "aeiou",
  "tenant_ref" : "aeiou",
  "dns_info" : [ {
    "metadata" : "aeiou",
    "fqdn" : "aeiou",
    "num_records_in_response" : 123,
    "cname" : {
      "cname" : "aeiou"
    },
    "type" : "aeiou",
    "ttl" : 123,
    "algorithm" : "aeiou"
  } ],
  "name" : "aeiou",
  "vip" : [ {
    "availability_zone" : "aeiou",
    "ip6_address" : "",
    "subnet" : "",
    "port_uuid" : "aeiou",
    "subnet_uuid" : "aeiou",
    "avi_allocated_vip" : true,
    "vip_id" : "aeiou",
    "ip_address" : "",
    "auto_allocate_floating_ip" : true,
    "enabled" : true,
    "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",
    "discovered_networks" : [ {
      "subnet" : [ {
        "ip_addr" : {
          "addr" : "aeiou",
          "type" : "aeiou"
        },
        "mask" : 123
      } ],
      "network_ref" : "aeiou"
    } ]
  } ],
  "east_west_placement" : true,
  "uuid" : "aeiou",
  "url" : "aeiou"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK VsVip

401

log in failed

Up

Models

[ Jump to Methods ]

Table of Contents

  1. DiscoveredNetwork
  2. DnsCnameRdata
  3. DnsInfo
  4. IPNetworkSubnet
  5. IpAddr
  6. IpAddrPrefix
  7. Vip
  8. VsVip
  9. VsVipApiResponse

DiscoveredNetwork Up

network_ref
String Discovered network for this IP. It is a reference to an object of type Network.
subnet (optional)
array[IpAddrPrefix] Discovered subnet for this IP.

DnsCnameRdata Up

cname
String Canonical name.

DnsInfo Up

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.

IPNetworkSubnet Up

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 17.2.1.
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 17.2.1.
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.

IpAddr Up

addr
String IP address.
type
String Enum options - V4, DNS.

IpAddrPrefix Up

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

Vip Up

auto_allocate_floating_ip (optional)
Boolean Auto-allocate floating/elastic IP from the Cloud infrastructure. Field introduced in 17.1.1.
auto_allocate_ip (optional)
Boolean Auto-allocate VIP from the provided subnet. Field introduced in 17.1.1.
availability_zone (optional)
String Availability-zone to place the Virtual Service. Field introduced in 17.1.1.
avi_allocated_fip (optional)
Boolean (internal-use) FIP allocated by Avi in the Cloud infrastructure. Field introduced in 17.1.1.
avi_allocated_vip (optional)
Boolean (internal-use) VIP allocated by Avi in the Cloud infrastructure. Field introduced in 17.1.1.
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.
floating_ip6 (optional)
IpAddr Floating IPv6 address to associate with this Vip. Field introduced in 17.2.1.
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 17.2.1.
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.
ip6_address (optional)
IpAddr IPv6 Address of the Vip. Field introduced in 17.2.1.
ip_address (optional)
IpAddr IPv4 Address of the Vip. For IPv6 address support please use ip6_address field. 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.
port_uuid (optional)
String (internal-use) Network port assigned to the Vip IP address. Field introduced in 17.1.1.
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 17.2.1.
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 17.2.1.
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.

VsVip Up

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.
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.
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.
url (optional)
String url
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.

VsVipApiResponse Up

count
Integer format: int32
results