{
"additionalProperties": false,
"description": "Advanced load balancer Vip object",
"id": "ALBVip",
"module_id": "PolicyAdvancedLoadBalancer",
"properties": {
"auto_allocate_floating_ip": {
"default": false,
"description": "Auto-allocate floating/elastic IP from the Cloud infrastructure. Allowed in Basic(Allowed values- false) edition, Essentials(Allowed values- false) edition, Enterprise edition. Default value when not specified in API or module is interpreted by ALB Controller as false.",
"required": false,
"title": "Auto allocate floating ip",
"type": "boolean"
},
"auto_allocate_ip": {
"default": false,
"description": "Auto-allocate VIP from the provided subnet. Default value when not specified in API or module is interpreted by ALB Controller as false.",
"required": false,
"title": "Auto allocate ip",
"type": "boolean"
},
"auto_allocate_ip_type": {
"$ref": "ALBIpAddressVersions,
"default": "V4_ONLY",
"description": "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. Allowed in Basic(Allowed values- V4_ONLY) edition, Essentials(Allowed values- V4_ONLY) edition, Enterprise edition. Default value when not specified in API or module is interpreted by ALB Controller as V4_ONLY.",
"required": false,
"title": "Auto allocate ip type"
},
"availability_zone": {
"description": "Availability-zone to place the Virtual Service. Allowed in Basic edition, Essentials edition, Enterprise edition.",
"required": false,
"title": "Availability zone",
"type": "string"
},
"avi_allocated_fip": {
"default": false,
"description": "(internal-use) FIP allocated by Avi in the Cloud infrastructure. Allowed in Basic(Allowed values- false) edition, Essentials(Allowed values- false) edition, Enterprise edition. Default value when not specified in API or module is interpreted by ALB Controller as false.",
"required": false,
"title": "Avi allocated fip",
"type": "boolean"
},
"avi_allocated_vip": {
"default": false,
"description": "(internal-use) VIP allocated by Avi in the Cloud infrastructure. Allowed in Basic(Allowed values- false) edition, Essentials(Allowed values- false) edition, Enterprise edition. Default value when not specified in API or module is interpreted by ALB Controller as false.",
"required": false,
"title": "Avi allocated vip",
"type": "boolean"
},
"discovered_networks": {
"description": "Discovered networks providing reachability for client facing Vip IP.",
"items": {
"$ref": "ALBDiscoveredNetwork
},
"required": false,
"title": "Discovered networks",
"type": "array"
},
"enabled": {
"default": true,
"description": "Enable or disable the Vip. Default value when not specified in API or module is interpreted by ALB Controller as true.",
"required": false,
"title": "Enabled",
"type": "boolean"
},
"floating_ip": {
"$ref": "ALBIpAddr,
"description": "Floating IPv4 to associate with this Vip. Allowed in Basic edition, Essentials edition, Enterprise edition.",
"required": false,
"title": "Floating ip"
},
"floating_ip6": {
"$ref": "ALBIpAddr,
"description": "Floating IPv6 address to associate with this Vip. Allowed in Basic edition, Essentials edition, Enterprise edition.",
"required": false,
"title": "Floating ip6"
},
"floating_subnet6_uuid": {
"description": "If auto_allocate_floating_ip is True and more than one floating-ip subnets exist, then the subnet for the floating IPv6 address allocation. Allowed in Basic edition, Essentials edition, Enterprise edition.",
"required": false,
"title": "Floating subnet6 uuid",
"type": "string"
},
"floating_subnet_uuid": {
"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. Allowed in Basic edition, Essentials edition, Enterprise edition.",
"required": false,
"title": "Floating subnet uuid",
"type": "string"
},
"ip6_address": {
"$ref": "ALBIpAddr,
"description": "IPv6 Address of the Vip.",
"required": false,
"title": "Ip6 address"
},
"ip_address": {
"$ref": "ALBIpAddr,
"description": "IPv4 Address of the VIP.",
"required": false,
"title": "Ip address"
},
"ipam_network_subnet": {
"$ref": "ALBIPNetworkSubnet,
"description": "Subnet and/or Network for allocating VirtualService IP by IPAM Provider module.",
"required": false,
"title": "Ipam network subnet"
},
"network_name": {
"description": "Manually override the network on which the Vip is placed. It is a reference to an object of type Network.",
"required": false,
"title": "Network name",
"type": "string"
},
"placement_networks": {
"description": "Placement networks/subnets to use for vip placement. Maximum of 10 items allowed.",
"items": {
"$ref": "ALBVipPlacementNetwork
},
"required": false,
"title": "Placement networks",
"type": "array"
},
"port_uuid": {
"description": "(internal-use) Network port assigned to the Vip IP address.",
"required": false,
"title": "Port uuid",
"type": "string"
},
"prefix_length": {
"default": 32,
"description": "Mask applied for the Vip, non-default mask supported only for wildcard Vip. Allowed values are 0-32. Allowed in Basic(Allowed values- 32) edition, Essentials(Allowed values- 32) edition, Enterprise edition. Default value when not specified in API or module is interpreted by ALB Controller as 32.",
"maximum": 32,
"minimum": 0,
"required": false,
"title": "Prefix length",
"type": "integer"
},
"subnet": {
"$ref": "ALBIpAddrPrefix,
"description": "Subnet providing reachability for client facing Vip IP.",
"required": false,
"title": "Subnet"
},
"subnet6": {
"$ref": "ALBIpAddrPrefix,
"description": "Subnet providing reachability for client facing Vip IPv6. Allowed in Essentials edition, Enterprise edition.",
"required": false,
"title": "Subnet6"
},
"subnet6_uuid": {
"description": "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. Allowed in Essentials edition, Enterprise edition.",
"required": false,
"title": "Subnet6 uuid",
"type": "string"
},
"subnet_uuid": {
"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.",
"required": false,
"title": "Subnet uuid",
"type": "string"
},
"vip_id": {
"description": "Unique ID associated with the vip.",
"required": true,
"title": "Vip id",
"type": "string"
}
},
"title": "Vip",
"type": "object"
}