VirtualService

VirtualService
VirtualService
JSON Example
{
    "_last_modified": "string",
    "active_standby_se_tag": "string",
    "advertise_down_vs": false,
    "allow_invalid_client_cert": false,
    "analytics_policy": {
        "all_headers": false,
        "client_insights": "string",
        "client_insights_sampling": {
            "client_ip": {
                "addrs": [
                    {
                        "addr": "string",
                        "type": "string"
                    }
                ],
                "group_refs": [
                    "string"
                ],
                "match_criteria": "string",
                "prefixes": [
                    {
                        "ip_addr": {
                            "addr": "string",
                            "type": "string"
                        },
                        "mask": 0
                    }
                ],
                "ranges": [
                    {
                        "begin": {
                            "addr": "string",
                            "type": "string"
                        },
                        "end": {
                            "addr": "string",
                            "type": "string"
                        }
                    }
                ]
            },
            "sample_uris": {
                "match_criteria": "string",
                "match_str": [
                    "string"
                ],
                "string_group_refs": [
                    "string"
                ]
            },
            "skip_uris": {
                "match_criteria": "string",
                "match_str": [
                    "string"
                ],
                "string_group_refs": [
                    "string"
                ]
            }
        },
        "client_log_filters": [
            {
                "all_headers": false,
                "client_ip": {
                    "addrs": [
                        {
                            "addr": "string",
                            "type": "string"
                        }
                    ],
                    "group_refs": [
                        "string"
                    ],
                    "match_criteria": "string",
                    "prefixes": [
                        {
                            "ip_addr": {
                                "addr": "string",
                                "type": "string"
                            },
                            "mask": 0
                        }
                    ],
                    "ranges": [
                        {
                            "begin": {
                                "addr": "string",
                                "type": "string"
                            },
                            "end": {
                                "addr": "string",
                                "type": "string"
                            }
                        }
                    ]
                },
                "duration": 0,
                "enabled": false,
                "index": 0,
                "name": "string",
                "uri": {
                    "match_criteria": "string",
                    "match_str": [
                        "string"
                    ],
                    "string_group_refs": [
                        "string"
                    ]
                }
            }
        ],
        "full_client_logs": {
            "duration": 0,
            "enabled": false,
            "throttle": 0
        },
        "learning_log_policy": {
            "enabled": false,
            "host": "string",
            "port": 0
        },
        "metrics_realtime_update": {
            "duration": 0,
            "enabled": false
        },
        "significant_log_throttle": 0,
        "udf_log_throttle": 0
    },
    "analytics_profile_ref": "string",
    "application_profile_ref": "string",
    "azure_availability_set": "string",
    "bgp_local_preference": 0,
    "bgp_num_as_path_prepend": 0,
    "bgp_peer_labels": [
        "string"
    ],
    "bot_policy_ref": "string",
    "bulk_sync_kvcache": false,
    "close_client_conn_on_config_update": false,
    "cloud_config_cksum": "string",
    "cloud_ref": "string",
    "cloud_type": "string",
    "configpb_attributes": {
        "version": 0
    },
    "connections_rate_limit": {
        "action": {
            "file": {
                "content_type": "string",
                "file_content": "string",
                "file_length": 0
            },
            "redirect": {
                "add_string": "string",
                "host": {
                    "tokens": [
                        {
                            "end_index": 0,
                            "start_index": 0,
                            "str_value": "string",
                            "type": "string"
                        }
                    ],
                    "type": "string"
                },
                "keep_query": false,
                "path": {
                    "tokens": [
                        {
                            "end_index": 0,
                            "start_index": 0,
                            "str_value": "string",
                            "type": "string"
                        }
                    ],
                    "type": "string"
                },
                "port": 0,
                "protocol": "string",
                "status_code": "string"
            },
            "status_code": "string",
            "type": "string"
        },
        "explicit_tracking": false,
        "fine_grain": false,
        "http_cookie": "string",
        "http_header": "string",
        "rate_limiter": {
            "burst_sz": 0,
            "count": 0,
            "name": "string",
            "period": 0
        }
    },
    "content_rewrite": {
        "rewritable_content_ref": "string",
        "rsp_rewrite_rules": [
            {
                "enable": false,
                "index": 0,
                "name": "string",
                "pairs": [
                    {
                        "replacement_string": {
                            "type": "string",
                            "val": "string"
                        },
                        "search_string": {
                            "type": "string",
                            "val": "string"
                        }
                    }
                ]
            }
        ]
    },
    "created_by": "string",
    "csrf_policy_ref": "string",
    "delay_fairness": false,
    "description": "string",
    "dns_info": [
        {
            "algorithm": "string",
            "cname": {
                "cname": "string"
            },
            "fqdn": "string",
            "metadata": "string",
            "num_records_in_response": 0,
            "ttl": 0,
            "type": "string"
        }
    ],
    "dns_policies": [
        {
            "dns_policy_ref": "string",
            "index": 0
        }
    ],
    "east_west_placement": false,
    "enable_autogw": false,
    "enable_rhi": false,
    "enable_rhi_snat": false,
    "enable_session": false,
    "enabled": false,
    "error_page_profile_ref": "string",
    "flow_dist": "string",
    "flow_label_type": "string",
    "fqdn": "string",
    "host_name_xlate": "string",
    "http_policies": [
        {
            "http_policy_set_ref": "string",
            "index": 0
        }
    ],
    "icap_request_profile_refs": [
        "string"
    ],
    "ign_pool_net_reach": false,
    "jwt_config": {
        "audience": "string",
        "jwt_location": "string",
        "jwt_name": "string"
    },
    "l4_policies": [
        {
            "index": 0,
            "l4_policy_set_ref": "string"
        }
    ],
    "ldap_vs_config": {
        "realm": "string",
        "se_auth_ldap_bind_timeout": 0,
        "se_auth_ldap_cache_size": 0,
        "se_auth_ldap_connect_timeout": 0,
        "se_auth_ldap_conns_per_server": 0,
        "se_auth_ldap_reconnect_timeout": 0,
        "se_auth_ldap_request_timeout": 0,
        "se_auth_ldap_servers_failover_only": false
    },
    "limit_doser": false,
    "markers": [
        {
            "key": "string",
            "values": [
                "string"
            ]
        }
    ],
    "max_cps_per_client": 0,
    "microservice_ref": "string",
    "min_pools_up": 0,
    "name": "string",
    "network_profile_ref": "string",
    "network_security_policy_ref": "string",
    "nsx_securitygroup": [
        "string"
    ],
    "oauth_vs_config": {
        "cookie_name": "string",
        "cookie_timeout": 0,
        "key": [
            {
                "aes_key": "string",
                "hmac_key": "string",
                "name": "string"
            }
        ],
        "logout_uri": "string",
        "oauth_settings": [
            {
                "app_settings": {
                    "client_id": "string",
                    "client_secret": "string",
                    "oidc_config": {
                        "oidc_enable": false,
                        "profile": false,
                        "userinfo": false
                    },
                    "scopes": [
                        "string"
                    ]
                },
                "auth_profile_ref": "string",
                "resource_server": {
                    "access_type": "string",
                    "introspection_data_timeout": 0,
                    "jwt_params": {
                        "audience": "string"
                    },
                    "opaque_token_params": {
                        "server_id": "string",
                        "server_secret": "string"
                    }
                }
            }
        ],
        "post_logout_redirect_uri": "string",
        "redirect_uri": "string"
    },
    "performance_limits": {
        "max_concurrent_connections": 0,
        "max_throughput": 0
    },
    "pool_group_ref": "string",
    "pool_ref": "string",
    "remove_listening_port_on_vs_down": false,
    "requests_rate_limit": {
        "action": {
            "file": {
                "content_type": "string",
                "file_content": "string",
                "file_length": 0
            },
            "redirect": {
                "add_string": "string",
                "host": {
                    "tokens": [
                        {
                            "end_index": 0,
                            "start_index": 0,
                            "str_value": "string",
                            "type": "string"
                        }
                    ],
                    "type": "string"
                },
                "keep_query": false,
                "path": {
                    "tokens": [
                        {
                            "end_index": 0,
                            "start_index": 0,
                            "str_value": "string",
                            "type": "string"
                        }
                    ],
                    "type": "string"
                },
                "port": 0,
                "protocol": "string",
                "status_code": "string"
            },
            "status_code": "string",
            "type": "string"
        },
        "explicit_tracking": false,
        "fine_grain": false,
        "http_cookie": "string",
        "http_header": "string",
        "rate_limiter": {
            "burst_sz": 0,
            "count": 0,
            "name": "string",
            "period": 0
        }
    },
    "revoke_vip_route": false,
    "saml_sp_config": {
        "acs_index": 0,
        "authn_req_acs_type": "string",
        "cookie_name": "string",
        "cookie_timeout": 0,
        "entity_id": "string",
        "key": [
            {
                "aes_key": "string",
                "hmac_key": "string",
                "name": "string"
            }
        ],
        "signing_ssl_key_and_certificate_ref": "string",
        "single_signon_url": "string",
        "sp_metadata": "string",
        "use_idp_session_timeout": false
    },
    "scaleout_ecmp": false,
    "se_group_ref": "string",
    "security_policy_ref": "string",
    "server_network_profile_ref": "string",
    "service_metadata": "string",
    "service_pool_select": [
        {
            "service_pool_group_ref": "string",
            "service_pool_ref": "string",
            "service_port": 0,
            "service_port_range_end": 0,
            "service_protocol": "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
        }
    ],
    "sideband_profile": {
        "ip": [
            {
                "addr": "string",
                "type": "string"
            }
        ],
        "sideband_max_request_body_size": 0
    },
    "snat_ip": [
        {
            "addr": "string",
            "type": "string"
        }
    ],
    "snat_ip6_addresses": [
        {
            "addr": "string",
            "type": "string"
        }
    ],
    "sp_pool_refs": [
        "string"
    ],
    "ssl_key_and_certificate_refs": [
        "string"
    ],
    "ssl_profile_ref": "string",
    "ssl_profile_selectors": [
        {
            "client_ip_list": {
                "addrs": [
                    {
                        "addr": "string",
                        "type": "string"
                    }
                ],
                "group_refs": [
                    "string"
                ],
                "match_criteria": "string",
                "prefixes": [
                    {
                        "ip_addr": {
                            "addr": "string",
                            "type": "string"
                        },
                        "mask": 0
                    }
                ],
                "ranges": [
                    {
                        "begin": {
                            "addr": "string",
                            "type": "string"
                        },
                        "end": {
                            "addr": "string",
                            "type": "string"
                        }
                    }
                ]
            },
            "ssl_profile_ref": "string"
        }
    ],
    "ssl_sess_cache_avg_size": 0,
    "sso_policy_ref": "string",
    "static_dns_records": [
        {
            "algorithm": "string",
            "cname": {
                "cname": "string"
            },
            "delegated": false,
            "description": "string",
            "fqdn": [
                "string"
            ],
            "ip6_address": [
                {
                    "ip6_address": {
                        "addr": "string",
                        "type": "string"
                    }
                }
            ],
            "ip_address": [
                {
                    "ip_address": {
                        "addr": "string",
                        "type": "string"
                    }
                }
            ],
            "metadata": "string",
            "mx_records": [
                {
                    "host": "string",
                    "priority": 0
                }
            ],
            "ns": [
                {
                    "ip6_address": {
                        "addr": "string",
                        "type": "string"
                    },
                    "ip_address": {
                        "addr": "string",
                        "type": "string"
                    },
                    "nsname": "string"
                }
            ],
            "num_records_in_response": 0,
            "service_locator": [
                {
                    "port": 0,
                    "priority": 0,
                    "target": "string",
                    "weight": 0
                }
            ],
            "ttl": 0,
            "txt_records": [
                {
                    "text_str": "string"
                }
            ],
            "type": "string",
            "wildcard_match": false
        }
    ],
    "tenant_ref": "string",
    "test_se_datastore_level_1_ref": "string",
    "topology_policies": [
        {
            "dns_policy_ref": "string",
            "index": 0
        }
    ],
    "traffic_clone_profile_ref": "string",
    "traffic_enabled": false,
    "type": "string",
    "url": "string",
    "use_bridge_ip_as_vip": false,
    "use_vip_as_snat": false,
    "uuid": "string",
    "vh_domain_name": [
        "string"
    ],
    "vh_matches": [
        {
            "host": "string",
            "rules": [
                {
                    "matches": {
                        "bot_detection_result": {
                            "classifications": [
                                {
                                    "type": "string",
                                    "user_defined_type": "string"
                                }
                            ],
                            "match_operation": "string"
                        },
                        "client_ip": {
                            "addrs": [
                                {
                                    "addr": "string",
                                    "type": "string"
                                }
                            ],
                            "group_refs": [
                                "string"
                            ],
                            "match_criteria": "string",
                            "prefixes": [
                                {
                                    "ip_addr": {
                                        "addr": "string",
                                        "type": "string"
                                    },
                                    "mask": 0
                                }
                            ],
                            "ranges": [
                                {
                                    "begin": {
                                        "addr": "string",
                                        "type": "string"
                                    },
                                    "end": {
                                        "addr": "string",
                                        "type": "string"
                                    }
                                }
                            ]
                        },
                        "cookie": {
                            "match_case": "string",
                            "match_criteria": "string",
                            "name": "string",
                            "value": "string"
                        },
                        "geo_matches": [
                            {
                                "attribute": "string",
                                "match_operation": "string",
                                "values": [
                                    "string"
                                ]
                            }
                        ],
                        "hdrs": [
                            {
                                "hdr": "string",
                                "match_case": "string",
                                "match_criteria": "string",
                                "value": [
                                    "string"
                                ]
                            }
                        ],
                        "host_hdr": {
                            "match_case": "string",
                            "match_criteria": "string",
                            "value": [
                                "string"
                            ]
                        },
                        "ip_reputation_type": {
                            "match_operation": "string",
                            "reputation_types": [
                                "string"
                            ]
                        },
                        "method": {
                            "match_criteria": "string",
                            "methods": [
                                "string"
                            ]
                        },
                        "path": {
                            "match_case": "string",
                            "match_criteria": "string",
                            "match_decoded_string": false,
                            "match_str": [
                                "string"
                            ],
                            "string_group_refs": [
                                "string"
                            ]
                        },
                        "protocol": {
                            "match_criteria": "string",
                            "protocols": "string"
                        },
                        "query": {
                            "match_case": "string",
                            "match_criteria": "string",
                            "match_decoded_string": false,
                            "match_str": [
                                "string"
                            ],
                            "string_group_refs": [
                                "string"
                            ]
                        },
                        "source_ip": {
                            "addrs": [
                                {
                                    "addr": "string",
                                    "type": "string"
                                }
                            ],
                            "group_refs": [
                                "string"
                            ],
                            "match_criteria": "string",
                            "prefixes": [
                                {
                                    "ip_addr": {
                                        "addr": "string",
                                        "type": "string"
                                    },
                                    "mask": 0
                                }
                            ],
                            "ranges": [
                                {
                                    "begin": {
                                        "addr": "string",
                                        "type": "string"
                                    },
                                    "end": {
                                        "addr": "string",
                                        "type": "string"
                                    }
                                }
                            ]
                        },
                        "tls_fingerprint_match": {
                            "fingerprints": [
                                "string"
                            ],
                            "match_operation": "string",
                            "string_group_refs": [
                                "string"
                            ]
                        },
                        "version": {
                            "match_criteria": "string",
                            "versions": [
                                "string"
                            ]
                        },
                        "vs_port": {
                            "match_criteria": "string",
                            "ports": [
                                0
                            ]
                        }
                    },
                    "name": "string"
                }
            ]
        }
    ],
    "vh_parent_vs_ref": "string",
    "vh_type": "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",
    "vs_datascripts": [
        {
            "index": 0,
            "vs_datascript_set_ref": "string"
        }
    ],
    "vsvip_cloud_config_cksum": "string",
    "vsvip_ref": "string",
    "waf_policy_ref": "string",
    "weight": 0
}
string
_last_modified
Optional

UNIX time since epoch in microseconds. Units(MICROSECONDS).

string
active_standby_se_tag
Optional
Constraints: default: ACTIVE_STANDBY_SE_1

This configuration only applies if the VirtualService is in Legacy Active Standby HA mode and Load Distribution among Active Standby is enabled. This field is used to tag the VirtualService so that VirtualServices with the same tag will share the same Active ServiceEngine. VirtualServices with different tags will have different Active ServiceEngines. If one of the ServiceEngine's in the ServiceEngineGroup fails, all VirtualServices will end up using the same Active ServiceEngine. Redistribution of the VirtualServices can be either manual or automated when the failed ServiceEngine recovers. Redistribution is based on the auto redistribute property of the ServiceEngineGroup. Enum options - ACTIVE_STANDBY_SE_1, ACTIVE_STANDBY_SE_2. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

boolean
advertise_down_vs
Optional

Keep advertising Virtual Service via BGP even if it is marked down by health monitor. This setting takes effect for future Virtual Service flaps. To advertise current VSes that are down, please disable and re-enable the Virtual Service. Field introduced in 20.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
allow_invalid_client_cert
Optional

Process request even if invalid client certificate is presented. Datascript APIs need to be used for processing of such requests. Field introduced in 18.2.3. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- false), Basic edition(Allowed values- false), Enterprise with Cloud Services edition.

analytics_policy
Optional

analytics_policy

string
analytics_profile_ref
Optional

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

string
application_profile_ref
Optional

Enable application layer specific features for the Virtual Service. It is a reference to an object of type ApplicationProfile. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. Special default for Essentials edition is System-L4-Application.

string
azure_availability_set
Optional

(internal-use)Applicable for Azure only. Azure Availability set to which this VS is associated. Internally set by the cloud connector. Field introduced in 17.2.12, 18.1.2. Allowed in Enterprise edition with any value, Essentials edition with any value, Basic edition with any value, Enterprise with Cloud Services edition.

integer As uint32 As uint32
bgp_local_preference
Optional

LOCAL_PREF to be used for VsVip advertised. Applicable only over iBGP. Field introduced in 30.2.1. Allowed in Enterprise edition with any value, Essentials edition with any value, Basic edition with any value, Enterprise with Cloud Services edition.

integer As uint32 As uint32
bgp_num_as_path_prepend
Optional

Number of times the local AS should be prepended additionally to VsVip. Applicable only over eBGP. Allowed values are 1-10. Field introduced in 30.2.1. Allowed in Enterprise edition with any value, Essentials edition with any value, Basic edition with any value, Enterprise with Cloud Services edition.

array of string
bgp_peer_labels
Optional

Select BGP peers, using peer label, for VsVip advertisement. Field introduced in 20.1.5. Maximum of 128 items allowed. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

string
bot_policy_ref
Optional

Bot detection policy for the Virtual Service. It is a reference to an object of type BotDetectionPolicy. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

boolean
bulk_sync_kvcache
Optional

(This is a beta feature). Sync Key-Value cache to the new SEs when VS is scaled out. For ex SSL sessions are stored using VS's Key-Value cache. When the VS is scaled out, the SSL session information is synced to the new SE, allowing existing SSL sessions to be reused on the new SE. . Field introduced in 17.2.7, 18.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
close_client_conn_on_config_update
Optional

close client connection on vs config update. Field introduced in 17.2.4. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- false), Basic edition(Allowed values- false), Enterprise with Cloud Services edition.

string
cloud_config_cksum
Optional

Checksum of cloud configuration for VS. Internally set by cloud connector. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

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.

string
cloud_type
Optional
Constraints: default: CLOUD_NONE

Enum options - CLOUD_NONE, CLOUD_VCENTER, CLOUD_OPENSTACK, CLOUD_AWS, CLOUD_VCA, CLOUD_APIC, CLOUD_MESOS, CLOUD_LINUXSERVER, CLOUD_DOCKER_UCP, CLOUD_RANCHER, CLOUD_OSHIFT_K8S, CLOUD_AZURE, CLOUD_GCP, CLOUD_NSXT. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- CLOUD_NONE,CLOUD_VCENTER), Basic edition(Allowed values- CLOUD_NONE,CLOUD_NSXT), Enterprise with Cloud Services edition.

configpb_attributes
Optional

configpb_attributes

connections_rate_limit
Optional

connections_rate_limit

content_rewrite
Optional

content_rewrite

string
created_by
Optional

Creator name. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

string
csrf_policy_ref
Optional

CSRF Protection policy for the Virtual Service. It is a reference to an object of type CSRFPolicy. Field introduced in 30.2.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

boolean
delay_fairness
Optional

Select the algorithm for QoS fairness. This determines how multiple Virtual Services sharing the same Service Engines will prioritize traffic over a congested network. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- false), Basic edition(Allowed values- false), Enterprise with Cloud Services edition.

string
description
Optional

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, Enterprise with Cloud Services edition.

dns_policies
Optional

DNS Policies applied on the dns traffic of the Virtual Service. Field introduced in 17.1.1. Allowed in Enterprise edition with any value, 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 edition(Allowed values- false), Basic edition(Allowed values- false), Enterprise with Cloud Services edition.

boolean
enable_autogw
Optional
Constraints: default: true

Response traffic to clients will be sent back to the source MAC address of the connection, rather than statically sent to a default gateway. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- false), Basic edition(Allowed values- false), Enterprise with Cloud Services edition. Special default for Essentials edition is false, Basic edition is false, Enterprise is True.

boolean
enable_rhi
Optional

Enable Route Health Injection using the BGP Config in the vrf context. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

boolean
enable_rhi_snat
Optional

Enable Route Health Injection for Source NAT'ted floating IP Address using the BGP Config in the vrf context. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

boolean
enable_session
Optional

Enable HTTP sessions for this virtual service. If enabled, a session cookie will be added to HTTP responses and persistent key-value store will be activated. Field introduced in 30.2.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

boolean
enabled
Optional
Constraints: default: true

Enable or disable the Virtual Service. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

string
error_page_profile_ref
Optional

Error Page Profile to be used for this virtualservice.This profile is used to send the custom error page to the client generated by the proxy. It is a reference to an object of type ErrorPageProfile. Field introduced in 17.2.4. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

string
flow_dist
Optional
Constraints: default: LOAD_AWARE

Criteria for flow distribution among SEs. Enum options - LOAD_AWARE, CONSISTENT_HASH_SOURCE_IP_ADDRESS, CONSISTENT_HASH_SOURCE_IP_ADDRESS_AND_PORT. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- LOAD_AWARE), Basic edition(Allowed values- LOAD_AWARE), Enterprise with Cloud Services edition.

string
flow_label_type
Optional
Constraints: default: NO_LABEL

Criteria for flow labelling. Enum options - NO_LABEL, APPLICATION_LABEL, SERVICE_LABEL. Allowed in Enterprise edition with any value, Essentials, Basic, 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. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

string
host_name_xlate
Optional

Translate the host name sent to the servers to this value. Translate the host name sent from servers back to the value used by the client. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

http_policies
Optional

HTTP Policies applied on the data traffic of the Virtual Service. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

array of string
icap_request_profile_refs
Optional

The config settings for the ICAP server when checking the HTTP request. It is a reference to an object of type IcapProfile. Field introduced in 20.1.1. Maximum of 1 items allowed. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

boolean
ign_pool_net_reach
Optional

Ignore Pool servers network reachability constraints for Virtual Service placement. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

jwt_config
Optional

jwt_config

array of L4Policies
l4_policies
Optional

L4 Policies applied to the data traffic of the Virtual Service. Field introduced in 17.2.7. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

ldap_vs_config
Optional

ldap_vs_config

boolean
limit_doser
Optional

Limit potential DoS attackers who exceed max_cps_per_client significantly to a fraction of max_cps_per_client for a while. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

markers
Optional

List of labels to be used for granular RBAC. Field introduced in 20.1.5. Allowed in Enterprise edition with any value, Essentials edition with any value, Basic edition with any value, Enterprise with Cloud Services edition.

integer As uint32 As uint32
max_cps_per_client
Optional

Maximum connections per second per client IP. Allowed values are 10-1000. Special values are 0- unlimited. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

string
microservice_ref
Optional

Microservice representing the virtual service. It is a reference to an object of type MicroService. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

integer As uint32 As uint32
min_pools_up
Optional

Minimum number of UP pools to mark VS up. Field introduced in 18.2.1, 17.2.12. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

string
name
Required

Name for the Virtual Service. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

string
network_profile_ref
Optional

Determines network settings such as protocol, TCP or UDP, and related options for the protocol. It is a reference to an object of type NetworkProfile. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. Special default for Essentials edition is System-TCP-Fast-Path.

string
network_security_policy_ref
Optional

Network security policies for the Virtual Service. It is a reference to an object of type NetworkSecurityPolicy. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

array of string
nsx_securitygroup
Optional

A list of NSX Groups representing the Clients which can access the Virtual IP of the Virtual Service. Field introduced in 17.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

oauth_vs_config
Optional

oauth_vs_config

performance_limits
Optional

performance_limits

string
pool_group_ref
Optional

The pool group is an object that contains pools. It is a reference to an object of type PoolGroup. Allowed in Enterprise edition with any value, Basic, 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. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

boolean
remove_listening_port_on_vs_down
Optional

Remove listening port if VirtualService is down. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

requests_rate_limit
Optional

requests_rate_limit

boolean
revoke_vip_route
Optional

Revoke the advertisement of Virtual Service via the cloud if it is marked down by health monitor. Supported for NSXT clouds only.This setting takes effect for future Virtual Service flaps. To advertise current VSes that are down, please disable and re-enable the Virtual Service. Field introduced in 30.2.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

saml_sp_config
Optional

saml_sp_config

boolean
scaleout_ecmp
Optional

Disable re-distribution of flows across service engines for a virtual service. Enable if the network itself performs flow hashing with ECMP in environments such as GCP. Allowed in Enterprise edition with any value, Essentials, Basic, 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. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

string
security_policy_ref
Optional

Security policy applied on the traffic of the Virtual Service. This policy is used to perform security actions such as Distributed Denial of Service (DDoS) attack mitigation, etc. It is a reference to an object of type SecurityPolicy. Field introduced in 18.2.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

string
server_network_profile_ref
Optional

Determines the network settings profile for the server side of TCP proxied connections. Leave blank to use the same settings as the client to VS side of the connection. It is a reference to an object of type NetworkProfile. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

string
service_metadata
Optional

Metadata pertaining to the Service provided by this virtual service. In Openshift/Kubernetes environments, egress pod info is stored. Any user input to this field will be overwritten by Avi Vantage. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

service_pool_select
Optional

Select pool based on destination port. 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. Maximum of 2048 items allowed. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

sideband_profile
Optional

sideband_profile

array of IpAddr
snat_ip
Optional

NAT'ted floating source IP Address(es) for upstream connection to servers. Maximum of 32 items allowed. Allowed in Enterprise edition with any value, Basic, Enterprise with Cloud Services edition.

array of IpAddr
snat_ip6_addresses
Optional

IPV6 address for SE snat. Field introduced in 30.2.1. Maximum of 32 items allowed. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

array of string
sp_pool_refs
Optional

GSLB pools used to manage site-persistence functionality. Each site-persistence pool contains the virtualservices in all the other sites, that is auto-generated by the GSLB manager. This is a read-only field for the user. It is a reference to an object of type Pool. Field introduced in 17.2.2. Allowed in Enterprise edition with any value, Essentials edition with any value, Basic edition with any value, Enterprise with Cloud Services edition.

array of string
ssl_key_and_certificate_refs
Optional

Select or create one or two certificates, EC and/or RSA, that will be presented to SSL/TLS terminated connections. It is a reference to an object of type SSLKeyAndCertificate. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

string
ssl_profile_ref
Optional

Determines the set of SSL versions and ciphers to accept for SSL/TLS terminated connections. It is a reference to an object of type SSLProfile. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

ssl_profile_selectors
Optional

Select SSL Profile based on client IP address match. Field introduced in 18.2.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

integer As uint32 As uint32
ssl_sess_cache_avg_size
Optional
Constraints: default: 1024

Expected number of SSL session cache entries (may be exceeded). Allowed values are 1024-16383. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

string
sso_policy_ref
Optional

The SSO Policy attached to the virtualservice. It is a reference to an object of type SSOPolicy. Field introduced in 18.2.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

array of DnsRecord
static_dns_records
Optional

List of static DNS records applied to this Virtual Service. These are static entries and no health monitoring is performed against the IP addresses. Maximum of 1000 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
test_se_datastore_level_1_ref
Optional

Used for testing SE Datastore Upgrade 2.0 functionality. It is a reference to an object of type TestSeDatastoreLevel1. Field introduced in 18.2.6. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

topology_policies
Optional

Topology Policies applied on the dns traffic of the Virtual Service based onGSLB Topology algorithm. Field introduced in 18.2.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

string
traffic_clone_profile_ref
Optional

Server network or list of servers for cloning traffic. It is a reference to an object of type TrafficCloneProfile. Field introduced in 17.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

boolean
traffic_enabled
Optional
Constraints: default: true

Knob to enable the Virtual Service traffic on its assigned service engines. This setting is effective only when the enabled flag is set to True. Field introduced in 17.2.8. 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 edition(Allowed values- VS_TYPE_NORMAL), Basic edition(Allowed values- VS_TYPE_NORMAL,VS_TYPE_VH_PARENT), Enterprise with Cloud Services edition.

string
url
Optional

url

boolean
use_bridge_ip_as_vip
Optional

Use Bridge IP as VIP on each Host in Mesos deployments. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- false), Basic edition(Allowed values- false), Enterprise with Cloud Services edition.

boolean
use_vip_as_snat
Optional

Use the Virtual IP as the SNAT IP for health monitoring and sending traffic to the backend servers instead of the Service Engine interface IP. The caveat of enabling this option is that the VirtualService cannot be configued in an Active-Active HA mode. DNS based Multi VIP solution has to be used for HA & Non-disruptive Upgrade purposes. Field introduced in 17.1.9,17.2.3. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- false), Basic, Enterprise with Cloud Services edition.

string
uuid
Optional

UUID of the VirtualService. Allowed in Enterprise edition with any value, Essentials, Basic, 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 VHMatch
vh_matches
Optional

Match criteria to select this child VS. Field introduced in 20.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

string
vh_parent_vs_ref
Optional

Specifies the Virtual Service acting as Virtual Hosting (SNI) parent. It is a reference to an object of type VirtualService. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

string
vh_type
Optional
Constraints: default: VS_TYPE_VH_SNI

Specify if the Virtual Hosting VS is of type SNI or Enhanced. Enum options - VS_TYPE_VH_SNI, VS_TYPE_VH_ENHANCED. Field introduced in 20.1.3. Allowed in Enterprise edition with any value, Basic edition(Allowed values- VS_TYPE_VH_SNI,VS_TYPE_VH_ENHANCED), 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 17.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, 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.

vs_datascripts
Optional

Datascripts applied on the data traffic of the Virtual Service. Allowed in Enterprise edition with any value, Basic, Enterprise with Cloud Services edition.

string
vsvip_cloud_config_cksum
Optional

Checksum of cloud configuration for VsVip. Internally set by cloud connector. Field introduced in 17.2.9, 18.1.2. Allowed in Enterprise edition with any value, Essentials edition with any value, Basic edition with any value, 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 17.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

string
waf_policy_ref
Optional

WAF policy for the Virtual Service. It is a reference to an object of type WafPolicy. Field introduced in 17.2.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

integer As uint32 As uint32
weight
Optional
Constraints: default: 1

The Quality of Service weight to assign to traffic transmitted from this Virtual Service. A higher weight will prioritize traffic versus other Virtual Services sharing the same Service Engines. Allowed values are 1-128. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- 1), Basic edition(Allowed values- 1), Enterprise with Cloud Services edition.