ALBVip (schema)

Vip

Advanced load balancer Vip object
Name Description Type Notes
auto_allocate_floating_ip Auto allocate floating ip

Auto-allocate floating/elastic IP from the Cloud
infrastructure.
Default value when not specified in API or module is
interpreted by ALB Controller as false.
boolean Default: "False"
auto_allocate_ip Auto allocate ip

Auto-allocate VIP from the provided subnet.
Default value when not specified in API or module is
interpreted by ALB Controller as false.
boolean Default: "False"
auto_allocate_ip_type Auto allocate ip type

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.
Default value when not specified in API or module is
interpreted by ALB Controller as V4_ONLY.
ALBIpAddressVersions Default: "V4_ONLY"
availability_zone Availability zone

Availability-zone to place the Virtual Service.
string
avi_allocated_fip Avi allocated fip

(internal-use) FIP allocated by Avi in the Cloud
infrastructure.
Default value when not specified in API or module is
interpreted by ALB Controller as false.
boolean Default: "False"
avi_allocated_vip Avi allocated vip

(internal-use) VIP allocated by Avi in the Cloud
infrastructure.
Default value when not specified in API or module is
interpreted by ALB Controller as false.
boolean Default: "False"
discovered_networks Discovered networks

Discovered networks providing reachability for client
facing Vip IP.
array of ALBDiscoveredNetwork
enabled Enabled

Enable or disable the Vip.
Default value when not specified in API or module is
interpreted by ALB Controller as true.
boolean Default: "True"
floating_ip Floating ip

Floating IPv4 to associate with this Vip.
ALBIpAddr
floating_ip6 Floating ip6

Floating IPv6 address to associate with this Vip.
ALBIpAddr
floating_subnet6_uuid Floating subnet6 uuid

If auto_allocate_floating_ip is True and more than one
floating-ip subnets exist, then the subnet for the floating
IPv6 address allocation.
string
floating_subnet_uuid Floating subnet uuid

If auto_allocate_floating_ip is True and more than one
floating-ip subnets exist, then the subnet for the floating
IP address allocation.
string
ip6_address Ip6 address

IPv6 Address of the Vip.
ALBIpAddr
ip_address Ip address

IPv4 Address of the VIP.
ALBIpAddr
ipam_network_subnet Ipam network subnet

Subnet and/or Network for allocating VirtualService IP by
IPAM Provider module.
ALBIPNetworkSubnet
network_path Network path

Manually override the network on which the Vip is placed.
It is a reference to an object of type Network.
string
placement_networks Placement networks

Placement networks/subnets to use for vip placement.
Maximum of 10 items allowed.
array of ALBVipPlacementNetwork
port_uuid Port uuid

(internal-use) Network port assigned to the Vip IP address.
string
prefix_length Prefix length

Mask applied for the Vip, non-default mask supported only
for wildcard Vip.
Allowed values are 0-32.
Default value when not specified in API or module is
interpreted by ALB Controller as 32.
integer Minimum: 0
Maximum: 32
Default: "32"
subnet Subnet

Subnet providing reachability for client facing Vip IP.
ALBIpAddrPrefix
subnet6 Subnet6

Subnet providing reachability for client facing Vip IPv6.
ALBIpAddrPrefix
subnet6_uuid Subnet6 uuid

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.
string
subnet_uuid Subnet uuid

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.
string
vip_id Vip id

Unique ID associated with the vip.
string Required