Vip

Vip
Vip
JSON Example
{
    "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"
}
boolean
auto_allocate_floating_ip
Optional

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.

boolean
auto_allocate_ip
Optional

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.

string
auto_allocate_ip_type
Optional
Constraints: default: V4_ONLY

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.

string
availability_zone
Optional

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.

boolean
avi_allocated_fip
Optional

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

boolean
avi_allocated_vip
Optional

(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

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.

boolean
enabled
Optional
Constraints: default: true

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

floating_ip

floating_ip6
Optional

floating_ip6

string
floating_subnet6_uuid
Optional

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.

string
floating_subnet_uuid
Optional

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

ip6_address

ip_address
Optional

ip_address

ipam_network_subnet
Optional

ipam_network_subnet

string
network_ref
Optional

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

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.

string
port_uuid
Optional

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

integer As uint32 As uint32
prefix_length
Optional
Constraints: default: 32

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.

subnet
Optional

subnet

subnet6
Optional

subnet6

string
subnet6_uuid
Optional

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.

string
subnet_uuid
Optional

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.

string
vip_id
Required

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.