Avi VirtualService Object API
CLI ``` - configure virtualservice - show virtualservice - scaleout virtualservice - scalein virtualservice - migrate virtualservice - switchover virtualservice - clear virtualservice - resync virtualservice - rotatekeys virtualservice - apicplacement virtualservice - retryplacement virtualservice ``` Examples - **virtualservice_example_1**: To create a basic virtualservice object that has both http and https enabled ```json {'name': 'production_vs', 'services': [{'port': 80}, {'port': 443, 'enable_ssl': True}], 'vsvip_ref': '/api/vsvip/vsvip-5b310671-7784-472b-8096-8679d3e1c769'} ``` - **virtualservice_example_ipamdns_infoblox**: Create a basic virtualservice object that requires IP to be auto-allocated and DNS record to be registered. @Assumptions: - This example assumes the virtualservice being created is part of a Cloud with Infoblox as IPAM & DNS provider - On Infoblox server - \"10.10.10.0/24\" is configured for VIPs - \"prod.corp\" is configured as zone ```json {'name': 'production_vs', 'fqdn': 'production_vs.prod.corp', 'vsvip_ref': '/api/vsvip/vsvip-5b310671-7784-472b-8096-8679d3e1c769'} ``` - **virtualservice_example_ipamdns_internal**: Create a basic virtualservice object that requires IP to be auto-allocated and DNS record to be registered. @Assumptions: - This example assumes the virtualservice being created is part of a Cloud with Internal IPAM & DNS provider - On Avi - Network object containing free IPs from \"10.10.10.0/24\" is already created - \"prod.corp\" is configured as a domain name in DNS provider config in Avi ```json {'name': 'production_vs', 'fqdn': 'production_vs.prod.corp', 'vsvip_ref': '/api/vsvip/vsvip-5b310671-7784-472b-8096-8679d3e1c769'} ```
Contact Info: support@avinetworks.com
Version: 20.1.9
BasePath:/api
All rights reserved
http://apache.org/licenses/LICENSE-2.0.html
Access
- HTTP Basic Authentication
[ Jump to Models ]
Table of Contents
post /virtualservice/clearget /virtualservicepost /virtualservicepost /virtualservice/{uuid}/apicplacementget /virtualservice/{uuid}/authstats/get /virtualservice/{uuid}/candidatesehostlist/get /virtualservice/{uuid}/client/get /virtualservice/{uuid}/clientsummary/get /virtualservice/{uuid}/cltrack/get /virtualservice/{uuid}/cltracksummary/get /virtualservice/{uuid}/connections/delete /virtualservice/{uuid}get /virtualservice/{uuid}/dnspolicystats/get /virtualservice/{uuid}/dnstable/get /virtualservice/{uuid}/dosstat/get /virtualservice/{uuid}/geodbinternal/get /virtualservice/{uuid}/geolocationinfo/get /virtualservice/{uuid}get /virtualservice/{uuid}/gslbservicealgostat/get /virtualservice/{uuid}/gslbservicedetail/get /virtualservice/{uuid}/gslbservicehmonstat/get /virtualservice/{uuid}/gslbserviceinternal/get /virtualservice/{uuid}/gslbsiteinternal/get /virtualservice/{uuid}/httpconnections/detail/get /virtualservice/{uuid}/httpconnections/get /virtualservice/{uuid}/httppolicyset/get /virtualservice/{uuid}/httppolicysetstats/get /virtualservice/{uuid}/httpstats/get /virtualservice/{uuid}/icapstats/get /virtualservice/{uuid}/keyval/get /virtualservice/{uuid}/keyvaldispatch/get /virtualservice/{uuid}/keyvalsummary/get /virtualservice/{uuid}/keyvalsummaryobjsync/get /virtualservice/{uuid}/l4policysetstats/post /virtualservice/{uuid}/migrateget /virtualservice/{uuid}/networksecuritypolicy/detail/get /virtualservice/{uuid}/networksecuritypolicystats/get /virtualservice/{uuid}/outofbandstats/patch /virtualservice/{uuid}get /virtualservice/{uuid}/placement/put /virtualservice/{uuid}post /virtualservice/{uuid}/resyncpost /virtualservice/{uuid}/retryplacementpost /virtualservice/{uuid}/rotatekeysget /virtualservice/{uuid}/runtime/detail/get /virtualservice/{uuid}/runtime/get /virtualservice/{uuid}/runtime/internal/post /virtualservice/{uuid}/scaleinpost /virtualservice/{uuid}/scaleoutget /virtualservice/{uuid}/scaleoutstatus/detail/get /virtualservice/{uuid}/scaleoutstatus/get /virtualservice/{uuid}/scaleoutstatus/keyval/get /virtualservice/{uuid}/scaleoutstatus/keyvalsummary/get /virtualservice/{uuid}/sescaleoutstatus/get /virtualservice/{uuid}/sslsessioncache/get /virtualservice/{uuid}/ssopolicystats/post /virtualservice/{uuid}/switchoverget /virtualservice/{uuid}/tcpstat/get /virtualservice/{uuid}/traffic_clone_stats/get /virtualservice/{uuid}/udpstat/get /virtualservice/{uuid}/userdefineddatascriptcounters/
Up
post /virtualservice/clear
(virtualserviceClearPost)
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (required)
Body Parameter — empty
Return type
String
Example data
Content-Type: application/json
"aeiou"
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
String
401
log in failed
(virtualserviceGet)
Consumes
This API call consumes the following media types via the
Content-Type request header:
Query parameters
name (optional)
Query Parameter — object name
refers_to (optional)
Query Parameter — Filter to request all objects that refers to another Avi resource. Its syntax is refers_to=<obj_type>:<obj_uuid>. Eg. get all virtual services referring to pool p1 will be refers_to=pool:pool_p1_uuid
referred_by (optional)
Query Parameter — Filter to request all objects that are referred by another Avi resource. Its syntax is referred_by=<obj_type>:<obj_uuid>. Eg. get all pools referred_by virtual service vs1 - referred_by=virtualservice:vs_vs1_uuid
fields (optional)
Query Parameter — List of fields to be returned for the resource. Some fields like name, URL, uuid etc. are always returned.
include_name (optional)
Query Parameter — All the Avi REST reference URIs have a name suffix as URI#name. It is useful to get the referenced resource name without performing get on that object.
skip_default (optional)
Query Parameter — Default values are not set.
join_subresources (optional)
Query Parameter — It automatically returns additional dependent resources like runtime. Eg. join_subresources=runtime.
cloud_uuid (optional)
Query Parameter — Filter to get objects that belongs to a specific cloud using its uuid. Eg. cloud_uuid=cloud-xyz.
cloud_ref.name (optional)
Query Parameter — Filter to get objects that belongs to a specific cloud usings its name. This uses cloud name rather than uuid. Eg. cloud_ref.name=Default-Cloud.
Return type
Example data
Content-Type: application/json
{
"next" : "aeiou",
"count" : 123,
"results" : [ {
"client_auth" : {
"request_uri_path" : "",
"auth_profile_ref" : "aeiou",
"realm" : "aeiou",
"type" : "aeiou"
},
"dns_policies" : [ {
"dns_policy_ref" : "aeiou",
"index" : 123
} ],
"l4_policies" : [ {
"l4_policy_set_ref" : "aeiou",
"index" : 123
} ],
"azure_availability_set" : "aeiou",
"enable_autogw" : true,
"content_rewrite" : {
"req_match_replace_pair" : [ {
"match_string" : "aeiou",
"replacement_string" : {
"val" : "aeiou",
"type" : "aeiou"
}
} ],
"request_rewrite_enabled" : true,
"rsp_match_replace_pair" : [ "" ],
"rewritable_content_ref" : "aeiou",
"response_rewrite_enabled" : true
},
"type" : "aeiou",
"traffic_enabled" : true,
"bgp_peer_labels" : [ "aeiou" ],
"pool_ref" : "aeiou",
"delay_fairness" : true,
"cloud_ref" : "aeiou",
"analytics_policy" : {
"significant_log_throttle" : 123,
"all_headers" : true,
"client_insights" : "aeiou",
"client_log_filters" : [ {
"duration" : 123,
"all_headers" : true,
"name" : "aeiou",
"index" : 123,
"client_ip" : "",
"uri" : "",
"enabled" : true
} ],
"client_insights_sampling" : {
"client_ip" : {
"group_refs" : [ "aeiou" ],
"match_criteria" : "aeiou",
"prefixes" : [ {
"ip_addr" : "",
"mask" : 123
} ],
"ranges" : [ {
"end" : "",
"begin" : ""
} ],
"addrs" : [ {
"addr" : "aeiou",
"type" : "aeiou"
} ]
},
"skip_uris" : "",
"sample_uris" : {
"match_criteria" : "aeiou",
"string_group_refs" : [ "aeiou" ],
"match_str" : [ "aeiou" ]
}
},
"metrics_realtime_update" : {
"duration" : 123,
"enabled" : true
},
"udf_log_throttle" : 123,
"learning_log_policy" : {
"port" : 123,
"host" : "aeiou",
"enabled" : true
},
"enabled" : true,
"full_client_logs" : {
"duration" : 123,
"all_headers" : true,
"throttle" : 123,
"enabled" : true
}
},
"enable_rhi_snat" : true,
"vip" : [ {
"availability_zone" : "aeiou",
"ip6_address" : "",
"subnet" : "",
"port_uuid" : "aeiou",
"subnet_uuid" : "aeiou",
"placement_networks" : [ {
"subnet" : "",
"subnet6" : "",
"network_ref" : "aeiou"
} ],
"avi_allocated_vip" : true,
"vip_id" : "aeiou",
"ip_address" : "",
"auto_allocate_floating_ip" : true,
"enabled" : true,
"auto_allocate_ip_type" : "aeiou",
"floating_subnet6_uuid" : "aeiou",
"auto_allocate_ip" : true,
"subnet6" : "",
"floating_ip" : "",
"floating_subnet_uuid" : "aeiou",
"avi_allocated_fip" : true,
"subnet6_uuid" : "aeiou",
"floating_ip6" : "",
"ipam_network_subnet" : "",
"network_ref" : "aeiou",
"prefix_length" : 123,
"discovered_networks" : [ "" ]
} ],
"min_pools_up" : 123,
"sp_pool_refs" : [ "aeiou" ],
"apic_contract_graph" : "aeiou",
"subnet_uuid" : "aeiou",
"advertise_down_vs" : true,
"bulk_sync_kvcache" : true,
"waf_policy_ref" : "aeiou",
"labels" : [ {
"value" : "aeiou",
"key" : "aeiou"
} ],
"security_policy_ref" : "aeiou",
"ssl_sess_cache_avg_size" : 123,
"cloud_type" : "aeiou",
"scaleout_ecmp" : true,
"cloud_config_cksum" : "aeiou",
"remove_listening_port_on_vs_down" : true,
"vsvip_ref" : "aeiou",
"network_security_policy_ref" : "aeiou",
"topology_policies" : [ "" ],
"jwt_config" : {
"jwt_name" : "aeiou",
"audience" : "aeiou",
"jwt_location" : "aeiou"
},
"pool_group_ref" : "aeiou",
"ssl_profile_ref" : "aeiou",
"enabled" : true,
"limit_doser" : true,
"discovered_subnet" : [ "" ],
"max_cps_per_client" : 123,
"sso_policy_ref" : "aeiou",
"sso_policy" : {
"tenant_ref" : "aeiou",
"name" : "aeiou",
"authentication_policy" : {
"sp_metadata" : "aeiou",
"authn_rules" : [ {
"enable" : true,
"match" : {
"path" : {
"match_criteria" : "aeiou",
"string_group_refs" : [ "aeiou" ],
"match_str" : [ "aeiou" ],
"match_case" : "aeiou"
},
"host_hdr" : {
"match_criteria" : "aeiou",
"value" : [ "aeiou" ],
"match_case" : "aeiou"
},
"client_ip" : ""
},
"name" : "aeiou",
"action" : {
"type" : "aeiou"
},
"index" : 123
} ],
"default_auth_profile_ref" : "aeiou",
"cookie_timeout" : 123,
"auth_profile_ref" : "aeiou",
"entity_id" : "aeiou",
"key" : [ "" ],
"cookie_name" : "aeiou",
"single_signon_url" : "aeiou"
},
"markers" : [ "" ],
"type" : "aeiou",
"authorization_policy" : {
"authz_rules" : [ {
"enable" : true,
"match" : {
"access_token" : {
"token_name" : "aeiou",
"matches" : [ {
"string_match" : "",
"bool_match" : true,
"name" : "aeiou",
"int_match" : 123,
"is_mandatory" : true,
"type" : "aeiou",
"validate" : true
} ]
},
"path" : "",
"method" : {
"match_criteria" : "aeiou",
"methods" : [ "aeiou" ]
},
"host_hdr" : "",
"attr_matches" : [ {
"attribute_name" : "aeiou",
"attribute_value_list" : ""
} ]
},
"name" : "aeiou",
"action" : {
"status_code" : "aeiou",
"type" : "aeiou"
},
"index" : 123
} ]
},
"uuid" : "aeiou",
"url" : "aeiou",
"_last_modified" : "aeiou",
"labels" : [ "" ]
},
"network_ref" : "aeiou",
"http_policies" : [ {
"http_policy_set_ref" : "aeiou",
"index" : 123
} ],
"availability_zone" : "aeiou",
"service_metadata" : "aeiou",
"services" : [ {
"override_network_profile_ref" : "aeiou",
"port" : 123,
"port_range_end" : 123,
"enable_http2" : true,
"enable_ssl" : true,
"override_application_profile_ref" : "aeiou"
} ],
"url" : "aeiou",
"active_standby_se_tag" : "aeiou",
"nsx_securitygroup" : [ "aeiou" ],
"vh_parent_vs_uuid" : "aeiou",
"markers" : [ {
"values" : [ "aeiou" ],
"key" : "aeiou"
} ],
"vsvip_cloud_config_cksum" : "aeiou",
"east_west_placement" : true,
"subnet" : "",
"icap_request_profile_refs" : [ "aeiou" ],
"saml_sp_config" : {
"sp_metadata" : "aeiou",
"signing_ssl_key_and_certificate_ref" : "aeiou",
"cookie_timeout" : 123,
"use_idp_session_timeout" : true,
"entity_id" : "aeiou",
"key" : [ {
"hmac_key" : "aeiou",
"aes_key" : "aeiou",
"name" : "aeiou"
} ],
"cookie_name" : "aeiou",
"single_signon_url" : "aeiou"
},
"vrf_context_ref" : "aeiou",
"flow_dist" : "aeiou",
"dns_info" : [ {
"metadata" : "aeiou",
"fqdn" : "aeiou",
"num_records_in_response" : 123,
"cname" : {
"cname" : "aeiou"
},
"type" : "aeiou",
"ttl" : 123,
"algorithm" : "aeiou"
} ],
"avi_allocated_vip" : true,
"uuid" : "aeiou",
"vh_domain_name" : [ "aeiou" ],
"snat_ip" : [ "" ],
"microservice_ref" : "aeiou",
"error_page_profile_ref" : "aeiou",
"avi_allocated_fip" : true,
"server_network_profile_ref" : "aeiou",
"use_vip_as_snat" : true,
"ipam_network_subnet" : {
"subnet" : "",
"subnet_uuid" : "aeiou",
"subnet6" : "",
"subnet6_uuid" : "aeiou",
"network_ref" : "aeiou"
},
"sideband_profile" : {
"ip" : [ "" ],
"sideband_max_request_body_size" : 123
},
"performance_limits" : {
"max_concurrent_connections" : 123,
"max_throughput" : 123
},
"static_dns_records" : [ {
"ip6_address" : [ {
"ip6_address" : ""
} ],
"mx_records" : [ {
"host" : "aeiou",
"priority" : 123
} ],
"metadata" : "aeiou",
"fqdn" : [ "aeiou" ],
"ns" : [ {
"ip6_address" : "",
"ip_address" : "",
"nsname" : "aeiou"
} ],
"cname" : "",
"description" : "aeiou",
"ip_address" : [ {
"ip_address" : ""
} ],
"type" : "aeiou",
"ttl" : 123,
"wildcard_match" : true,
"txt_records" : [ {
"text_str" : "aeiou"
} ],
"num_records_in_response" : 123,
"service_locator" : [ {
"port" : 123,
"weight" : 123,
"priority" : 123,
"target" : "aeiou"
} ],
"delegated" : true,
"algorithm" : "aeiou"
} ],
"fqdn" : "aeiou",
"weight" : 123,
"auto_allocate_floating_ip" : true,
"created_by" : "aeiou",
"service_pool_select" : [ {
"service_protocol" : "aeiou",
"service_port_range_end" : 123,
"service_pool_ref" : "aeiou",
"service_pool_group_ref" : "aeiou",
"service_port" : 123
} ],
"vh_type" : "aeiou",
"allow_invalid_client_cert" : true,
"application_profile_ref" : "aeiou",
"flow_label_type" : "aeiou",
"name" : "aeiou",
"traffic_clone_profile_ref" : "aeiou",
"host_name_xlate" : "aeiou",
"connections_rate_limit" : {
"rate_limiter" : {
"period" : 123,
"count" : 123,
"name" : "aeiou",
"burst_sz" : 123
},
"period" : 123,
"count" : 123,
"action" : {
"redirect" : {
"keep_query" : true,
"path" : "",
"protocol" : "aeiou",
"status_code" : "aeiou",
"port" : 123,
"host" : {
"tokens" : [ {
"start_index" : 123,
"str_value" : "aeiou",
"end_index" : 123,
"type" : "aeiou"
} ],
"type" : "aeiou"
}
},
"file" : {
"file_content" : "aeiou",
"content_type" : "aeiou"
},
"status_code" : "aeiou",
"type" : "aeiou"
},
"burst_sz" : 123,
"explicit_tracking" : true,
"fine_grain" : true,
"http_cookie" : "aeiou",
"http_header" : "aeiou"
},
"port_uuid" : "aeiou",
"description" : "aeiou",
"vs_datascripts" : [ {
"index" : 123,
"vs_datascript_set_ref" : "aeiou"
} ],
"ssl_key_and_certificate_refs" : [ "aeiou" ],
"_last_modified" : "aeiou",
"se_group_ref" : "aeiou",
"network_profile_ref" : "aeiou",
"auto_allocate_ip" : true,
"close_client_conn_on_config_update" : true,
"floating_ip" : "",
"floating_subnet_uuid" : "aeiou",
"discovered_network_ref" : [ "aeiou" ],
"analytics_profile_ref" : "aeiou",
"use_bridge_ip_as_vip" : true,
"requests_rate_limit" : "",
"enable_rhi" : true,
"ip_address" : "",
"test_se_datastore_level_1_ref" : "aeiou",
"ssl_profile_selectors" : [ {
"ssl_profile_ref" : "aeiou",
"client_ip_list" : ""
} ],
"vh_matches" : [ {
"path" : [ "" ],
"host" : "aeiou"
} ],
"tenant_ref" : "aeiou",
"ign_pool_net_reach" : true,
"discovered_networks" : [ {
"subnet" : [ "" ],
"subnet6" : [ "" ],
"network_ref" : "aeiou"
} ]
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
VirtualServiceApiResponse
401
log in failed
(virtualservicePost)
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (required)
Body Parameter — VirtualService object creation
Return type
Example data
Content-Type: application/json
{
"client_auth" : {
"request_uri_path" : "",
"auth_profile_ref" : "aeiou",
"realm" : "aeiou",
"type" : "aeiou"
},
"dns_policies" : [ {
"dns_policy_ref" : "aeiou",
"index" : 123
} ],
"l4_policies" : [ {
"l4_policy_set_ref" : "aeiou",
"index" : 123
} ],
"azure_availability_set" : "aeiou",
"enable_autogw" : true,
"content_rewrite" : {
"req_match_replace_pair" : [ {
"match_string" : "aeiou",
"replacement_string" : {
"val" : "aeiou",
"type" : "aeiou"
}
} ],
"request_rewrite_enabled" : true,
"rsp_match_replace_pair" : [ "" ],
"rewritable_content_ref" : "aeiou",
"response_rewrite_enabled" : true
},
"type" : "aeiou",
"traffic_enabled" : true,
"bgp_peer_labels" : [ "aeiou" ],
"pool_ref" : "aeiou",
"delay_fairness" : true,
"cloud_ref" : "aeiou",
"analytics_policy" : {
"significant_log_throttle" : 123,
"all_headers" : true,
"client_insights" : "aeiou",
"client_log_filters" : [ {
"duration" : 123,
"all_headers" : true,
"name" : "aeiou",
"index" : 123,
"client_ip" : "",
"uri" : "",
"enabled" : true
} ],
"client_insights_sampling" : {
"client_ip" : {
"group_refs" : [ "aeiou" ],
"match_criteria" : "aeiou",
"prefixes" : [ {
"ip_addr" : "",
"mask" : 123
} ],
"ranges" : [ {
"end" : "",
"begin" : ""
} ],
"addrs" : [ {
"addr" : "aeiou",
"type" : "aeiou"
} ]
},
"skip_uris" : "",
"sample_uris" : {
"match_criteria" : "aeiou",
"string_group_refs" : [ "aeiou" ],
"match_str" : [ "aeiou" ]
}
},
"metrics_realtime_update" : {
"duration" : 123,
"enabled" : true
},
"udf_log_throttle" : 123,
"learning_log_policy" : {
"port" : 123,
"host" : "aeiou",
"enabled" : true
},
"enabled" : true,
"full_client_logs" : {
"duration" : 123,
"all_headers" : true,
"throttle" : 123,
"enabled" : true
}
},
"enable_rhi_snat" : true,
"vip" : [ {
"availability_zone" : "aeiou",
"ip6_address" : "",
"subnet" : "",
"port_uuid" : "aeiou",
"subnet_uuid" : "aeiou",
"placement_networks" : [ {
"subnet" : "",
"subnet6" : "",
"network_ref" : "aeiou"
} ],
"avi_allocated_vip" : true,
"vip_id" : "aeiou",
"ip_address" : "",
"auto_allocate_floating_ip" : true,
"enabled" : true,
"auto_allocate_ip_type" : "aeiou",
"floating_subnet6_uuid" : "aeiou",
"auto_allocate_ip" : true,
"subnet6" : "",
"floating_ip" : "",
"floating_subnet_uuid" : "aeiou",
"avi_allocated_fip" : true,
"subnet6_uuid" : "aeiou",
"floating_ip6" : "",
"ipam_network_subnet" : "",
"network_ref" : "aeiou",
"prefix_length" : 123,
"discovered_networks" : [ "" ]
} ],
"min_pools_up" : 123,
"sp_pool_refs" : [ "aeiou" ],
"apic_contract_graph" : "aeiou",
"subnet_uuid" : "aeiou",
"advertise_down_vs" : true,
"bulk_sync_kvcache" : true,
"waf_policy_ref" : "aeiou",
"labels" : [ {
"value" : "aeiou",
"key" : "aeiou"
} ],
"security_policy_ref" : "aeiou",
"ssl_sess_cache_avg_size" : 123,
"cloud_type" : "aeiou",
"scaleout_ecmp" : true,
"cloud_config_cksum" : "aeiou",
"remove_listening_port_on_vs_down" : true,
"vsvip_ref" : "aeiou",
"network_security_policy_ref" : "aeiou",
"topology_policies" : [ "" ],
"jwt_config" : {
"jwt_name" : "aeiou",
"audience" : "aeiou",
"jwt_location" : "aeiou"
},
"pool_group_ref" : "aeiou",
"ssl_profile_ref" : "aeiou",
"enabled" : true,
"limit_doser" : true,
"discovered_subnet" : [ "" ],
"max_cps_per_client" : 123,
"sso_policy_ref" : "aeiou",
"sso_policy" : {
"tenant_ref" : "aeiou",
"name" : "aeiou",
"authentication_policy" : {
"sp_metadata" : "aeiou",
"authn_rules" : [ {
"enable" : true,
"match" : {
"path" : {
"match_criteria" : "aeiou",
"string_group_refs" : [ "aeiou" ],
"match_str" : [ "aeiou" ],
"match_case" : "aeiou"
},
"host_hdr" : {
"match_criteria" : "aeiou",
"value" : [ "aeiou" ],
"match_case" : "aeiou"
},
"client_ip" : ""
},
"name" : "aeiou",
"action" : {
"type" : "aeiou"
},
"index" : 123
} ],
"default_auth_profile_ref" : "aeiou",
"cookie_timeout" : 123,
"auth_profile_ref" : "aeiou",
"entity_id" : "aeiou",
"key" : [ "" ],
"cookie_name" : "aeiou",
"single_signon_url" : "aeiou"
},
"markers" : [ "" ],
"type" : "aeiou",
"authorization_policy" : {
"authz_rules" : [ {
"enable" : true,
"match" : {
"access_token" : {
"token_name" : "aeiou",
"matches" : [ {
"string_match" : "",
"bool_match" : true,
"name" : "aeiou",
"int_match" : 123,
"is_mandatory" : true,
"type" : "aeiou",
"validate" : true
} ]
},
"path" : "",
"method" : {
"match_criteria" : "aeiou",
"methods" : [ "aeiou" ]
},
"host_hdr" : "",
"attr_matches" : [ {
"attribute_name" : "aeiou",
"attribute_value_list" : ""
} ]
},
"name" : "aeiou",
"action" : {
"status_code" : "aeiou",
"type" : "aeiou"
},
"index" : 123
} ]
},
"uuid" : "aeiou",
"url" : "aeiou",
"_last_modified" : "aeiou",
"labels" : [ "" ]
},
"network_ref" : "aeiou",
"http_policies" : [ {
"http_policy_set_ref" : "aeiou",
"index" : 123
} ],
"availability_zone" : "aeiou",
"service_metadata" : "aeiou",
"services" : [ {
"override_network_profile_ref" : "aeiou",
"port" : 123,
"port_range_end" : 123,
"enable_http2" : true,
"enable_ssl" : true,
"override_application_profile_ref" : "aeiou"
} ],
"url" : "aeiou",
"active_standby_se_tag" : "aeiou",
"nsx_securitygroup" : [ "aeiou" ],
"vh_parent_vs_uuid" : "aeiou",
"markers" : [ {
"values" : [ "aeiou" ],
"key" : "aeiou"
} ],
"vsvip_cloud_config_cksum" : "aeiou",
"east_west_placement" : true,
"subnet" : "",
"icap_request_profile_refs" : [ "aeiou" ],
"saml_sp_config" : {
"sp_metadata" : "aeiou",
"signing_ssl_key_and_certificate_ref" : "aeiou",
"cookie_timeout" : 123,
"use_idp_session_timeout" : true,
"entity_id" : "aeiou",
"key" : [ {
"hmac_key" : "aeiou",
"aes_key" : "aeiou",
"name" : "aeiou"
} ],
"cookie_name" : "aeiou",
"single_signon_url" : "aeiou"
},
"vrf_context_ref" : "aeiou",
"flow_dist" : "aeiou",
"dns_info" : [ {
"metadata" : "aeiou",
"fqdn" : "aeiou",
"num_records_in_response" : 123,
"cname" : {
"cname" : "aeiou"
},
"type" : "aeiou",
"ttl" : 123,
"algorithm" : "aeiou"
} ],
"avi_allocated_vip" : true,
"uuid" : "aeiou",
"vh_domain_name" : [ "aeiou" ],
"snat_ip" : [ "" ],
"microservice_ref" : "aeiou",
"error_page_profile_ref" : "aeiou",
"avi_allocated_fip" : true,
"server_network_profile_ref" : "aeiou",
"use_vip_as_snat" : true,
"ipam_network_subnet" : {
"subnet" : "",
"subnet_uuid" : "aeiou",
"subnet6" : "",
"subnet6_uuid" : "aeiou",
"network_ref" : "aeiou"
},
"sideband_profile" : {
"ip" : [ "" ],
"sideband_max_request_body_size" : 123
},
"performance_limits" : {
"max_concurrent_connections" : 123,
"max_throughput" : 123
},
"static_dns_records" : [ {
"ip6_address" : [ {
"ip6_address" : ""
} ],
"mx_records" : [ {
"host" : "aeiou",
"priority" : 123
} ],
"metadata" : "aeiou",
"fqdn" : [ "aeiou" ],
"ns" : [ {
"ip6_address" : "",
"ip_address" : "",
"nsname" : "aeiou"
} ],
"cname" : "",
"description" : "aeiou",
"ip_address" : [ {
"ip_address" : ""
} ],
"type" : "aeiou",
"ttl" : 123,
"wildcard_match" : true,
"txt_records" : [ {
"text_str" : "aeiou"
} ],
"num_records_in_response" : 123,
"service_locator" : [ {
"port" : 123,
"weight" : 123,
"priority" : 123,
"target" : "aeiou"
} ],
"delegated" : true,
"algorithm" : "aeiou"
} ],
"fqdn" : "aeiou",
"weight" : 123,
"auto_allocate_floating_ip" : true,
"created_by" : "aeiou",
"service_pool_select" : [ {
"service_protocol" : "aeiou",
"service_port_range_end" : 123,
"service_pool_ref" : "aeiou",
"service_pool_group_ref" : "aeiou",
"service_port" : 123
} ],
"vh_type" : "aeiou",
"allow_invalid_client_cert" : true,
"application_profile_ref" : "aeiou",
"flow_label_type" : "aeiou",
"name" : "aeiou",
"traffic_clone_profile_ref" : "aeiou",
"host_name_xlate" : "aeiou",
"connections_rate_limit" : {
"rate_limiter" : {
"period" : 123,
"count" : 123,
"name" : "aeiou",
"burst_sz" : 123
},
"period" : 123,
"count" : 123,
"action" : {
"redirect" : {
"keep_query" : true,
"path" : "",
"protocol" : "aeiou",
"status_code" : "aeiou",
"port" : 123,
"host" : {
"tokens" : [ {
"start_index" : 123,
"str_value" : "aeiou",
"end_index" : 123,
"type" : "aeiou"
} ],
"type" : "aeiou"
}
},
"file" : {
"file_content" : "aeiou",
"content_type" : "aeiou"
},
"status_code" : "aeiou",
"type" : "aeiou"
},
"burst_sz" : 123,
"explicit_tracking" : true,
"fine_grain" : true,
"http_cookie" : "aeiou",
"http_header" : "aeiou"
},
"port_uuid" : "aeiou",
"description" : "aeiou",
"vs_datascripts" : [ {
"index" : 123,
"vs_datascript_set_ref" : "aeiou"
} ],
"ssl_key_and_certificate_refs" : [ "aeiou" ],
"_last_modified" : "aeiou",
"se_group_ref" : "aeiou",
"network_profile_ref" : "aeiou",
"auto_allocate_ip" : true,
"close_client_conn_on_config_update" : true,
"floating_ip" : "",
"floating_subnet_uuid" : "aeiou",
"discovered_network_ref" : [ "aeiou" ],
"analytics_profile_ref" : "aeiou",
"use_bridge_ip_as_vip" : true,
"requests_rate_limit" : "",
"enable_rhi" : true,
"ip_address" : "",
"test_se_datastore_level_1_ref" : "aeiou",
"ssl_profile_selectors" : [ {
"ssl_profile_ref" : "aeiou",
"client_ip_list" : ""
} ],
"vh_matches" : [ {
"path" : [ "" ],
"host" : "aeiou"
} ],
"tenant_ref" : "aeiou",
"ign_pool_net_reach" : true,
"discovered_networks" : [ {
"subnet" : [ "" ],
"subnet6" : [ "" ],
"network_ref" : "aeiou"
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
VirtualService
401
log in failed
Up
post /virtualservice/{uuid}/apicplacement
(virtualserviceUuidApicplacementPost)
Path parameters
uuid (required)
Path Parameter — UUID of the object to fetch
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (required)
Body Parameter — ApicVSPlacementReq
Return type
String
Example data
Content-Type: application/json
"aeiou"
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
String
401
log in failed
Up
get /virtualservice/{uuid}/authstats/
(virtualserviceUuidAuthstatsGet)
Path parameters
uuid (required)
Path Parameter — UUID of the object to fetch
Consumes
This API call consumes the following media types via the
Content-Type request header:
Return type
String
Example data
Content-Type: application/json
"aeiou"
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
String
401
log in failed
Up
get /virtualservice/{uuid}/candidatesehostlist/
(virtualserviceUuidCandidatesehostlistGet)
Path parameters
uuid (required)
Path Parameter — UUID of the object to fetch
Consumes
This API call consumes the following media types via the
Content-Type request header:
Return type
String
Example data
Content-Type: application/json
"aeiou"
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
String
401
log in failed
Up
get /virtualservice/{uuid}/client/
(virtualserviceUuidClientGet)
Path parameters
uuid (required)
Path Parameter — UUID of the object to fetch
Consumes
This API call consumes the following media types via the
Content-Type request header:
Return type
String
Example data
Content-Type: application/json
"aeiou"
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
String
401
log in failed
Up
get /virtualservice/{uuid}/clientsummary/
(virtualserviceUuidClientsummaryGet)
Path parameters
uuid (required)
Path Parameter — UUID of the object to fetch
Consumes
This API call consumes the following media types via the
Content-Type request header:
Return type
String
Example data
Content-Type: application/json
"aeiou"
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
String
401
log in failed
Up
get /virtualservice/{uuid}/cltrack/
(virtualserviceUuidCltrackGet)
Path parameters
uuid (required)
Path Parameter — UUID of the object to fetch
Consumes
This API call consumes the following media types via the
Content-Type request header:
Return type
String
Example data
Content-Type: application/json
"aeiou"
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
String
401
log in failed
Up
get /virtualservice/{uuid}/cltracksummary/
(virtualserviceUuidCltracksummaryGet)
Path parameters
uuid (required)
Path Parameter — UUID of the object to fetch
Consumes
This API call consumes the following media types via the
Content-Type request header:
Return type
String
Example data
Content-Type: application/json
"aeiou"
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
String
401
log in failed
Up
get /virtualservice/{uuid}/connections/
(virtualserviceUuidConnectionsGet)
Path parameters
uuid (required)
Path Parameter — UUID of the object to fetch
Consumes
This API call consumes the following media types via the
Content-Type request header:
Return type
String
Example data
Content-Type: application/json
"aeiou"
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
String
401
log in failed
Up
delete /virtualservice/{uuid}
(virtualserviceUuidDelete)
Path parameters
uuid (required)
Path Parameter — UUID of the object to fetch
Consumes
This API call consumes the following media types via the
Content-Type request header:
Query parameters
name (optional)
Query Parameter — object name
Return type
String
Example data
Content-Type: application/json
"aeiou"
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
204
object deleted
String
404
not found
Up
get /virtualservice/{uuid}/dnspolicystats/
(virtualserviceUuidDnspolicystatsGet)
Path parameters
uuid (required)
Path Parameter — UUID of the object to fetch
Consumes
This API call consumes the following media types via the
Content-Type request header:
Return type
String
Example data
Content-Type: application/json
"aeiou"
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
String
401
log in failed
Up
get /virtualservice/{uuid}/dnstable/
(virtualserviceUuidDnstableGet)
Path parameters
uuid (required)
Path Parameter — UUID of the object to fetch
Consumes
This API call consumes the following media types via the
Content-Type request header:
Return type
String
Example data
Content-Type: application/json
"aeiou"
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
String
401
log in failed
Up
get /virtualservice/{uuid}/dosstat/
(virtualserviceUuidDosstatGet)
Path parameters
uuid (required)
Path Parameter — UUID of the object to fetch
Consumes
This API call consumes the following media types via the
Content-Type request header:
Return type
String
Example data
Content-Type: application/json
"aeiou"
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
String
401
log in failed
Up
get /virtualservice/{uuid}/geodbinternal/
(virtualserviceUuidGeodbinternalGet)
Path parameters
uuid (required)
Path Parameter — UUID of the object to fetch
Consumes
This API call consumes the following media types via the
Content-Type request header:
Return type
String
Example data
Content-Type: application/json
"aeiou"
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
String
401
log in failed
Up
get /virtualservice/{uuid}/geolocationinfo/
(virtualserviceUuidGeolocationinfoGet)
Path parameters
uuid (required)
Path Parameter — UUID of the object to fetch
Consumes
This API call consumes the following media types via the
Content-Type request header:
Return type
String
Example data
Content-Type: application/json
"aeiou"
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
String
401
log in failed
Up
get /virtualservice/{uuid}
(virtualserviceUuidGet)
Path parameters
uuid (required)
Path Parameter — UUID of the object to fetch
Consumes
This API call consumes the following media types via the
Content-Type request header:
Query parameters
name (optional)
Query Parameter — object name
fields (optional)
Query Parameter — List of fields to be returned for the resource. Some fields like name, URL, uuid etc. are always returned.
include_name (optional)
Query Parameter — All the Avi REST reference URIs have a name suffix as URI#name. It is useful to get the referenced resource name without performing get on that object.
skip_default (optional)
Query Parameter — Default values are not set.
join_subresources (optional)
Query Parameter — It automatically returns additional dependent resources like runtime. Eg. join_subresources=runtime.
Return type
Example data
Content-Type: application/json
{
"client_auth" : {
"request_uri_path" : "",
"auth_profile_ref" : "aeiou",
"realm" : "aeiou",
"type" : "aeiou"
},
"dns_policies" : [ {
"dns_policy_ref" : "aeiou",
"index" : 123
} ],
"l4_policies" : [ {
"l4_policy_set_ref" : "aeiou",
"index" : 123
} ],
"azure_availability_set" : "aeiou",
"enable_autogw" : true,
"content_rewrite" : {
"req_match_replace_pair" : [ {
"match_string" : "aeiou",
"replacement_string" : {
"val" : "aeiou",
"type" : "aeiou"
}
} ],
"request_rewrite_enabled" : true,
"rsp_match_replace_pair" : [ "" ],
"rewritable_content_ref" : "aeiou",
"response_rewrite_enabled" : true
},
"type" : "aeiou",
"traffic_enabled" : true,
"bgp_peer_labels" : [ "aeiou" ],
"pool_ref" : "aeiou",
"delay_fairness" : true,
"cloud_ref" : "aeiou",
"analytics_policy" : {
"significant_log_throttle" : 123,
"all_headers" : true,
"client_insights" : "aeiou",
"client_log_filters" : [ {
"duration" : 123,
"all_headers" : true,
"name" : "aeiou",
"index" : 123,
"client_ip" : "",
"uri" : "",
"enabled" : true
} ],
"client_insights_sampling" : {
"client_ip" : {
"group_refs" : [ "aeiou" ],
"match_criteria" : "aeiou",
"prefixes" : [ {
"ip_addr" : "",
"mask" : 123
} ],
"ranges" : [ {
"end" : "",
"begin" : ""
} ],
"addrs" : [ {
"addr" : "aeiou",
"type" : "aeiou"
} ]
},
"skip_uris" : "",
"sample_uris" : {
"match_criteria" : "aeiou",
"string_group_refs" : [ "aeiou" ],
"match_str" : [ "aeiou" ]
}
},
"metrics_realtime_update" : {
"duration" : 123,
"enabled" : true
},
"udf_log_throttle" : 123,
"learning_log_policy" : {
"port" : 123,
"host" : "aeiou",
"enabled" : true
},
"enabled" : true,
"full_client_logs" : {
"duration" : 123,
"all_headers" : true,
"throttle" : 123,
"enabled" : true
}
},
"enable_rhi_snat" : true,
"vip" : [ {
"availability_zone" : "aeiou",
"ip6_address" : "",
"subnet" : "",
"port_uuid" : "aeiou",
"subnet_uuid" : "aeiou",
"placement_networks" : [ {
"subnet" : "",
"subnet6" : "",
"network_ref" : "aeiou"
} ],
"avi_allocated_vip" : true,
"vip_id" : "aeiou",
"ip_address" : "",
"auto_allocate_floating_ip" : true,
"enabled" : true,
"auto_allocate_ip_type" : "aeiou",
"floating_subnet6_uuid" : "aeiou",
"auto_allocate_ip" : true,
"subnet6" : "",
"floating_ip" : "",
"floating_subnet_uuid" : "aeiou",
"avi_allocated_fip" : true,
"subnet6_uuid" : "aeiou",
"floating_ip6" : "",
"ipam_network_subnet" : "",
"network_ref" : "aeiou",
"prefix_length" : 123,
"discovered_networks" : [ "" ]
} ],
"min_pools_up" : 123,
"sp_pool_refs" : [ "aeiou" ],
"apic_contract_graph" : "aeiou",
"subnet_uuid" : "aeiou",
"advertise_down_vs" : true,
"bulk_sync_kvcache" : true,
"waf_policy_ref" : "aeiou",
"labels" : [ {
"value" : "aeiou",
"key" : "aeiou"
} ],
"security_policy_ref" : "aeiou",
"ssl_sess_cache_avg_size" : 123,
"cloud_type" : "aeiou",
"scaleout_ecmp" : true,
"cloud_config_cksum" : "aeiou",
"remove_listening_port_on_vs_down" : true,
"vsvip_ref" : "aeiou",
"network_security_policy_ref" : "aeiou",
"topology_policies" : [ "" ],
"jwt_config" : {
"jwt_name" : "aeiou",
"audience" : "aeiou",
"jwt_location" : "aeiou"
},
"pool_group_ref" : "aeiou",
"ssl_profile_ref" : "aeiou",
"enabled" : true,
"limit_doser" : true,
"discovered_subnet" : [ "" ],
"max_cps_per_client" : 123,
"sso_policy_ref" : "aeiou",
"sso_policy" : {
"tenant_ref" : "aeiou",
"name" : "aeiou",
"authentication_policy" : {
"sp_metadata" : "aeiou",
"authn_rules" : [ {
"enable" : true,
"match" : {
"path" : {
"match_criteria" : "aeiou",
"string_group_refs" : [ "aeiou" ],
"match_str" : [ "aeiou" ],
"match_case" : "aeiou"
},
"host_hdr" : {
"match_criteria" : "aeiou",
"value" : [ "aeiou" ],
"match_case" : "aeiou"
},
"client_ip" : ""
},
"name" : "aeiou",
"action" : {
"type" : "aeiou"
},
"index" : 123
} ],
"default_auth_profile_ref" : "aeiou",
"cookie_timeout" : 123,
"auth_profile_ref" : "aeiou",
"entity_id" : "aeiou",
"key" : [ "" ],
"cookie_name" : "aeiou",
"single_signon_url" : "aeiou"
},
"markers" : [ "" ],
"type" : "aeiou",
"authorization_policy" : {
"authz_rules" : [ {
"enable" : true,
"match" : {
"access_token" : {
"token_name" : "aeiou",
"matches" : [ {
"string_match" : "",
"bool_match" : true,
"name" : "aeiou",
"int_match" : 123,
"is_mandatory" : true,
"type" : "aeiou",
"validate" : true
} ]
},
"path" : "",
"method" : {
"match_criteria" : "aeiou",
"methods" : [ "aeiou" ]
},
"host_hdr" : "",
"attr_matches" : [ {
"attribute_name" : "aeiou",
"attribute_value_list" : ""
} ]
},
"name" : "aeiou",
"action" : {
"status_code" : "aeiou",
"type" : "aeiou"
},
"index" : 123
} ]
},
"uuid" : "aeiou",
"url" : "aeiou",
"_last_modified" : "aeiou",
"labels" : [ "" ]
},
"network_ref" : "aeiou",
"http_policies" : [ {
"http_policy_set_ref" : "aeiou",
"index" : 123
} ],
"availability_zone" : "aeiou",
"service_metadata" : "aeiou",
"services" : [ {
"override_network_profile_ref" : "aeiou",
"port" : 123,
"port_range_end" : 123,
"enable_http2" : true,
"enable_ssl" : true,
"override_application_profile_ref" : "aeiou"
} ],
"url" : "aeiou",
"active_standby_se_tag" : "aeiou",
"nsx_securitygroup" : [ "aeiou" ],
"vh_parent_vs_uuid" : "aeiou",
"markers" : [ {
"values" : [ "aeiou" ],
"key" : "aeiou"
} ],
"vsvip_cloud_config_cksum" : "aeiou",
"east_west_placement" : true,
"subnet" : "",
"icap_request_profile_refs" : [ "aeiou" ],
"saml_sp_config" : {
"sp_metadata" : "aeiou",
"signing_ssl_key_and_certificate_ref" : "aeiou",
"cookie_timeout" : 123,
"use_idp_session_timeout" : true,
"entity_id" : "aeiou",
"key" : [ {
"hmac_key" : "aeiou",
"aes_key" : "aeiou",
"name" : "aeiou"
} ],
"cookie_name" : "aeiou",
"single_signon_url" : "aeiou"
},
"vrf_context_ref" : "aeiou",
"flow_dist" : "aeiou",
"dns_info" : [ {
"metadata" : "aeiou",
"fqdn" : "aeiou",
"num_records_in_response" : 123,
"cname" : {
"cname" : "aeiou"
},
"type" : "aeiou",
"ttl" : 123,
"algorithm" : "aeiou"
} ],
"avi_allocated_vip" : true,
"uuid" : "aeiou",
"vh_domain_name" : [ "aeiou" ],
"snat_ip" : [ "" ],
"microservice_ref" : "aeiou",
"error_page_profile_ref" : "aeiou",
"avi_allocated_fip" : true,
"server_network_profile_ref" : "aeiou",
"use_vip_as_snat" : true,
"ipam_network_subnet" : {
"subnet" : "",
"subnet_uuid" : "aeiou",
"subnet6" : "",
"subnet6_uuid" : "aeiou",
"network_ref" : "aeiou"
},
"sideband_profile" : {
"ip" : [ "" ],
"sideband_max_request_body_size" : 123
},
"performance_limits" : {
"max_concurrent_connections" : 123,
"max_throughput" : 123
},
"static_dns_records" : [ {
"ip6_address" : [ {
"ip6_address" : ""
} ],
"mx_records" : [ {
"host" : "aeiou",
"priority" : 123
} ],
"metadata" : "aeiou",
"fqdn" : [ "aeiou" ],
"ns" : [ {
"ip6_address" : "",
"ip_address" : "",
"nsname" : "aeiou"
} ],
"cname" : "",
"description" : "aeiou",
"ip_address" : [ {
"ip_address" : ""
} ],
"type" : "aeiou",
"ttl" : 123,
"wildcard_match" : true,
"txt_records" : [ {
"text_str" : "aeiou"
} ],
"num_records_in_response" : 123,
"service_locator" : [ {
"port" : 123,
"weight" : 123,
"priority" : 123,
"target" : "aeiou"
} ],
"delegated" : true,
"algorithm" : "aeiou"
} ],
"fqdn" : "aeiou",
"weight" : 123,
"auto_allocate_floating_ip" : true,
"created_by" : "aeiou",
"service_pool_select" : [ {
"service_protocol" : "aeiou",
"service_port_range_end" : 123,
"service_pool_ref" : "aeiou",
"service_pool_group_ref" : "aeiou",
"service_port" : 123
} ],
"vh_type" : "aeiou",
"allow_invalid_client_cert" : true,
"application_profile_ref" : "aeiou",
"flow_label_type" : "aeiou",
"name" : "aeiou",
"traffic_clone_profile_ref" : "aeiou",
"host_name_xlate" : "aeiou",
"connections_rate_limit" : {
"rate_limiter" : {
"period" : 123,
"count" : 123,
"name" : "aeiou",
"burst_sz" : 123
},
"period" : 123,
"count" : 123,
"action" : {
"redirect" : {
"keep_query" : true,
"path" : "",
"protocol" : "aeiou",
"status_code" : "aeiou",
"port" : 123,
"host" : {
"tokens" : [ {
"start_index" : 123,
"str_value" : "aeiou",
"end_index" : 123,
"type" : "aeiou"
} ],
"type" : "aeiou"
}
},
"file" : {
"file_content" : "aeiou",
"content_type" : "aeiou"
},
"status_code" : "aeiou",
"type" : "aeiou"
},
"burst_sz" : 123,
"explicit_tracking" : true,
"fine_grain" : true,
"http_cookie" : "aeiou",
"http_header" : "aeiou"
},
"port_uuid" : "aeiou",
"description" : "aeiou",
"vs_datascripts" : [ {
"index" : 123,
"vs_datascript_set_ref" : "aeiou"
} ],
"ssl_key_and_certificate_refs" : [ "aeiou" ],
"_last_modified" : "aeiou",
"se_group_ref" : "aeiou",
"network_profile_ref" : "aeiou",
"auto_allocate_ip" : true,
"close_client_conn_on_config_update" : true,
"floating_ip" : "",
"floating_subnet_uuid" : "aeiou",
"discovered_network_ref" : [ "aeiou" ],
"analytics_profile_ref" : "aeiou",
"use_bridge_ip_as_vip" : true,
"requests_rate_limit" : "",
"enable_rhi" : true,
"ip_address" : "",
"test_se_datastore_level_1_ref" : "aeiou",
"ssl_profile_selectors" : [ {
"ssl_profile_ref" : "aeiou",
"client_ip_list" : ""
} ],
"vh_matches" : [ {
"path" : [ "" ],
"host" : "aeiou"
} ],
"tenant_ref" : "aeiou",
"ign_pool_net_reach" : true,
"discovered_networks" : [ {
"subnet" : [ "" ],
"subnet6" : [ "" ],
"network_ref" : "aeiou"
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
VirtualService
401
log in failed
Up
get /virtualservice/{uuid}/gslbservicealgostat/
(virtualserviceUuidGslbservicealgostatGet)
Path parameters
uuid (required)
Path Parameter — UUID of the object to fetch
Consumes
This API call consumes the following media types via the
Content-Type request header:
Return type
String
Example data
Content-Type: application/json
"aeiou"
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
String
401
log in failed
Up
get /virtualservice/{uuid}/gslbservicedetail/
(virtualserviceUuidGslbservicedetailGet)
Path parameters
uuid (required)
Path Parameter — UUID of the object to fetch
Consumes
This API call consumes the following media types via the
Content-Type request header:
Return type
String
Example data
Content-Type: application/json
"aeiou"
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
String
401
log in failed
Up
get /virtualservice/{uuid}/gslbservicehmonstat/
(virtualserviceUuidGslbservicehmonstatGet)
Path parameters
uuid (required)
Path Parameter — UUID of the object to fetch
Consumes
This API call consumes the following media types via the
Content-Type request header:
Return type
String
Example data
Content-Type: application/json
"aeiou"
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
String
401
log in failed
Up
get /virtualservice/{uuid}/gslbserviceinternal/
(virtualserviceUuidGslbserviceinternalGet)
Path parameters
uuid (required)
Path Parameter — UUID of the object to fetch
Consumes
This API call consumes the following media types via the
Content-Type request header:
Return type
String
Example data
Content-Type: application/json
"aeiou"
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
String
401
log in failed
Up
get /virtualservice/{uuid}/gslbsiteinternal/
(virtualserviceUuidGslbsiteinternalGet)
Path parameters
uuid (required)
Path Parameter — UUID of the object to fetch
Consumes
This API call consumes the following media types via the
Content-Type request header:
Return type
String
Example data
Content-Type: application/json
"aeiou"
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
String
401
log in failed
Up
get /virtualservice/{uuid}/httpconnections/detail/
(virtualserviceUuidHttpconnectionsDetailGet)
Path parameters
uuid (required)
Path Parameter — UUID of the object to fetch
Consumes
This API call consumes the following media types via the
Content-Type request header:
Return type
String
Example data
Content-Type: application/json
"aeiou"
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
String
401
log in failed
Up
get /virtualservice/{uuid}/httpconnections/
(virtualserviceUuidHttpconnectionsGet)
Path parameters
uuid (required)
Path Parameter — UUID of the object to fetch
Consumes
This API call consumes the following media types via the
Content-Type request header:
Return type
String
Example data
Content-Type: application/json
"aeiou"
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
String
401
log in failed
Up
get /virtualservice/{uuid}/httppolicyset/
(virtualserviceUuidHttppolicysetGet)
Path parameters
uuid (required)
Path Parameter — UUID of the object to fetch
Consumes
This API call consumes the following media types via the
Content-Type request header:
Return type
String
Example data
Content-Type: application/json
"aeiou"
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
String
401
log in failed
Up
get /virtualservice/{uuid}/httppolicysetstats/
(virtualserviceUuidHttppolicysetstatsGet)
Path parameters
uuid (required)
Path Parameter — UUID of the object to fetch
Consumes
This API call consumes the following media types via the
Content-Type request header:
Return type
String
Example data
Content-Type: application/json
"aeiou"
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
String
401
log in failed
Up
get /virtualservice/{uuid}/httpstats/
(virtualserviceUuidHttpstatsGet)
Path parameters
uuid (required)
Path Parameter — UUID of the object to fetch
Consumes
This API call consumes the following media types via the
Content-Type request header:
Return type
String
Example data
Content-Type: application/json
"aeiou"
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
String
401
log in failed
Up
get /virtualservice/{uuid}/icapstats/
(virtualserviceUuidIcapstatsGet)
Path parameters
uuid (required)
Path Parameter — UUID of the object to fetch
Consumes
This API call consumes the following media types via the
Content-Type request header:
Return type
String
Example data
Content-Type: application/json
"aeiou"
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
String
401
log in failed
Up
get /virtualservice/{uuid}/keyval/
(virtualserviceUuidKeyvalGet)
Path parameters
uuid (required)
Path Parameter — UUID of the object to fetch
Consumes
This API call consumes the following media types via the
Content-Type request header:
Return type
String
Example data
Content-Type: application/json
"aeiou"
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
String
401
log in failed
Up
get /virtualservice/{uuid}/keyvaldispatch/
(virtualserviceUuidKeyvaldispatchGet)
Path parameters
uuid (required)
Path Parameter — UUID of the object to fetch
Consumes
This API call consumes the following media types via the
Content-Type request header:
Return type
String
Example data
Content-Type: application/json
"aeiou"
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
String
401
log in failed
Up
get /virtualservice/{uuid}/keyvalsummary/
(virtualserviceUuidKeyvalsummaryGet)
Path parameters
uuid (required)
Path Parameter — UUID of the object to fetch
Consumes
This API call consumes the following media types via the
Content-Type request header:
Return type
String
Example data
Content-Type: application/json
"aeiou"
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
String
401
log in failed
Up
get /virtualservice/{uuid}/keyvalsummaryobjsync/
(virtualserviceUuidKeyvalsummaryobjsyncGet)
Path parameters
uuid (required)
Path Parameter — UUID of the object to fetch
Consumes
This API call consumes the following media types via the
Content-Type request header:
Return type
String
Example data
Content-Type: application/json
"aeiou"
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
String
401
log in failed
Up
get /virtualservice/{uuid}/l4policysetstats/
(virtualserviceUuidL4policysetstatsGet)
Path parameters
uuid (required)
Path Parameter — UUID of the object to fetch
Consumes
This API call consumes the following media types via the
Content-Type request header:
Return type
String
Example data
Content-Type: application/json
"aeiou"
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
String
401
log in failed
Up
post /virtualservice/{uuid}/migrate
(virtualserviceUuidMigratePost)
Path parameters
uuid (required)
Path Parameter — UUID of the object to fetch
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (required)
Body Parameter — VsMigrateParams
Return type
String
Example data
Content-Type: application/json
"aeiou"
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
String
401
log in failed
Up
get /virtualservice/{uuid}/networksecuritypolicy/detail/
(virtualserviceUuidNetworksecuritypolicyDetailGet)
Path parameters
uuid (required)
Path Parameter — UUID of the object to fetch
Consumes
This API call consumes the following media types via the
Content-Type request header:
Return type
String
Example data
Content-Type: application/json
"aeiou"
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
String
401
log in failed
Up
get /virtualservice/{uuid}/networksecuritypolicystats/
(virtualserviceUuidNetworksecuritypolicystatsGet)
Path parameters
uuid (required)
Path Parameter — UUID of the object to fetch
Consumes
This API call consumes the following media types via the
Content-Type request header:
Return type
String
Example data
Content-Type: application/json
"aeiou"
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
String
401
log in failed
Up
get /virtualservice/{uuid}/outofbandstats/
(virtualserviceUuidOutofbandstatsGet)
Path parameters
uuid (required)
Path Parameter — UUID of the object to fetch
Consumes
This API call consumes the following media types via the
Content-Type request header:
Return type
String
Example data
Content-Type: application/json
"aeiou"
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
String
401
log in failed
Up
patch /virtualservice/{uuid}
(virtualserviceUuidPatch)
Path parameters
uuid (required)
Path Parameter — UUID of the object to fetch
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (required)
Body Parameter — VirtualService object creation
Query parameters
name (optional)
Query Parameter — object name
Return type
Example data
Content-Type: application/json
{
"client_auth" : {
"request_uri_path" : "",
"auth_profile_ref" : "aeiou",
"realm" : "aeiou",
"type" : "aeiou"
},
"dns_policies" : [ {
"dns_policy_ref" : "aeiou",
"index" : 123
} ],
"l4_policies" : [ {
"l4_policy_set_ref" : "aeiou",
"index" : 123
} ],
"azure_availability_set" : "aeiou",
"enable_autogw" : true,
"content_rewrite" : {
"req_match_replace_pair" : [ {
"match_string" : "aeiou",
"replacement_string" : {
"val" : "aeiou",
"type" : "aeiou"
}
} ],
"request_rewrite_enabled" : true,
"rsp_match_replace_pair" : [ "" ],
"rewritable_content_ref" : "aeiou",
"response_rewrite_enabled" : true
},
"type" : "aeiou",
"traffic_enabled" : true,
"bgp_peer_labels" : [ "aeiou" ],
"pool_ref" : "aeiou",
"delay_fairness" : true,
"cloud_ref" : "aeiou",
"analytics_policy" : {
"significant_log_throttle" : 123,
"all_headers" : true,
"client_insights" : "aeiou",
"client_log_filters" : [ {
"duration" : 123,
"all_headers" : true,
"name" : "aeiou",
"index" : 123,
"client_ip" : "",
"uri" : "",
"enabled" : true
} ],
"client_insights_sampling" : {
"client_ip" : {
"group_refs" : [ "aeiou" ],
"match_criteria" : "aeiou",
"prefixes" : [ {
"ip_addr" : "",
"mask" : 123
} ],
"ranges" : [ {
"end" : "",
"begin" : ""
} ],
"addrs" : [ {
"addr" : "aeiou",
"type" : "aeiou"
} ]
},
"skip_uris" : "",
"sample_uris" : {
"match_criteria" : "aeiou",
"string_group_refs" : [ "aeiou" ],
"match_str" : [ "aeiou" ]
}
},
"metrics_realtime_update" : {
"duration" : 123,
"enabled" : true
},
"udf_log_throttle" : 123,
"learning_log_policy" : {
"port" : 123,
"host" : "aeiou",
"enabled" : true
},
"enabled" : true,
"full_client_logs" : {
"duration" : 123,
"all_headers" : true,
"throttle" : 123,
"enabled" : true
}
},
"enable_rhi_snat" : true,
"vip" : [ {
"availability_zone" : "aeiou",
"ip6_address" : "",
"subnet" : "",
"port_uuid" : "aeiou",
"subnet_uuid" : "aeiou",
"placement_networks" : [ {
"subnet" : "",
"subnet6" : "",
"network_ref" : "aeiou"
} ],
"avi_allocated_vip" : true,
"vip_id" : "aeiou",
"ip_address" : "",
"auto_allocate_floating_ip" : true,
"enabled" : true,
"auto_allocate_ip_type" : "aeiou",
"floating_subnet6_uuid" : "aeiou",
"auto_allocate_ip" : true,
"subnet6" : "",
"floating_ip" : "",
"floating_subnet_uuid" : "aeiou",
"avi_allocated_fip" : true,
"subnet6_uuid" : "aeiou",
"floating_ip6" : "",
"ipam_network_subnet" : "",
"network_ref" : "aeiou",
"prefix_length" : 123,
"discovered_networks" : [ "" ]
} ],
"min_pools_up" : 123,
"sp_pool_refs" : [ "aeiou" ],
"apic_contract_graph" : "aeiou",
"subnet_uuid" : "aeiou",
"advertise_down_vs" : true,
"bulk_sync_kvcache" : true,
"waf_policy_ref" : "aeiou",
"labels" : [ {
"value" : "aeiou",
"key" : "aeiou"
} ],
"security_policy_ref" : "aeiou",
"ssl_sess_cache_avg_size" : 123,
"cloud_type" : "aeiou",
"scaleout_ecmp" : true,
"cloud_config_cksum" : "aeiou",
"remove_listening_port_on_vs_down" : true,
"vsvip_ref" : "aeiou",
"network_security_policy_ref" : "aeiou",
"topology_policies" : [ "" ],
"jwt_config" : {
"jwt_name" : "aeiou",
"audience" : "aeiou",
"jwt_location" : "aeiou"
},
"pool_group_ref" : "aeiou",
"ssl_profile_ref" : "aeiou",
"enabled" : true,
"limit_doser" : true,
"discovered_subnet" : [ "" ],
"max_cps_per_client" : 123,
"sso_policy_ref" : "aeiou",
"sso_policy" : {
"tenant_ref" : "aeiou",
"name" : "aeiou",
"authentication_policy" : {
"sp_metadata" : "aeiou",
"authn_rules" : [ {
"enable" : true,
"match" : {
"path" : {
"match_criteria" : "aeiou",
"string_group_refs" : [ "aeiou" ],
"match_str" : [ "aeiou" ],
"match_case" : "aeiou"
},
"host_hdr" : {
"match_criteria" : "aeiou",
"value" : [ "aeiou" ],
"match_case" : "aeiou"
},
"client_ip" : ""
},
"name" : "aeiou",
"action" : {
"type" : "aeiou"
},
"index" : 123
} ],
"default_auth_profile_ref" : "aeiou",
"cookie_timeout" : 123,
"auth_profile_ref" : "aeiou",
"entity_id" : "aeiou",
"key" : [ "" ],
"cookie_name" : "aeiou",
"single_signon_url" : "aeiou"
},
"markers" : [ "" ],
"type" : "aeiou",
"authorization_policy" : {
"authz_rules" : [ {
"enable" : true,
"match" : {
"access_token" : {
"token_name" : "aeiou",
"matches" : [ {
"string_match" : "",
"bool_match" : true,
"name" : "aeiou",
"int_match" : 123,
"is_mandatory" : true,
"type" : "aeiou",
"validate" : true
} ]
},
"path" : "",
"method" : {
"match_criteria" : "aeiou",
"methods" : [ "aeiou" ]
},
"host_hdr" : "",
"attr_matches" : [ {
"attribute_name" : "aeiou",
"attribute_value_list" : ""
} ]
},
"name" : "aeiou",
"action" : {
"status_code" : "aeiou",
"type" : "aeiou"
},
"index" : 123
} ]
},
"uuid" : "aeiou",
"url" : "aeiou",
"_last_modified" : "aeiou",
"labels" : [ "" ]
},
"network_ref" : "aeiou",
"http_policies" : [ {
"http_policy_set_ref" : "aeiou",
"index" : 123
} ],
"availability_zone" : "aeiou",
"service_metadata" : "aeiou",
"services" : [ {
"override_network_profile_ref" : "aeiou",
"port" : 123,
"port_range_end" : 123,
"enable_http2" : true,
"enable_ssl" : true,
"override_application_profile_ref" : "aeiou"
} ],
"url" : "aeiou",
"active_standby_se_tag" : "aeiou",
"nsx_securitygroup" : [ "aeiou" ],
"vh_parent_vs_uuid" : "aeiou",
"markers" : [ {
"values" : [ "aeiou" ],
"key" : "aeiou"
} ],
"vsvip_cloud_config_cksum" : "aeiou",
"east_west_placement" : true,
"subnet" : "",
"icap_request_profile_refs" : [ "aeiou" ],
"saml_sp_config" : {
"sp_metadata" : "aeiou",
"signing_ssl_key_and_certificate_ref" : "aeiou",
"cookie_timeout" : 123,
"use_idp_session_timeout" : true,
"entity_id" : "aeiou",
"key" : [ {
"hmac_key" : "aeiou",
"aes_key" : "aeiou",
"name" : "aeiou"
} ],
"cookie_name" : "aeiou",
"single_signon_url" : "aeiou"
},
"vrf_context_ref" : "aeiou",
"flow_dist" : "aeiou",
"dns_info" : [ {
"metadata" : "aeiou",
"fqdn" : "aeiou",
"num_records_in_response" : 123,
"cname" : {
"cname" : "aeiou"
},
"type" : "aeiou",
"ttl" : 123,
"algorithm" : "aeiou"
} ],
"avi_allocated_vip" : true,
"uuid" : "aeiou",
"vh_domain_name" : [ "aeiou" ],
"snat_ip" : [ "" ],
"microservice_ref" : "aeiou",
"error_page_profile_ref" : "aeiou",
"avi_allocated_fip" : true,
"server_network_profile_ref" : "aeiou",
"use_vip_as_snat" : true,
"ipam_network_subnet" : {
"subnet" : "",
"subnet_uuid" : "aeiou",
"subnet6" : "",
"subnet6_uuid" : "aeiou",
"network_ref" : "aeiou"
},
"sideband_profile" : {
"ip" : [ "" ],
"sideband_max_request_body_size" : 123
},
"performance_limits" : {
"max_concurrent_connections" : 123,
"max_throughput" : 123
},
"static_dns_records" : [ {
"ip6_address" : [ {
"ip6_address" : ""
} ],
"mx_records" : [ {
"host" : "aeiou",
"priority" : 123
} ],
"metadata" : "aeiou",
"fqdn" : [ "aeiou" ],
"ns" : [ {
"ip6_address" : "",
"ip_address" : "",
"nsname" : "aeiou"
} ],
"cname" : "",
"description" : "aeiou",
"ip_address" : [ {
"ip_address" : ""
} ],
"type" : "aeiou",
"ttl" : 123,
"wildcard_match" : true,
"txt_records" : [ {
"text_str" : "aeiou"
} ],
"num_records_in_response" : 123,
"service_locator" : [ {
"port" : 123,
"weight" : 123,
"priority" : 123,
"target" : "aeiou"
} ],
"delegated" : true,
"algorithm" : "aeiou"
} ],
"fqdn" : "aeiou",
"weight" : 123,
"auto_allocate_floating_ip" : true,
"created_by" : "aeiou",
"service_pool_select" : [ {
"service_protocol" : "aeiou",
"service_port_range_end" : 123,
"service_pool_ref" : "aeiou",
"service_pool_group_ref" : "aeiou",
"service_port" : 123
} ],
"vh_type" : "aeiou",
"allow_invalid_client_cert" : true,
"application_profile_ref" : "aeiou",
"flow_label_type" : "aeiou",
"name" : "aeiou",
"traffic_clone_profile_ref" : "aeiou",
"host_name_xlate" : "aeiou",
"connections_rate_limit" : {
"rate_limiter" : {
"period" : 123,
"count" : 123,
"name" : "aeiou",
"burst_sz" : 123
},
"period" : 123,
"count" : 123,
"action" : {
"redirect" : {
"keep_query" : true,
"path" : "",
"protocol" : "aeiou",
"status_code" : "aeiou",
"port" : 123,
"host" : {
"tokens" : [ {
"start_index" : 123,
"str_value" : "aeiou",
"end_index" : 123,
"type" : "aeiou"
} ],
"type" : "aeiou"
}
},
"file" : {
"file_content" : "aeiou",
"content_type" : "aeiou"
},
"status_code" : "aeiou",
"type" : "aeiou"
},
"burst_sz" : 123,
"explicit_tracking" : true,
"fine_grain" : true,
"http_cookie" : "aeiou",
"http_header" : "aeiou"
},
"port_uuid" : "aeiou",
"description" : "aeiou",
"vs_datascripts" : [ {
"index" : 123,
"vs_datascript_set_ref" : "aeiou"
} ],
"ssl_key_and_certificate_refs" : [ "aeiou" ],
"_last_modified" : "aeiou",
"se_group_ref" : "aeiou",
"network_profile_ref" : "aeiou",
"auto_allocate_ip" : true,
"close_client_conn_on_config_update" : true,
"floating_ip" : "",
"floating_subnet_uuid" : "aeiou",
"discovered_network_ref" : [ "aeiou" ],
"analytics_profile_ref" : "aeiou",
"use_bridge_ip_as_vip" : true,
"requests_rate_limit" : "",
"enable_rhi" : true,
"ip_address" : "",
"test_se_datastore_level_1_ref" : "aeiou",
"ssl_profile_selectors" : [ {
"ssl_profile_ref" : "aeiou",
"client_ip_list" : ""
} ],
"vh_matches" : [ {
"path" : [ "" ],
"host" : "aeiou"
} ],
"tenant_ref" : "aeiou",
"ign_pool_net_reach" : true,
"discovered_networks" : [ {
"subnet" : [ "" ],
"subnet6" : [ "" ],
"network_ref" : "aeiou"
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
VirtualService
401
log in failed
Up
get /virtualservice/{uuid}/placement/
(virtualserviceUuidPlacementGet)
Path parameters
uuid (required)
Path Parameter — UUID of the object to fetch
Consumes
This API call consumes the following media types via the
Content-Type request header:
Return type
String
Example data
Content-Type: application/json
"aeiou"
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
String
401
log in failed
Up
put /virtualservice/{uuid}
(virtualserviceUuidPut)
Path parameters
uuid (required)
Path Parameter — UUID of the object to fetch
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (required)
Body Parameter — VirtualService object creation
Query parameters
name (optional)
Query Parameter — object name
Return type
Example data
Content-Type: application/json
{
"client_auth" : {
"request_uri_path" : "",
"auth_profile_ref" : "aeiou",
"realm" : "aeiou",
"type" : "aeiou"
},
"dns_policies" : [ {
"dns_policy_ref" : "aeiou",
"index" : 123
} ],
"l4_policies" : [ {
"l4_policy_set_ref" : "aeiou",
"index" : 123
} ],
"azure_availability_set" : "aeiou",
"enable_autogw" : true,
"content_rewrite" : {
"req_match_replace_pair" : [ {
"match_string" : "aeiou",
"replacement_string" : {
"val" : "aeiou",
"type" : "aeiou"
}
} ],
"request_rewrite_enabled" : true,
"rsp_match_replace_pair" : [ "" ],
"rewritable_content_ref" : "aeiou",
"response_rewrite_enabled" : true
},
"type" : "aeiou",
"traffic_enabled" : true,
"bgp_peer_labels" : [ "aeiou" ],
"pool_ref" : "aeiou",
"delay_fairness" : true,
"cloud_ref" : "aeiou",
"analytics_policy" : {
"significant_log_throttle" : 123,
"all_headers" : true,
"client_insights" : "aeiou",
"client_log_filters" : [ {
"duration" : 123,
"all_headers" : true,
"name" : "aeiou",
"index" : 123,
"client_ip" : "",
"uri" : "",
"enabled" : true
} ],
"client_insights_sampling" : {
"client_ip" : {
"group_refs" : [ "aeiou" ],
"match_criteria" : "aeiou",
"prefixes" : [ {
"ip_addr" : "",
"mask" : 123
} ],
"ranges" : [ {
"end" : "",
"begin" : ""
} ],
"addrs" : [ {
"addr" : "aeiou",
"type" : "aeiou"
} ]
},
"skip_uris" : "",
"sample_uris" : {
"match_criteria" : "aeiou",
"string_group_refs" : [ "aeiou" ],
"match_str" : [ "aeiou" ]
}
},
"metrics_realtime_update" : {
"duration" : 123,
"enabled" : true
},
"udf_log_throttle" : 123,
"learning_log_policy" : {
"port" : 123,
"host" : "aeiou",
"enabled" : true
},
"enabled" : true,
"full_client_logs" : {
"duration" : 123,
"all_headers" : true,
"throttle" : 123,
"enabled" : true
}
},
"enable_rhi_snat" : true,
"vip" : [ {
"availability_zone" : "aeiou",
"ip6_address" : "",
"subnet" : "",
"port_uuid" : "aeiou",
"subnet_uuid" : "aeiou",
"placement_networks" : [ {
"subnet" : "",
"subnet6" : "",
"network_ref" : "aeiou"
} ],
"avi_allocated_vip" : true,
"vip_id" : "aeiou",
"ip_address" : "",
"auto_allocate_floating_ip" : true,
"enabled" : true,
"auto_allocate_ip_type" : "aeiou",
"floating_subnet6_uuid" : "aeiou",
"auto_allocate_ip" : true,
"subnet6" : "",
"floating_ip" : "",
"floating_subnet_uuid" : "aeiou",
"avi_allocated_fip" : true,
"subnet6_uuid" : "aeiou",
"floating_ip6" : "",
"ipam_network_subnet" : "",
"network_ref" : "aeiou",
"prefix_length" : 123,
"discovered_networks" : [ "" ]
} ],
"min_pools_up" : 123,
"sp_pool_refs" : [ "aeiou" ],
"apic_contract_graph" : "aeiou",
"subnet_uuid" : "aeiou",
"advertise_down_vs" : true,
"bulk_sync_kvcache" : true,
"waf_policy_ref" : "aeiou",
"labels" : [ {
"value" : "aeiou",
"key" : "aeiou"
} ],
"security_policy_ref" : "aeiou",
"ssl_sess_cache_avg_size" : 123,
"cloud_type" : "aeiou",
"scaleout_ecmp" : true,
"cloud_config_cksum" : "aeiou",
"remove_listening_port_on_vs_down" : true,
"vsvip_ref" : "aeiou",
"network_security_policy_ref" : "aeiou",
"topology_policies" : [ "" ],
"jwt_config" : {
"jwt_name" : "aeiou",
"audience" : "aeiou",
"jwt_location" : "aeiou"
},
"pool_group_ref" : "aeiou",
"ssl_profile_ref" : "aeiou",
"enabled" : true,
"limit_doser" : true,
"discovered_subnet" : [ "" ],
"max_cps_per_client" : 123,
"sso_policy_ref" : "aeiou",
"sso_policy" : {
"tenant_ref" : "aeiou",
"name" : "aeiou",
"authentication_policy" : {
"sp_metadata" : "aeiou",
"authn_rules" : [ {
"enable" : true,
"match" : {
"path" : {
"match_criteria" : "aeiou",
"string_group_refs" : [ "aeiou" ],
"match_str" : [ "aeiou" ],
"match_case" : "aeiou"
},
"host_hdr" : {
"match_criteria" : "aeiou",
"value" : [ "aeiou" ],
"match_case" : "aeiou"
},
"client_ip" : ""
},
"name" : "aeiou",
"action" : {
"type" : "aeiou"
},
"index" : 123
} ],
"default_auth_profile_ref" : "aeiou",
"cookie_timeout" : 123,
"auth_profile_ref" : "aeiou",
"entity_id" : "aeiou",
"key" : [ "" ],
"cookie_name" : "aeiou",
"single_signon_url" : "aeiou"
},
"markers" : [ "" ],
"type" : "aeiou",
"authorization_policy" : {
"authz_rules" : [ {
"enable" : true,
"match" : {
"access_token" : {
"token_name" : "aeiou",
"matches" : [ {
"string_match" : "",
"bool_match" : true,
"name" : "aeiou",
"int_match" : 123,
"is_mandatory" : true,
"type" : "aeiou",
"validate" : true
} ]
},
"path" : "",
"method" : {
"match_criteria" : "aeiou",
"methods" : [ "aeiou" ]
},
"host_hdr" : "",
"attr_matches" : [ {
"attribute_name" : "aeiou",
"attribute_value_list" : ""
} ]
},
"name" : "aeiou",
"action" : {
"status_code" : "aeiou",
"type" : "aeiou"
},
"index" : 123
} ]
},
"uuid" : "aeiou",
"url" : "aeiou",
"_last_modified" : "aeiou",
"labels" : [ "" ]
},
"network_ref" : "aeiou",
"http_policies" : [ {
"http_policy_set_ref" : "aeiou",
"index" : 123
} ],
"availability_zone" : "aeiou",
"service_metadata" : "aeiou",
"services" : [ {
"override_network_profile_ref" : "aeiou",
"port" : 123,
"port_range_end" : 123,
"enable_http2" : true,
"enable_ssl" : true,
"override_application_profile_ref" : "aeiou"
} ],
"url" : "aeiou",
"active_standby_se_tag" : "aeiou",
"nsx_securitygroup" : [ "aeiou" ],
"vh_parent_vs_uuid" : "aeiou",
"markers" : [ {
"values" : [ "aeiou" ],
"key" : "aeiou"
} ],
"vsvip_cloud_config_cksum" : "aeiou",
"east_west_placement" : true,
"subnet" : "",
"icap_request_profile_refs" : [ "aeiou" ],
"saml_sp_config" : {
"sp_metadata" : "aeiou",
"signing_ssl_key_and_certificate_ref" : "aeiou",
"cookie_timeout" : 123,
"use_idp_session_timeout" : true,
"entity_id" : "aeiou",
"key" : [ {
"hmac_key" : "aeiou",
"aes_key" : "aeiou",
"name" : "aeiou"
} ],
"cookie_name" : "aeiou",
"single_signon_url" : "aeiou"
},
"vrf_context_ref" : "aeiou",
"flow_dist" : "aeiou",
"dns_info" : [ {
"metadata" : "aeiou",
"fqdn" : "aeiou",
"num_records_in_response" : 123,
"cname" : {
"cname" : "aeiou"
},
"type" : "aeiou",
"ttl" : 123,
"algorithm" : "aeiou"
} ],
"avi_allocated_vip" : true,
"uuid" : "aeiou",
"vh_domain_name" : [ "aeiou" ],
"snat_ip" : [ "" ],
"microservice_ref" : "aeiou",
"error_page_profile_ref" : "aeiou",
"avi_allocated_fip" : true,
"server_network_profile_ref" : "aeiou",
"use_vip_as_snat" : true,
"ipam_network_subnet" : {
"subnet" : "",
"subnet_uuid" : "aeiou",
"subnet6" : "",
"subnet6_uuid" : "aeiou",
"network_ref" : "aeiou"
},
"sideband_profile" : {
"ip" : [ "" ],
"sideband_max_request_body_size" : 123
},
"performance_limits" : {
"max_concurrent_connections" : 123,
"max_throughput" : 123
},
"static_dns_records" : [ {
"ip6_address" : [ {
"ip6_address" : ""
} ],
"mx_records" : [ {
"host" : "aeiou",
"priority" : 123
} ],
"metadata" : "aeiou",
"fqdn" : [ "aeiou" ],
"ns" : [ {
"ip6_address" : "",
"ip_address" : "",
"nsname" : "aeiou"
} ],
"cname" : "",
"description" : "aeiou",
"ip_address" : [ {
"ip_address" : ""
} ],
"type" : "aeiou",
"ttl" : 123,
"wildcard_match" : true,
"txt_records" : [ {
"text_str" : "aeiou"
} ],
"num_records_in_response" : 123,
"service_locator" : [ {
"port" : 123,
"weight" : 123,
"priority" : 123,
"target" : "aeiou"
} ],
"delegated" : true,
"algorithm" : "aeiou"
} ],
"fqdn" : "aeiou",
"weight" : 123,
"auto_allocate_floating_ip" : true,
"created_by" : "aeiou",
"service_pool_select" : [ {
"service_protocol" : "aeiou",
"service_port_range_end" : 123,
"service_pool_ref" : "aeiou",
"service_pool_group_ref" : "aeiou",
"service_port" : 123
} ],
"vh_type" : "aeiou",
"allow_invalid_client_cert" : true,
"application_profile_ref" : "aeiou",
"flow_label_type" : "aeiou",
"name" : "aeiou",
"traffic_clone_profile_ref" : "aeiou",
"host_name_xlate" : "aeiou",
"connections_rate_limit" : {
"rate_limiter" : {
"period" : 123,
"count" : 123,
"name" : "aeiou",
"burst_sz" : 123
},
"period" : 123,
"count" : 123,
"action" : {
"redirect" : {
"keep_query" : true,
"path" : "",
"protocol" : "aeiou",
"status_code" : "aeiou",
"port" : 123,
"host" : {
"tokens" : [ {
"start_index" : 123,
"str_value" : "aeiou",
"end_index" : 123,
"type" : "aeiou"
} ],
"type" : "aeiou"
}
},
"file" : {
"file_content" : "aeiou",
"content_type" : "aeiou"
},
"status_code" : "aeiou",
"type" : "aeiou"
},
"burst_sz" : 123,
"explicit_tracking" : true,
"fine_grain" : true,
"http_cookie" : "aeiou",
"http_header" : "aeiou"
},
"port_uuid" : "aeiou",
"description" : "aeiou",
"vs_datascripts" : [ {
"index" : 123,
"vs_datascript_set_ref" : "aeiou"
} ],
"ssl_key_and_certificate_refs" : [ "aeiou" ],
"_last_modified" : "aeiou",
"se_group_ref" : "aeiou",
"network_profile_ref" : "aeiou",
"auto_allocate_ip" : true,
"close_client_conn_on_config_update" : true,
"floating_ip" : "",
"floating_subnet_uuid" : "aeiou",
"discovered_network_ref" : [ "aeiou" ],
"analytics_profile_ref" : "aeiou",
"use_bridge_ip_as_vip" : true,
"requests_rate_limit" : "",
"enable_rhi" : true,
"ip_address" : "",
"test_se_datastore_level_1_ref" : "aeiou",
"ssl_profile_selectors" : [ {
"ssl_profile_ref" : "aeiou",
"client_ip_list" : ""
} ],
"vh_matches" : [ {
"path" : [ "" ],
"host" : "aeiou"
} ],
"tenant_ref" : "aeiou",
"ign_pool_net_reach" : true,
"discovered_networks" : [ {
"subnet" : [ "" ],
"subnet6" : [ "" ],
"network_ref" : "aeiou"
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
VirtualService
401
log in failed
Up
post /virtualservice/{uuid}/resync
(virtualserviceUuidResyncPost)
Path parameters
uuid (required)
Path Parameter — UUID of the object to fetch
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (required)
Body Parameter — VsResyncParams
Return type
String
Example data
Content-Type: application/json
"aeiou"
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
String
401
log in failed
Up
post /virtualservice/{uuid}/retryplacement
(virtualserviceUuidRetryplacementPost)
Path parameters
uuid (required)
Path Parameter — UUID of the object to fetch
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (required)
Body Parameter — RetryPlacementParams
Return type
String
Example data
Content-Type: application/json
"aeiou"
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
String
401
log in failed
Up
post /virtualservice/{uuid}/rotatekeys
(virtualserviceUuidRotatekeysPost)
Path parameters
uuid (required)
Path Parameter — UUID of the object to fetch
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (required)
Body Parameter — empty
Return type
String
Example data
Content-Type: application/json
"aeiou"
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
String
401
log in failed
Up
get /virtualservice/{uuid}/runtime/detail/
(virtualserviceUuidRuntimeDetailGet)
Path parameters
uuid (required)
Path Parameter — UUID of the object to fetch
Consumes
This API call consumes the following media types via the
Content-Type request header:
Return type
String
Example data
Content-Type: application/json
"aeiou"
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
String
401
log in failed
Up
get /virtualservice/{uuid}/runtime/
(virtualserviceUuidRuntimeGet)
Path parameters
uuid (required)
Path Parameter — UUID of the object to fetch
Consumes
This API call consumes the following media types via the
Content-Type request header:
Return type
String
Example data
Content-Type: application/json
"aeiou"
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
String
401
log in failed
Up
get /virtualservice/{uuid}/runtime/internal/
(virtualserviceUuidRuntimeInternalGet)
Path parameters
uuid (required)
Path Parameter — UUID of the object to fetch
Consumes
This API call consumes the following media types via the
Content-Type request header:
Return type
String
Example data
Content-Type: application/json
"aeiou"
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
String
401
log in failed
Up
post /virtualservice/{uuid}/scalein
(virtualserviceUuidScaleinPost)
Path parameters
uuid (required)
Path Parameter — UUID of the object to fetch
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (required)
Body Parameter — VsScaleinParams
Return type
String
Example data
Content-Type: application/json
"aeiou"
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
String
401
log in failed
Up
post /virtualservice/{uuid}/scaleout
(virtualserviceUuidScaleoutPost)
Path parameters
uuid (required)
Path Parameter — UUID of the object to fetch
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (required)
Body Parameter — VsScaleoutParams
Return type
String
Example data
Content-Type: application/json
"aeiou"
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
String
401
log in failed
Up
get /virtualservice/{uuid}/scaleoutstatus/detail/
(virtualserviceUuidScaleoutstatusDetailGet)
Path parameters
uuid (required)
Path Parameter — UUID of the object to fetch
Consumes
This API call consumes the following media types via the
Content-Type request header:
Return type
String
Example data
Content-Type: application/json
"aeiou"
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
String
401
log in failed
Up
get /virtualservice/{uuid}/scaleoutstatus/
(virtualserviceUuidScaleoutstatusGet)
Path parameters
uuid (required)
Path Parameter — UUID of the object to fetch
Consumes
This API call consumes the following media types via the
Content-Type request header:
Return type
String
Example data
Content-Type: application/json
"aeiou"
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
String
401
log in failed
Up
get /virtualservice/{uuid}/scaleoutstatus/keyval/
(virtualserviceUuidScaleoutstatusKeyvalGet)
Path parameters
uuid (required)
Path Parameter — UUID of the object to fetch
Consumes
This API call consumes the following media types via the
Content-Type request header:
Return type
String
Example data
Content-Type: application/json
"aeiou"
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
String
401
log in failed
Up
get /virtualservice/{uuid}/scaleoutstatus/keyvalsummary/
(virtualserviceUuidScaleoutstatusKeyvalsummaryGet)
Path parameters
uuid (required)
Path Parameter — UUID of the object to fetch
Consumes
This API call consumes the following media types via the
Content-Type request header:
Return type
String
Example data
Content-Type: application/json
"aeiou"
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
String
401
log in failed
Up
get /virtualservice/{uuid}/sescaleoutstatus/
(virtualserviceUuidSescaleoutstatusGet)
Path parameters
uuid (required)
Path Parameter — UUID of the object to fetch
Consumes
This API call consumes the following media types via the
Content-Type request header:
Return type
String
Example data
Content-Type: application/json
"aeiou"
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
String
401
log in failed
Up
get /virtualservice/{uuid}/sslsessioncache/
(virtualserviceUuidSslsessioncacheGet)
Path parameters
uuid (required)
Path Parameter — UUID of the object to fetch
Consumes
This API call consumes the following media types via the
Content-Type request header:
Return type
String
Example data
Content-Type: application/json
"aeiou"
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
String
401
log in failed
Up
get /virtualservice/{uuid}/ssopolicystats/
(virtualserviceUuidSsopolicystatsGet)
Path parameters
uuid (required)
Path Parameter — UUID of the object to fetch
Consumes
This API call consumes the following media types via the
Content-Type request header:
Return type
String
Example data
Content-Type: application/json
"aeiou"
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
String
401
log in failed
Up
post /virtualservice/{uuid}/switchover
(virtualserviceUuidSwitchoverPost)
Path parameters
uuid (required)
Path Parameter — UUID of the object to fetch
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (required)
Body Parameter — VsSwitchoverParams
Return type
String
Example data
Content-Type: application/json
"aeiou"
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
String
401
log in failed
Up
get /virtualservice/{uuid}/tcpstat/
(virtualserviceUuidTcpstatGet)
Path parameters
uuid (required)
Path Parameter — UUID of the object to fetch
Consumes
This API call consumes the following media types via the
Content-Type request header:
Return type
String
Example data
Content-Type: application/json
"aeiou"
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
String
401
log in failed
Up
get /virtualservice/{uuid}/traffic_clone_stats/
(virtualserviceUuidTrafficCloneStatsGet)
Path parameters
uuid (required)
Path Parameter — UUID of the object to fetch
Consumes
This API call consumes the following media types via the
Content-Type request header:
Return type
String
Example data
Content-Type: application/json
"aeiou"
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
String
401
log in failed
Up
get /virtualservice/{uuid}/udpstat/
(virtualserviceUuidUdpstatGet)
Path parameters
uuid (required)
Path Parameter — UUID of the object to fetch
Consumes
This API call consumes the following media types via the
Content-Type request header:
Return type
String
Example data
Content-Type: application/json
"aeiou"
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
String
401
log in failed
Up
get /virtualservice/{uuid}/userdefineddatascriptcounters/
(virtualserviceUuidUserdefineddatascriptcountersGet)
Path parameters
uuid (required)
Path Parameter — UUID of the object to fetch
Consumes
This API call consumes the following media types via the
Content-Type request header:
Return type
String
Example data
Content-Type: application/json
"aeiou"
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
String
401
log in failed
[ Jump to Methods ]
Table of Contents
APICNetworkRelAnalyticsPolicyApicVSPlacementReqAuthAttributeMatchAuthenticationActionAuthenticationMatchAuthenticationPolicyAuthenticationRuleAuthorizationActionAuthorizationMatchAuthorizationPolicyAuthorizationRuleCifClientInsightsSamplingClientLogFilterConnectionClearFilterContentRewriteProfileDiscoveredNetworkDnsAAAARdataDnsARdataDnsCnameRdataDnsInfoDnsMxRdataDnsNsRdataDnsPoliciesDnsRecordDnsSrvRdataDnsTxtRdataFullClientLogsHTTPClientAuthenticationParamsHTTPLocalFileHTTPPoliciesHTTPRedirectActionHostHdrMatchHttpCookiePersistenceKeyIPNetworkSubnetIpAddrIpAddrMatchIpAddrPrefixIpAddrRangeJWTClaimMatchJWTMatchJWTValidationVsConfigKeyValueL4PoliciesLearningLogPolicyLifMatchReplacePairMethodMatchMetricsRealTimeUpdatePathMatchPerformanceLimitsRateLimiterRateLimiterActionRateProfileReplaceStringVarRetryPlacementParamsRoleFilterMatchLabelSAMLSPConfigSSLCacheFilterSSLProfileSelectorSSOPolicySSOPolicyApiResponseServiceServicePoolSelectorSidebandProfileStringMatchURIParamURIParamTokenVHMatchVSDataScriptsVipVipPlacementNetworkVirtualServiceVirtualServiceApiResponseVsMigrateParamsVsResyncParamsVsScaleinParamsVsScaleoutParamsVsSwitchoverParams
connector (optional)
String connector of APICNetworkRel.
rel_key (optional)
String rel_key of APICNetworkRel.
target_network (optional)
String target_network of APICNetworkRel.
all_headers (optional)
Boolean Log all headers. Field introduced in 18.1.4, 18.2.1.
client_insights (optional)
String Gain insights from sampled client to server HTTP requests and responses. Enum options - NO_INSIGHTS, PASSIVE, ACTIVE.
client_insights_sampling (optional)
ClientInsightsSampling Placeholder for description of property client_insights_sampling of obj type AnalyticsPolicy field type str type object
client_log_filters (optional)
array[ClientLogFilter] Placeholder for description of property client_log_filters of obj type AnalyticsPolicy field type str type object
enabled (optional)
Boolean [DEPRECATED] Disable Analytics on this VirtualService. This will disable the collection of both metrics and logs. Please use following fields in AnalytcsProfile to control this behavior instead. disable_vs_analytics (for VirtualServices metrics), disable_server_analytics (for Pool metrics) and client_log_config (for logs). Field deprecated in 18.2.1. Field introduced in 17.2.4.
full_client_logs (optional)
FullClientLogs Placeholder for description of property full_client_logs of obj type AnalyticsPolicy field type str type object
learning_log_policy (optional)
LearningLogPolicy Configuration for learning logging determining whether it's enabled and where is the destination. Field introduced in 20.1.3.
metrics_realtime_update (optional)
significant_log_throttle (optional)
Integer This setting limits the number of significant logs generated per second for this VS on each SE. Default is 10 logs per second. Set it to zero (0) to deactivate throttling. Field introduced in 17.1.3. Unit is PER_SECOND. format: int32
udf_log_throttle (optional)
Integer This setting limits the total number of UDF logs generated per second for this VS on each SE. UDF logs are generated due to the configured client log filters or the rules with logging enabled. Default is 10 logs per second. Set it to zero (0) to deactivate throttling. Field introduced in 17.1.3. Unit is PER_SECOND. format: int32
graph (optional)
String graph of ApicVSPlacementReq.
lifs (optional)
array[Lif] Placeholder for description of property lifs of obj type ApicVSPlacementReq field type str type object
network_rel (optional)
array[APICNetworkRel] Placeholder for description of property network_rel of obj type ApicVSPlacementReq field type str type object
tenant_name (optional)
String tenant_name of ApicVSPlacementReq.
vdev (optional)
String vdev of ApicVSPlacementReq.
vgrp (optional)
String vgrp of ApicVSPlacementReq.
attribute_name
String Attribute name whose values will be looked up in the access lists. Field introduced in 18.2.5.
attribute_value_list
StringMatch Attribute Values used to determine access when authentication applies. Field introduced in 18.2.5. Allowed in Basic edition, Essentials edition, Enterprise edition.
type
String Authentication Action to be taken for a matched Rule. Enum options - SKIP_AUTHENTICATION, USE_DEFAULT_AUTHENTICATION. Field introduced in 18.2.5.
client_ip (optional)
IpAddrMatch Configure client ip addresses. Field introduced in 18.2.5.
host_hdr (optional)
HostHdrMatch Configure the host header. Field introduced in 18.2.5.
path (optional)
PathMatch Configure request paths. Field introduced in 18.2.5.
auth_profile_ref (optional)
String Auth Profile to use for validating users. It is a reference to an object of type AuthProfile. Field deprecated in 18.2.3. Field introduced in 18.2.1.
authn_rules (optional)
cookie_name (optional)
String HTTP cookie name for authenticated session. Field deprecated in 18.2.3. Field introduced in 18.2.1.
cookie_timeout (optional)
Integer Cookie timeout in minutes. Allowed values are 1-1440. Field deprecated in 18.2.3. Field introduced in 18.2.1. Unit is MIN. format: int32
default_auth_profile_ref
String Auth Profile to use for validating users. It is a reference to an object of type AuthProfile. Field introduced in 18.2.3.
entity_id (optional)
String Globally unique entityID for this node. Entity ID on the IDP should match this. Field deprecated in 18.2.3. Field introduced in 18.2.1.
key (optional)
single_signon_url (optional)
String Single Signon URL to be programmed on the IDP. Field deprecated in 18.2.3. Field introduced in 18.2.1.
sp_metadata (optional)
String SAML SP metadata. Field deprecated in 18.2.3. Field introduced in 18.2.1.
action (optional)
AuthenticationAction Enable or disable authentication for matched targets. Field introduced in 18.2.5.
enable
Boolean Enable or disable the rule. Field introduced in 18.2.5.
index
Integer Index of the rule. Field introduced in 18.2.5. format: int32
match (optional)
AuthenticationMatch Add match criteria to the rule. Field introduced in 18.2.5. Allowed in Basic edition, Essentials edition, Enterprise edition.
name
String Name of the rule. Field introduced in 18.2.5.
status_code (optional)
String HTTP status code to use for local response when an policy rule is matched. Enum options - HTTP_RESPONSE_STATUS_CODE_401, HTTP_RESPONSE_STATUS_CODE_403. Field introduced in 18.2.5.
type (optional)
String Defines the action taken when an authorization policy rule is matched. By default, access is allowed to the requested resource. Enum options - ALLOW_ACCESS, CLOSE_CONNECTION, HTTP_LOCAL_RESPONSE. Field introduced in 18.2.5.
access_token (optional)
JWTMatch Access Token claims to be matched. Field introduced in 20.1.3.
attr_matches (optional)
array[AuthAttributeMatch] Attributes whose values need to be matched . Field introduced in 18.2.5. Allowed in Basic edition, Essentials edition, Enterprise edition.
host_hdr (optional)
HostHdrMatch Host header value to be matched. Field introduced in 18.2.5.
method (optional)
MethodMatch HTTP methods to be matched. Field introduced in 18.2.5.
path (optional)
PathMatch Paths/URLs to be matched. Field introduced in 18.2.5.
action
enable
Boolean Enable or disable the rule. Field introduced in 18.2.5.
index
Integer Index of the Authorization Policy rule. Field introduced in 18.2.5. format: int32
match
AuthorizationMatch Authorization match criteria for the rule. Field introduced in 18.2.5. Allowed in Basic edition, Essentials edition, Enterprise edition.
name
String Name of the rule. Field introduced in 18.2.5.
adapter (optional)
cif (optional)
mac_address (optional)
resources (optional)
se_uuid (optional)
String Unique object identifier of se.
client_ip (optional)
IpAddrMatch Client IP addresses to check when inserting RUM script.
sample_uris (optional)
StringMatch URL patterns to check when inserting RUM script.
skip_uris (optional)
StringMatch URL patterns to avoid when inserting RUM script.
all_headers (optional)
Boolean Placeholder for description of property all_headers of obj type ClientLogFilter field type str type boolean
client_ip (optional)
IpAddrMatch Placeholder for description of property client_ip of obj type ClientLogFilter field type str type object
duration (optional)
Integer Special values are 0 - 'infinite'. Unit is MIN. format: int32
enabled
Boolean Placeholder for description of property enabled of obj type ClientLogFilter field type str type boolean
index
Integer Number of index. format: int32
name
uri (optional)
StringMatch Placeholder for description of property uri of obj type ClientLogFilter field type str type object
ip_addr (optional)
String IP address in dotted decimal notation.
port (optional)
req_match_replace_pair (optional)
array[MatchReplacePair] Strings to be matched and replaced with on the request body. This should be configured when request_rewrite_enabled is set to true. This is currently not supported.
request_rewrite_enabled (optional)
Boolean Enable rewrite on request body. This is not currently supported.
response_rewrite_enabled (optional)
Boolean Enable rewrite on response body.
rewritable_content_ref (optional)
String Rewrite only content types listed in this string group. Content types not present in this list are not rewritten. It is a reference to an object of type StringGroup.
rsp_match_replace_pair (optional)
array[MatchReplacePair] Strings to be matched and replaced with on the response body. This should be configured when response_rewrite_enabled is set to true.
network_ref
String Discovered network for this IP. It is a reference to an object of type Network.
subnet (optional)
subnet6 (optional)
ip6_address
IpAddr IPv6 address for FQDN. Field introduced in 18.1.1.
algorithm (optional)
String Specifies the algorithm to pick the IP address(es) to be returned, when multiple entries are configured. This does not apply if num_records_in_response is 0. Default is consistent hash. Enum options - DNS_RECORD_RESPONSE_ROUND_ROBIN, DNS_RECORD_RESPONSE_CONSISTENT_HASH. Field introduced in 17.1.1.
cname (optional)
DnsCnameRdata Canonical name in CNAME record. Field introduced in 17.2.1.
fqdn (optional)
String Fully qualified domain name.
metadata (optional)
String Any metadata associated with this record. Field introduced in 17.2.2.
num_records_in_response (optional)
Integer Specifies the number of records returned for this FQDN. Enter 0 to return all records. Default is 0. Allowed values are 0-20. Special values are 0- 'Return all records'. Field introduced in 17.1.1. format: int32
ttl (optional)
Integer Time to live for fqdn record. Default value is chosen from DNS profile for this cloud if no value provided. format: int32
type (optional)
String DNS record type. Enum options - DNS_RECORD_OTHER, DNS_RECORD_A, DNS_RECORD_NS, DNS_RECORD_CNAME, DNS_RECORD_SOA, DNS_RECORD_PTR, DNS_RECORD_HINFO, DNS_RECORD_MX, DNS_RECORD_TXT, DNS_RECORD_RP, DNS_RECORD_DNSKEY, DNS_RECORD_AAAA, DNS_RECORD_SRV, DNS_RECORD_OPT, DNS_RECORD_RRSIG, DNS_RECORD_AXFR, DNS_RECORD_ANY.
host
String Fully qualified domain name of a mailserver . The host name maps directly to one or more address records in the DNS table, and must not point to any CNAME records (RFC 2181). Field introduced in 18.2.9, 20.1.1.
priority
Integer The priority field identifies which mail server should be preferred. Allowed values are 0-65535. Field introduced in 18.2.9, 20.1.1. format: int32
ip6_address (optional)
IpAddr IPv6 address for Name Server. Field introduced in 18.1.1.
ip_address (optional)
IpAddr IP address for Name Server. Field introduced in 17.1.1.
nsname
String Name Server name. Field introduced in 17.1.1.
dns_policy_ref
String UUID of the dns policy. It is a reference to an object of type DnsPolicy. Field introduced in 17.1.1.
index
Integer Index of the dns policy. Field introduced in 17.1.1. format: int32
algorithm (optional)
String Specifies the algorithm to pick the IP address(es) to be returned, when multiple entries are configured. This does not apply if num_records_in_response is 0. Default is round-robin. Enum options - DNS_RECORD_RESPONSE_ROUND_ROBIN, DNS_RECORD_RESPONSE_CONSISTENT_HASH. Field introduced in 17.1.1.
cname (optional)
delegated (optional)
Boolean Configured FQDNs are delegated domains (i.e. they represent a zone cut). Field introduced in 17.1.2.
description (optional)
fqdn (optional)
array[String] Fully Qualified Domain Name. Minimum of 1 items required.
ip6_address (optional)
array[DnsAAAARdata] IPv6 address in AAAA record. Field introduced in 18.1.1. Maximum of 4 items allowed.
ip_address (optional)
metadata (optional)
String Internal metadata for the DNS record. Field introduced in 18.2.5.
mx_records (optional)
array[DnsMxRdata] MX record. Field introduced in 18.2.9, 20.1.1. Maximum of 4 items allowed.
ns (optional)
array[DnsNsRdata] Name Server information in NS record. Field introduced in 17.1.1. Maximum of 13 items allowed.
num_records_in_response (optional)
Integer Specifies the number of records returned by the DNS service. Enter 0 to return all records. Default is 0. Allowed values are 0-20. Special values are 0- 'Return all records'. Field introduced in 17.1.1. format: int32
service_locator (optional)
ttl (optional)
Integer Time To Live for this DNS record. format: int32
txt_records (optional)
array[DnsTxtRdata] Text record. Field introduced in 18.2.9, 20.1.1. Maximum of 4 items allowed.
type
String DNS record type. Enum options - DNS_RECORD_OTHER, DNS_RECORD_A, DNS_RECORD_NS, DNS_RECORD_CNAME, DNS_RECORD_SOA, DNS_RECORD_PTR, DNS_RECORD_HINFO, DNS_RECORD_MX, DNS_RECORD_TXT, DNS_RECORD_RP, DNS_RECORD_DNSKEY, DNS_RECORD_AAAA, DNS_RECORD_SRV, DNS_RECORD_OPT, DNS_RECORD_RRSIG, DNS_RECORD_AXFR, DNS_RECORD_ANY.
wildcard_match (optional)
Boolean Enable wild-card match of fqdn if an exact match is not found in the DNS table, the longest match is chosen by wild-carding the fqdn in the DNS request. Default is false. Field introduced in 17.1.1.
port
Integer Service port. Allowed values are 0-65535. format: int32
priority (optional)
Integer Priority of the target hosting the service, low value implies higher priority for this service record. Allowed values are 0-65535. format: int32
target (optional)
String Canonical hostname, of the machine hosting the service, with no trailing period. 'default.host' is valid but not 'default.host.'.
weight (optional)
Integer Relative weight for service records with same priority, high value implies higher preference for this service record. Allowed values are 0-65535. format: int32
text_str
String Text data associated with the FQDN. Field introduced in 18.2.9, 20.1.1.
all_headers (optional)
Boolean [DEPRECATED] Log all headers. Please use the all_headers flag in AnalyticsPolicy. Field deprecated in 18.1.4, 18.2.1.
duration (optional)
Integer How long should the system capture all logs, measured in minutes. Set to 0 for infinite. Special values are 0 - 'infinite'. Unit is MIN. format: int32
enabled
Boolean Capture all client logs including connections and requests. When deactivated, only errors will be logged. Allowed in Basic(Allowed values- false) edition, Essentials(Allowed values- false) edition, Enterprise edition. Special default for Basic edition is false, Essentials edition is false, Enterprise is False.
throttle (optional)
Integer This setting limits the number of non-significant logs generated per second for this VS on each SE. Default is 10 logs per second. Set it to zero (0) to deactivate throttling. Field introduced in 17.1.3. Unit is PER_SECOND. format: int32
auth_profile_ref (optional)
String Auth Profile to use for validating users. It is a reference to an object of type AuthProfile.
realm (optional)
String Basic authentication realm to present to a user along with the prompt for credentials.
request_uri_path (optional)
StringMatch Rrequest URI path when the authentication applies.
type (optional)
String type of client authentication. Enum options - HTTP_BASIC_AUTH.
content_type
String Mime-type of the content in the file.
file_content
String File content to used in the local HTTP response body.
http_policy_set_ref
String UUID of the virtual service HTTP policy collection. It is a reference to an object of type HTTPPolicySet.
index
Integer Index of the virtual service HTTP policy collection. format: int32
host (optional)
keep_query (optional)
Boolean Keep or drop the query of the incoming request URI in the redirected URI.
path (optional)
port (optional)
Integer Port to which redirect the request. Allowed values are 1-65535. format: int32
protocol
String Protocol type. Enum options - HTTP, HTTPS.
status_code (optional)
String HTTP redirect status code. Enum options - HTTP_REDIRECT_STATUS_CODE_301, HTTP_REDIRECT_STATUS_CODE_302, HTTP_REDIRECT_STATUS_CODE_307.
match_case (optional)
String Case sensitivity to use for the match. Enum options - SENSITIVE, INSENSITIVE.
match_criteria
String Criterion to use for the host header value match. Enum options - HDR_EXISTS, HDR_DOES_NOT_EXIST, HDR_BEGINS_WITH, HDR_DOES_NOT_BEGIN_WITH, HDR_CONTAINS, HDR_DOES_NOT_CONTAIN, HDR_ENDS_WITH, HDR_DOES_NOT_END_WITH, HDR_EQUALS, HDR_DOES_NOT_EQUAL.
value (optional)
aes_key (optional)
String aes_key of HttpCookiePersistenceKey.
hmac_key (optional)
String hmac_key of HttpCookiePersistenceKey.
name (optional)
String name to use for cookie encryption.
network_ref (optional)
String Network for VirtualService IP allocation with Vantage as the IPAM provider. Network should be created before this is configured. It is a reference to an object of type Network.
subnet (optional)
IpAddrPrefix Subnet for VirtualService IP allocation with Vantage or Infoblox as the IPAM provider. Only one of subnet or subnet_uuid configuration is allowed.
subnet6 (optional)
IpAddrPrefix Subnet for VirtualService IPv6 allocation with Vantage or Infoblox as the IPAM provider. Only one of subnet or subnet_uuid configuration is allowed. Field introduced in 18.1.1. Allowed in Basic edition, Essentials edition, Enterprise edition.
subnet6_uuid (optional)
String Subnet UUID or Name or Prefix for VirtualService IPv6 allocation with AWS or OpenStack as the IPAM provider. Only one of subnet or subnet_uuid configuration is allowed. Field introduced in 18.1.1. Allowed in Basic edition, Essentials edition, Enterprise edition.
subnet_uuid (optional)
String Subnet UUID or Name or Prefix for VirtualService IP allocation with AWS or OpenStack as the IPAM provider. Only one of subnet or subnet_uuid configuration is allowed.
addr
type
String Enum options - V4, DNS, V6.
addrs (optional)
group_refs (optional)
array[String] UUID of IP address group(s). It is a reference to an object of type IpAddrGroup.
match_criteria
String Criterion to use for IP address matching the HTTP request. Enum options - IS_IN, IS_NOT_IN.
prefixes (optional)
ranges (optional)
ip_addr
IpAddr Placeholder for description of property ip_addr of obj type IpAddrPrefix field type str type object
mask
Integer Number of mask. format: int32
begin
IpAddr Starting IP address of the range.
end
IpAddr Ending IP address of the range.
bool_match (optional)
Boolean Boolean value against which the claim is matched. Field introduced in 20.1.3.
int_match (optional)
Integer Integer value against which the claim is matched. Field introduced in 20.1.3. format: int32
is_mandatory
Boolean Specified Claim should be present in the JWT. Field introduced in 20.1.3.
name
String JWT Claim name to be validated. Field introduced in 20.1.3.
string_match (optional)
StringMatch String values against which the claim is matched. Field introduced in 20.1.3.
type
String Specifies the type of the Claim. Enum options - JWT_CLAIM_TYPE_BOOL, JWT_CLAIM_TYPE_INT, JWT_CLAIM_TYPE_STRING. Field introduced in 20.1.3.
validate
Boolean Specifies whether to validate the Claim value. Field introduced in 20.1.3.
matches (optional)
token_name (optional)
String Token for which the claims need to be validated. Field introduced in 20.1.3.
audience
String Uniquely identifies a resource server. This is used to validate against the aud claim. Field introduced in 20.1.3.
jwt_location
String Defines where to look for JWT in the request. Enum options - JWT_LOCATION_AUTHORIZATION_HEADER, JWT_LOCATION_QUERY_PARAM. Field introduced in 20.1.3.
jwt_name (optional)
String Name by which the JWT can be identified if the token is sent as a query param in the request url. Field introduced in 20.1.3.
index
Integer Index of the virtual service L4 policy set. Field introduced in 17.2.7. format: int32
l4_policy_set_ref
String ID of the virtual service L4 policy set. It is a reference to an object of type L4PolicySet. Field introduced in 17.2.7.
enabled (optional)
Boolean Determine whether app learning logging is enabled. Field introduced in 20.1.3.
host (optional)
String Host name where learning logs will be sent to. Field introduced in 20.1.3.
port (optional)
Integer Port number for the service listening for learning logs. Field introduced in 20.1.3. format: int32
cifs (optional)
array[Cif] Placeholder for description of property cifs of obj type Lif field type str type object
lif (optional)
lif_label (optional)
subnet (optional)
match_string
replacement_string (optional)
match_criteria
String Criterion to use for HTTP method matching the method in the HTTP request. Enum options - IS_IN, IS_NOT_IN.
methods (optional)
array[String] Configure HTTP method(s). Enum options - HTTP_METHOD_GET, HTTP_METHOD_HEAD, HTTP_METHOD_PUT, HTTP_METHOD_DELETE, HTTP_METHOD_POST, HTTP_METHOD_OPTIONS, HTTP_METHOD_TRACE, HTTP_METHOD_CONNECT, HTTP_METHOD_PATCH, HTTP_METHOD_PROPFIND, HTTP_METHOD_PROPPATCH, HTTP_METHOD_MKCOL, HTTP_METHOD_COPY, HTTP_METHOD_MOVE, HTTP_METHOD_LOCK, HTTP_METHOD_UNLOCK. Minimum of 1 items required. Maximum of 16 items allowed. Allowed in Basic(Allowed values- HTTP_METHOD_GET,HTTP_METHOD_PUT,HTTP_METHOD_POST,HTTP_METHOD_HEAD,HTTP_METHOD_OPTIONS) edition, Essentials(Allowed values- HTTP_METHOD_GET,HTTP_METHOD_PUT,HTTP_METHOD_POST,HTTP_METHOD_HEAD,HTTP_METHOD_OPTIONS) edition, Enterprise edition.
duration (optional)
Integer Real time metrics collection duration in minutes. 0 for infinite. Special values are 0 - 'infinite'. Unit is MIN. format: int32
enabled
Boolean Enables real time metrics collection. When deactivated, 6 hour view is the most granular the system will track.
match_case (optional)
String Case sensitivity to use for the matching. Enum options - SENSITIVE, INSENSITIVE.
match_criteria
String Criterion to use for matching the path in the HTTP request URI. Enum options - BEGINS_WITH, DOES_NOT_BEGIN_WITH, CONTAINS, DOES_NOT_CONTAIN, ENDS_WITH, DOES_NOT_END_WITH, EQUALS, DOES_NOT_EQUAL, REGEX_MATCH, REGEX_DOES_NOT_MATCH. Allowed in Basic(Allowed values- BEGINS_WITH,DOES_NOT_BEGIN_WITH,CONTAINS,DOES_NOT_CONTAIN,ENDS_WITH,DOES_NOT_END_WITH,EQUALS,DOES_NOT_EQUAL) edition, Essentials(Allowed values- BEGINS_WITH,DOES_NOT_BEGIN_WITH,CONTAINS,DOES_NOT_CONTAIN,ENDS_WITH,DOES_NOT_END_WITH,EQUALS,DOES_NOT_EQUAL) edition, Enterprise edition.
match_str (optional)
string_group_refs (optional)
array[String] UUID of the string group(s). It is a reference to an object of type StringGroup.
max_concurrent_connections (optional)
Integer The maximum number of concurrent client conections allowed to the Virtual Service. format: int32
max_throughput (optional)
Integer The maximum throughput per second for all clients allowed through the client side of the Virtual Service. format: int32
burst_sz (optional)
Integer Maximum number of connections, requests or packets to be let through instantaneously. If this is less than count, it will have no effect. Allowed values are 0-1000000000. Field introduced in 18.2.9. format: int32
count
Integer Maximum number of connections, requests or packets permitted each period. Allowed values are 1-1000000000. Field introduced in 18.2.9. format: int32
name (optional)
String Identifier for Rate Limit. Constructed according to context. Field introduced in 18.2.9.
period
Integer Time value in seconds to enforce rate count. Allowed values are 1-1000000000. Field introduced in 18.2.9. Unit is SEC. format: int32
file (optional)
HTTPLocalFile File to be used for HTTP Local response rate limit action.
redirect (optional)
status_code (optional)
String HTTP status code for Local Response rate limit action. Enum options - HTTP_LOCAL_RESPONSE_STATUS_CODE_200, HTTP_LOCAL_RESPONSE_STATUS_CODE_204, HTTP_LOCAL_RESPONSE_STATUS_CODE_403, HTTP_LOCAL_RESPONSE_STATUS_CODE_404, HTTP_LOCAL_RESPONSE_STATUS_CODE_429, HTTP_LOCAL_RESPONSE_STATUS_CODE_501.
type (optional)
String Type of action to be enforced upon hitting the rate limit. Enum options - RL_ACTION_NONE, RL_ACTION_DROP_CONN, RL_ACTION_RESET_CONN, RL_ACTION_CLOSE_CONN, RL_ACTION_LOCAL_RSP, RL_ACTION_REDIRECT.
action
burst_sz (optional)
Integer Maximum number of connections or requests or packets to be let through instantaneously. Allowed values are 10-2500. Special values are 0- 'automatic'. Field deprecated in 18.2.9. format: int32
count (optional)
Integer Maximum number of connections or requests or packets. Allowed values are 1-1000000000. Special values are 0- 'unlimited'. Field deprecated in 18.2.9. format: int32
explicit_tracking (optional)
Boolean Explicitly tracks an attacker across rate periods.
fine_grain (optional)
http_cookie (optional)
String HTTP cookie name. Field introduced in 17.1.1.
http_header (optional)
String HTTP header name. Field introduced in 17.1.1.
period (optional)
Integer Time value in seconds to enforce rate count. Allowed values are 1-300. Field deprecated in 18.2.9. Unit is SEC. format: int32
rate_limiter (optional)
RateLimiter The rate limiter configuration for this rate profile. Field introduced in 18.2.9.
type (optional)
String Type of replacement string - can be a variable exposed from datascript, value of an HTTP header or a custom user-input literal string. Enum options - DATASCRIPT_VAR, HTTP_HEADER_VAR, LITERAL_STRING.
val (optional)
String Value of the replacement string - name of variable exposed from datascript, name of the HTTP header or a custom user-input literal string.
all_east_west (optional)
Boolean Retry placement operations for all East-West services. Field introduced in 17.1.6,17.2.2.
uuid (optional)
String Unique object identifier of the object.
vip_id
String Indicates the vip_id that needs placement retrial. Field introduced in 17.1.2.
key
String Key for filter match. Field introduced in 20.1.3.
values (optional)
array[String] Values for filter match. Multiple values will be evaluated as OR. Example key = value1 OR key = value2. Behavior for match is key = * if this field is empty. Field introduced in 20.1.3.
cookie_name (optional)
String HTTP cookie name for authenticated session. Field introduced in 18.2.3.
cookie_timeout (optional)
Integer Cookie timeout in minutes. Allowed values are 1-1440. Field introduced in 18.2.3. Unit is MIN. format: int32
entity_id
String Globally unique SAML entityID for this node. The SAML application entity ID on the IDP should match this. Field introduced in 18.2.3.
key (optional)
signing_ssl_key_and_certificate_ref (optional)
String SP will use this SSL certificate to sign requests going to the IdP and decrypt the assertions coming from IdP. It is a reference to an object of type SSLKeyAndCertificate. Field introduced in 18.2.3.
single_signon_url
String SAML Single Signon URL to be programmed on the IDP. Field introduced in 18.2.3.
sp_metadata (optional)
String SAML SP metadata for this application. Field introduced in 18.2.3.
use_idp_session_timeout (optional)
Boolean By enabling this field IdP can control how long the SP session can exist through the SessionNotOnOrAfter field in the AuthNStatement of SAML Response. Field introduced in 20.1.1.
ssl_session_id (optional)
String Hexadecimal representation of the SSL session ID. Field introduced in 20.1.1.
client_ip_list
IpAddrMatch Configure client IP address groups. Field introduced in 18.2.3.
ssl_profile_ref
String SSL profile for the client IP addresses listed. It is a reference to an object of type SSLProfile. Field introduced in 18.2.3.
_last_modified (optional)
String UNIX time since epoch in microseconds. Units(MICROSECONDS).
authentication_policy
authorization_policy (optional)
labels (optional)
array[KeyValue] Key value pairs for granular object access control. Also allows for classification and tagging of similar objects. Field deprecated in 20.1.5. Field introduced in 20.1.2. Maximum of 4 items allowed.
markers (optional)
array[RoleFilterMatchLabel] List of labels to be used for granular RBAC. Field introduced in 20.1.5. Allowed in Basic edition, Essentials edition, Enterprise edition.
name
String Name of the SSO Policy. Field introduced in 18.2.3.
tenant_ref (optional)
String UUID of the Tenant. It is a reference to an object of type Tenant. Field introduced in 18.2.3.
type
String SSO Policy Type. Enum options - SSO_TYPE_SAML, SSO_TYPE_PINGACCESS, SSO_TYPE_JWT. Field introduced in 18.2.5.
url (optional)
uuid (optional)
String UUID of the SSO Policy. Field introduced in 18.2.3.
count
results
next (optional)
enable_http2 (optional)
Boolean Enable HTTP2 on this port. Field introduced in 20.1.1. Allowed in Basic(Allowed values- false) edition, Essentials(Allowed values- false) edition, Enterprise edition.
enable_ssl (optional)
Boolean Enable SSL termination and offload for traffic from clients.
override_application_profile_ref (optional)
String Enable application layer specific features for the this specific service. It is a reference to an object of type ApplicationProfile. Field introduced in 17.2.4. Allowed in Basic edition, Essentials edition, Enterprise edition.
override_network_profile_ref (optional)
String Override the network profile for this specific service port. It is a reference to an object of type NetworkProfile.
port
Integer The Virtual Service's port number. Allowed values are 0-65535. format: int32
port_range_end (optional)
Integer The end of the Virtual Service's port number range. Allowed values are 1-65535. Special values are 0- 'single port'. format: int32
service_pool_group_ref (optional)
String It is a reference to an object of type PoolGroup.
service_pool_ref (optional)
String It is a reference to an object of type Pool.
service_port
Integer Pool based destination port. Allowed values are 1-65535. format: int32
service_port_range_end (optional)
Integer The end of the Service port number range. Allowed values are 1-65535. Special values are 0- 'single port'. Field introduced in 17.2.4. format: int32
service_protocol (optional)
String Destination protocol to match for the pool selection. If not specified, it will match any protocol. Enum options - PROTOCOL_TYPE_TCP_PROXY, PROTOCOL_TYPE_TCP_FAST_PATH, PROTOCOL_TYPE_UDP_FAST_PATH, PROTOCOL_TYPE_UDP_PROXY.
ip (optional)
sideband_max_request_body_size (optional)
Integer Maximum size of the request body that will be sent on the sideband. Allowed values are 0-16384. Unit is BYTES. format: int32
match_criteria
String Criterion to use for string matching the HTTP request. Enum options - BEGINS_WITH, DOES_NOT_BEGIN_WITH, CONTAINS, DOES_NOT_CONTAIN, ENDS_WITH, DOES_NOT_END_WITH, EQUALS, DOES_NOT_EQUAL, REGEX_MATCH, REGEX_DOES_NOT_MATCH. Allowed in Basic(Allowed values- BEGINS_WITH,DOES_NOT_BEGIN_WITH,CONTAINS,DOES_NOT_CONTAIN,ENDS_WITH,DOES_NOT_END_WITH,EQUALS,DOES_NOT_EQUAL) edition, Essentials(Allowed values- BEGINS_WITH,DOES_NOT_BEGIN_WITH,CONTAINS,DOES_NOT_CONTAIN,ENDS_WITH,DOES_NOT_END_WITH,EQUALS,DOES_NOT_EQUAL) edition, Enterprise edition.
match_str (optional)
string_group_refs (optional)
array[String] UUID of the string group(s). It is a reference to an object of type StringGroup.
tokens (optional)
array[URIParamToken] Token config either for the URI components or a constant string. Minimum of 1 items required.
type
String URI param type. Enum options - URI_PARAM_TYPE_TOKENIZED.
end_index (optional)
Integer Index of the ending token in the incoming URI. Allowed values are 0-65534. Special values are 65535 - 'end of string'. format: int32
start_index (optional)
Integer Index of the starting token in the incoming URI. format: int32
str_value (optional)
String Constant string to use as a token.
type
String Token type for constructing the URI. Enum options - URI_TOKEN_TYPE_HOST, URI_TOKEN_TYPE_PATH, URI_TOKEN_TYPE_STRING, URI_TOKEN_TYPE_STRING_GROUP, URI_TOKEN_TYPE_REGEX.
host
String Host/domain name match configuration. Must be configured along with at least one path match criteria. Field introduced in 20.1.3.
path (optional)
array[PathMatch] Resource/uri path match configuration. Must be configured along with Host match criteria. Field introduced in 20.1.3. Minimum of 1 items required.
index
Integer Index of the virtual service datascript collection. format: int32
vs_datascript_set_ref
String UUID of the virtual service datascript collection. It is a reference to an object of type VSDataScriptSet.
auto_allocate_floating_ip (optional)
Boolean Auto-allocate floating/elastic IP from the Cloud infrastructure. Field introduced in 17.1.1. Allowed in Basic(Allowed values- false) edition, Essentials(Allowed values- false) edition, Enterprise edition.
auto_allocate_ip (optional)
Boolean Auto-allocate VIP from the provided subnet. Field introduced in 17.1.1.
auto_allocate_ip_type (optional)
String 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 Basic(Allowed values- V4_ONLY) edition, Essentials(Allowed values- V4_ONLY) edition, Enterprise edition.
availability_zone (optional)
String Availability-zone to place the Virtual Service. Field introduced in 17.1.1. Allowed in Basic edition, Essentials edition, Enterprise edition.
avi_allocated_fip (optional)
Boolean (internal-use) FIP allocated by Avi in the Cloud infrastructure. Field introduced in 17.1.1. Allowed in Basic(Allowed values- false) edition, Essentials(Allowed values- false) edition, Enterprise edition.
avi_allocated_vip (optional)
Boolean (internal-use) VIP allocated by Avi in the Cloud infrastructure. Field introduced in 17.1.1. Allowed in Basic(Allowed values- false) edition, Essentials(Allowed values- false) edition, Enterprise edition.
discovered_networks (optional)
array[DiscoveredNetwork] Discovered networks providing reachability for client facing Vip IP. Field introduced in 17.1.1.
enabled (optional)
Boolean Enable or disable the Vip. Field introduced in 17.1.1.
floating_ip (optional)
IpAddr Floating IPv4 to associate with this Vip. Field introduced in 17.1.1. Allowed in Basic edition, Essentials edition, Enterprise edition.
floating_ip6 (optional)
IpAddr Floating IPv6 address to associate with this Vip. Field introduced in 18.1.1. Allowed in Basic edition, Essentials edition, Enterprise edition.
floating_subnet6_uuid (optional)
String 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 Basic edition, Essentials edition, Enterprise edition.
floating_subnet_uuid (optional)
String 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 Basic edition, Essentials edition, Enterprise edition.
ip6_address (optional)
IpAddr IPv6 Address of the Vip. Field introduced in 18.1.1.
ip_address (optional)
IpAddr IPv4 Address of the VIP. Field introduced in 17.1.1.
ipam_network_subnet (optional)
IPNetworkSubnet Subnet and/or Network for allocating VirtualService IP by IPAM Provider module. Field introduced in 17.1.1.
network_ref (optional)
String 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.
placement_networks (optional)
array[VipPlacementNetwork] Placement networks/subnets to use for vip placement. Field introduced in 18.2.5. Maximum of 10 items allowed.
port_uuid (optional)
String (internal-use) Network port assigned to the Vip IP address. Field introduced in 17.1.1.
prefix_length (optional)
Integer 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 Basic(Allowed values- 32) edition, Essentials(Allowed values- 32) edition, Enterprise edition. format: int32
subnet (optional)
IpAddrPrefix Subnet providing reachability for client facing Vip IP. Field introduced in 17.1.1.
subnet6 (optional)
IpAddrPrefix Subnet providing reachability for client facing Vip IPv6. Field introduced in 18.1.1. Allowed in Essentials edition, Enterprise edition.
subnet6_uuid (optional)
String 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 Essentials edition, Enterprise edition.
subnet_uuid (optional)
String 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.
vip_id
String Unique ID associated with the vip. Field introduced in 17.1.1.
network_ref (optional)
String Network to use for vip placement. It is a reference to an object of type Network. Field introduced in 18.2.5.
subnet (optional)
IpAddrPrefix IPv4 Subnet to use for vip placement. Field introduced in 18.2.5.
subnet6 (optional)
IpAddrPrefix IPv6 subnet to use for vip placement. Field introduced in 18.2.5.
_last_modified (optional)
String UNIX time since epoch in microseconds. Units(MICROSECONDS).
active_standby_se_tag (optional)
String 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.
advertise_down_vs (optional)
Boolean 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 Basic(Allowed values- false) edition, Essentials(Allowed values- false) edition, Enterprise edition.
allow_invalid_client_cert (optional)
Boolean 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 Basic(Allowed values- false) edition, Essentials(Allowed values- false) edition, Enterprise edition.
analytics_policy (optional)
analytics_profile_ref (optional)
String Specifies settings related to analytics. It is a reference to an object of type AnalyticsProfile.
apic_contract_graph (optional)
String The name of the Contract/Graph associated with the Virtual Service. Should be in the <Contract name> <Graph name> format. This is applicable only for Service Integration mode with Cisco APIC Controller . Field introduced in 17.2.12,18.1.2. Allowed in Basic edition, Essentials edition, Enterprise edition.
application_profile_ref (optional)
String Enable application layer specific features for the Virtual Service. It is a reference to an object of type ApplicationProfile. Special default for Essentials edition is System-L4-Application.
auto_allocate_floating_ip (optional)
Boolean Auto-allocate floating/elastic IP from the Cloud infrastructure. Field deprecated in 17.1.1.
auto_allocate_ip (optional)
Boolean Auto-allocate VIP from the provided subnet. Field deprecated in 17.1.1.
availability_zone (optional)
String Availability-zone to place the Virtual Service. Field deprecated in 17.1.1.
avi_allocated_fip (optional)
Boolean (internal-use) FIP allocated by Avi in the Cloud infrastructure. Field deprecated in 17.1.1.
avi_allocated_vip (optional)
Boolean (internal-use) VIP allocated by Avi in the Cloud infrastructure. Field deprecated in 17.1.1.
azure_availability_set (optional)
String (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.
bgp_peer_labels (optional)
array[String] Select BGP peers, using peer label, for VsVip advertisement. Field introduced in 20.1.5. Maximum of 128 items allowed.
bulk_sync_kvcache (optional)
Boolean (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 Basic(Allowed values- false) edition, Essentials(Allowed values- false) edition, Enterprise edition.
client_auth (optional)
close_client_conn_on_config_update (optional)
Boolean close client connection on vs config update. Field introduced in 17.2.4. Allowed in Basic(Allowed values- false) edition, Essentials(Allowed values- false) edition, Enterprise edition.
cloud_config_cksum (optional)
String Checksum of cloud configuration for VS. Internally set by cloud connector.
cloud_ref (optional)
String It is a reference to an object of type Cloud.
cloud_type (optional)
String 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 Basic(Allowed values- CLOUD_NONE,CLOUD_NSXT) edition, Essentials(Allowed values- CLOUD_NONE,CLOUD_VCENTER) edition, Enterprise edition.
connections_rate_limit (optional)
RateProfile Rate limit the incoming connections to this virtual service.
content_rewrite (optional)
created_by (optional)
delay_fairness (optional)
Boolean 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 Basic(Allowed values- false) edition, Essentials(Allowed values- false) edition, Enterprise edition.
description (optional)
String User defined description for the object.
discovered_network_ref (optional)
array[String] (internal-use) Discovered networks providing reachability for client facing Virtual Service IP. This field is deprecated. It is a reference to an object of type Network. Field deprecated in 17.1.1.
discovered_networks (optional)
array[DiscoveredNetwork] (internal-use) Discovered networks providing reachability for client facing Virtual Service IP. This field is used internally by Avi, not editable by the user. Field deprecated in 17.1.1.
discovered_subnet (optional)
array[IpAddrPrefix] (internal-use) Discovered subnets providing reachability for client facing Virtual Service IP. This field is deprecated. Field deprecated in 17.1.1.
dns_info (optional)
array[DnsInfo] 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.
dns_policies (optional)
array[DnsPolicies] DNS Policies applied on the dns traffic of the Virtual Service. Field introduced in 17.1.1. Allowed in Basic edition, Essentials edition, Enterprise edition.
east_west_placement (optional)
Boolean Force placement on all SE's in service group (Mesos mode only). Allowed in Basic(Allowed values- false) edition, Essentials(Allowed values- false) edition, Enterprise edition.
enable_autogw (optional)
Boolean 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 Basic(Allowed values- false) edition, Essentials(Allowed values- false) edition, Enterprise edition. Special default for Basic edition is false, Essentials edition is false, Enterprise is True.
enable_rhi (optional)
Boolean Enable Route Health Injection using the BGP Config in the vrf context.
enable_rhi_snat (optional)
Boolean Enable Route Health Injection for Source NAT'ted floating IP Address using the BGP Config in the vrf context.
enabled (optional)
Boolean Enable or disable the Virtual Service.
error_page_profile_ref (optional)
String 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 Basic edition, Essentials edition, Enterprise edition.
floating_ip (optional)
IpAddr Floating IP to associate with this Virtual Service. Field deprecated in 17.1.1.
floating_subnet_uuid (optional)
String If auto_allocate_floating_ip is True and more than one floating-ip subnets exist, then the subnet for the floating IP address allocation. This field is applicable only if the VirtualService belongs to an OpenStack or AWS cloud. In OpenStack or AWS cloud it is required when auto_allocate_floating_ip is selected. Field deprecated in 17.1.1.
flow_dist (optional)
String Criteria for flow distribution among SEs. Enum options - LOAD_AWARE, CONSISTENT_HASH_SOURCE_IP_ADDRESS, CONSISTENT_HASH_SOURCE_IP_ADDRESS_AND_PORT. Allowed in Basic(Allowed values- LOAD_AWARE) edition, Essentials(Allowed values- LOAD_AWARE) edition, Enterprise edition.
flow_label_type (optional)
String Criteria for flow labelling. Enum options - NO_LABEL, APPLICATION_LABEL, SERVICE_LABEL.
fqdn (optional)
String DNS resolvable, fully qualified domain name of the virtualservice. Only one of 'fqdn' and 'dns_info' configuration is allowed.
host_name_xlate (optional)
String 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.
http_policies (optional)
icap_request_profile_refs (optional)
array[String] 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 Basic edition, Essentials edition, Enterprise edition.
ign_pool_net_reach (optional)
Boolean Ignore Pool servers network reachability constraints for Virtual Service placement.
ip_address (optional)
IpAddr IP Address of the Virtual Service. Field deprecated in 17.1.1.
ipam_network_subnet (optional)
IPNetworkSubnet Subnet and/or Network for allocating VirtualService IP by IPAM Provider module. Field deprecated in 17.1.1.
jwt_config (optional)
l4_policies (optional)
array[L4Policies] L4 Policies applied to the data traffic of the Virtual Service. Field introduced in 17.2.7.
labels (optional)
array[KeyValue] Key value pairs for granular object access control. Also allows for classification and tagging of similar objects. Field deprecated in 20.1.5. Field introduced in 20.1.2. Maximum of 4 items allowed.
limit_doser (optional)
Boolean Limit potential DoS attackers who exceed max_cps_per_client significantly to a fraction of max_cps_per_client for a while.
markers (optional)
array[RoleFilterMatchLabel] List of labels to be used for granular RBAC. Field introduced in 20.1.5. Allowed in Basic edition, Essentials edition, Enterprise edition.
max_cps_per_client (optional)
Integer Maximum connections per second per client IP. Allowed values are 10-1000. Special values are 0- 'unlimited'. format: int32
microservice_ref (optional)
String Microservice representing the virtual service. It is a reference to an object of type MicroService.
min_pools_up (optional)
Integer Minimum number of UP pools to mark VS up. Field introduced in 18.2.1, 17.2.12. format: int32
name
String Name for the Virtual Service.
network_profile_ref (optional)
String 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. Special default for Essentials edition is System-TCP-Fast-Path.
network_ref (optional)
String Manually override the network on which the Virtual Service is placed. It is a reference to an object of type Network. Field deprecated in 17.1.1.
network_security_policy_ref (optional)
String Network security policies for the Virtual Service. It is a reference to an object of type NetworkSecurityPolicy.
nsx_securitygroup (optional)
array[String] A list of NSX Groups representing the Clients which can access the Virtual IP of the Virtual Service. Field introduced in 17.1.1.
performance_limits (optional)
PerformanceLimits Optional settings that determine performance limits like max connections or bandwdith etc.
pool_group_ref (optional)
String The pool group is an object that contains pools. It is a reference to an object of type PoolGroup.
pool_ref (optional)
String 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.
port_uuid (optional)
String (internal-use) Network port assigned to the Virtual Service IP address. Field deprecated in 17.1.1.
remove_listening_port_on_vs_down (optional)
Boolean Remove listening port if VirtualService is down.
requests_rate_limit (optional)
RateProfile Rate limit the incoming requests to this virtual service.
saml_sp_config (optional)
SAMLSPConfig Application-specific SAML config. Field introduced in 18.2.3. Allowed in Basic edition, Essentials edition, Enterprise edition.
scaleout_ecmp (optional)
Boolean 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.
se_group_ref (optional)
String 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.
security_policy_ref (optional)
String 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 Basic edition, Essentials edition, Enterprise edition.
server_network_profile_ref (optional)
String 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.
service_metadata (optional)
String 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.
service_pool_select (optional)
services (optional)
array[Service] List of Services defined for this Virtual Service. Maximum of 2048 items allowed.
sideband_profile (optional)
SidebandProfile Sideband configuration to be used for this virtualservice.It can be used for sending traffic to sideband VIPs for external inspection etc.
snat_ip (optional)
array[IpAddr] NAT'ted floating source IP Address(es) for upstream connection to servers. Maximum of 32 items allowed.
sp_pool_refs (optional)
array[String] 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.
ssl_key_and_certificate_refs (optional)
array[String] 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.
ssl_profile_ref (optional)
String 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.
ssl_profile_selectors (optional)
array[SSLProfileSelector] Select SSL Profile based on client IP address match. Field introduced in 18.2.3. Allowed in Basic edition, Essentials edition, Enterprise edition.
ssl_sess_cache_avg_size (optional)
Integer Expected number of SSL session cache entries (may be exceeded). Allowed values are 1024-16383. format: int32
sso_policy (optional)
SSOPolicy Client Authentication and Authorization Policy for the virtualservice. Field deprecated in 18.2.3. Field introduced in 18.2.1. Allowed in Basic edition, Essentials edition, Enterprise edition.
sso_policy_ref (optional)
String 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 Basic edition, Essentials edition, Enterprise edition.
static_dns_records (optional)
array[DnsRecord] 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.
subnet (optional)
IpAddrPrefix Subnet providing reachability for client facing Virtual Service IP. Field deprecated in 17.1.1.
subnet_uuid (optional)
String It represents subnet for the Virtual Service IP address allocation when auto_allocate_ip is True.It is only applicable in OpenStack or AWS cloud. This field is required if auto_allocate_ip is True. Field deprecated in 17.1.1.
tenant_ref (optional)
String It is a reference to an object of type Tenant.
test_se_datastore_level_1_ref (optional)
String 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.
topology_policies (optional)
array[DnsPolicies] Topology Policies applied on the dns traffic of the Virtual Service based onGSLB Topology algorithm. Field introduced in 18.2.3. Allowed in Basic edition, Essentials edition, Enterprise edition.
traffic_clone_profile_ref (optional)
String 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 Basic edition, Essentials edition, Enterprise edition.
traffic_enabled (optional)
Boolean 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.
type (optional)
String 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 Basic(Allowed values- VS_TYPE_NORMAL,VS_TYPE_VH_PARENT) edition, Essentials(Allowed values- VS_TYPE_NORMAL) edition, Enterprise edition.
url (optional)
use_bridge_ip_as_vip (optional)
Boolean Use Bridge IP as VIP on each Host in Mesos deployments. Allowed in Basic(Allowed values- false) edition, Essentials(Allowed values- false) edition, Enterprise edition.
use_vip_as_snat (optional)
Boolean 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 Essentials(Allowed values- false) edition, Enterprise edition.
uuid (optional)
String UUID of the VirtualService.
vh_domain_name (optional)
array[String] 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.
vh_matches (optional)
array[VHMatch] Host and path match criteria to select this child VS. Field introduced in 20.1.3.
vh_parent_vs_uuid (optional)
String Specifies the Virtual Service acting as Virtual Hosting (SNI) parent.
vh_type (optional)
String 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 Basic(Allowed values- VS_TYPE_VH_ENHANCED) edition, Enterprise edition. Special default for Basic edition is VS_TYPE_VH_ENHANCED, Enterprise is VS_TYPE_VH_SNI.
vip (optional)
array[Vip] 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.
vrf_context_ref (optional)
String 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.
vs_datascripts (optional)
vsvip_cloud_config_cksum (optional)
String Checksum of cloud configuration for VsVip. Internally set by cloud connector. Field introduced in 17.2.9, 18.1.2.
vsvip_ref (optional)
String 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.
waf_policy_ref (optional)
String WAF policy for the Virtual Service. It is a reference to an object of type WafPolicy. Field introduced in 17.2.1. Allowed in Basic edition, Essentials edition, Enterprise edition.
weight (optional)
Integer 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 Basic(Allowed values- 1) edition, Essentials(Allowed values- 1) edition, Enterprise edition. format: int32
count
results
next (optional)
from_se_ref (optional)
String It is a reference to an object of type ServiceEngine.
new_vcpus (optional)
Integer Number of new_vcpus. format: int32
to_host_ref (optional)
String It is a reference to an object of type VIMgrHostRuntime.
to_new_se (optional)
Boolean Placeholder for description of property to_new_se of obj type VsMigrateParams field type str type boolean
to_se_ref (optional)
String It is a reference to an object of type ServiceEngine.
uuid (optional)
String Unique object identifier of the object.
vip_id
String Field introduced in 17.1.1.
se_ref (optional)
array[String] It is a reference to an object of type ServiceEngine.
uuid (optional)
String Unique object identifier of the object.
admin_down (optional)
Boolean Placeholder for description of property admin_down of obj type VsScaleinParams field type str type boolean
from_se_ref (optional)
String It is a reference to an object of type ServiceEngine.
scalein_primary (optional)
Boolean Placeholder for description of property scalein_primary of obj type VsScaleinParams field type str type boolean
uuid (optional)
String Unique object identifier of the object.
vip_id
String Field introduced in 17.1.1.
admin_up (optional)
Boolean Placeholder for description of property admin_up of obj type VsScaleoutParams field type str type boolean
new_vcpus (optional)
Integer Number of new_vcpus. format: int32
to_host_ref (optional)
String It is a reference to an object of type VIMgrHostRuntime.
to_new_se (optional)
Boolean Placeholder for description of property to_new_se of obj type VsScaleoutParams field type str type boolean
to_se_ref (optional)
String It is a reference to an object of type ServiceEngine.
uuid (optional)
String Unique object identifier of the object.
vip_id
String Field introduced in 17.1.1.
se_uuid (optional)
String Unique object identifier of se.
uuid (optional)
String Unique object identifier of the object.
vip_id
String Field introduced in 17.1.1.