VsInventoryConfig

VsInventoryConfig
VsInventoryConfig
JSON Example
{
    "cloud_ref": "string",
    "dns_info": [
        {
            "algorithm": "string",
            "cname": {
                "cname": "string"
            },
            "fqdn": "string",
            "metadata": "string",
            "num_records_in_response": 0,
            "ttl": 0,
            "type": "string"
        }
    ],
    "east_west_placement": false,
    "enabled": false,
    "fqdn": "string",
    "name": "string",
    "pool_ref": "string",
    "se_group_ref": "string",
    "services": [
        {
            "enable_http2": false,
            "enable_ssl": false,
            "horizon_internal_ports": false,
            "is_active_ftp_data_port": false,
            "override_application_profile_ref": "string",
            "override_network_profile_ref": "string",
            "port": 0,
            "port_range_end": 0
        }
    ],
    "tenant_ref": "string",
    "type": "string",
    "url": "string",
    "uuid": "string",
    "vh_domain_name": [
        "string"
    ],
    "vip": [
        {
            "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"
        }
    ],
    "vrf_context_ref": "string",
    "vsvip_ref": "string"
}
string
cloud_ref
Optional

It is a reference to an object of type Cloud. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

array of DnsInfo
dns_info
Optional

Service discovery specific data including fully qualified domain name, type and Time-To-Live of the DNS record. Note that only one of fqdn and dns_info setting is allowed. Maximum of 1000 items allowed. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

boolean
east_west_placement
Optional

Force placement on all SE's in service group (Mesos mode only). Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

boolean
enabled
Optional
Constraints: default: true

Enable or disable the Virtual Service. Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

string
fqdn
Optional

DNS resolvable, fully qualified domain name of the virtualservice. Only one of 'fqdn' and 'dns_info' configuration is allowed. Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

string
name
Optional

Name for the Virtual Service. Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

string
pool_ref
Optional

The pool is an object that contains destination servers and related attributes such as load-balancing and persistence. It is a reference to an object of type Pool. Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

string
se_group_ref
Optional

The Service Engine Group to use for this Virtual Service. Moving to a new SE Group is disruptive to existing connections for this VS. It is a reference to an object of type ServiceEngineGroup. Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

array of Service
services
Optional

List of Services defined for this Virtual Service. Field introduced in 22.1.1. Maximum of 2048 items allowed. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

string
tenant_ref
Optional

It is a reference to an object of type Tenant. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

string
type
Optional
Constraints: default: VS_TYPE_NORMAL

Specify if this is a normal Virtual Service, or if it is the parent or child of an SNI-enabled virtual hosted Virtual Service. Enum options - VS_TYPE_NORMAL, VS_TYPE_VH_PARENT, VS_TYPE_VH_CHILD. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

string
url
Optional

URL of the Virtual Service. Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

string
uuid
Optional

UUID of the Virtual Service. Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

array of string
vh_domain_name
Optional

The exact name requested from the client's SNI-enabled TLS hello domain name field. If this is a match, the parent VS will forward the connection to this child VS. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

array of Vip
vip
Optional

List of Virtual Service IPs. While creating a 'Shared VS',please use vsvip_ref to point to the shared entities. Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

string
vrf_context_ref
Optional

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. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

string
vsvip_ref
Optional

Mostly used during the creation of Shared VS, this field refers to entities that can be shared across Virtual Services. It is a reference to an object of type VsVip. Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.