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 {u'services': [{u'port': 80}, {u'enable_ssl': True, u'port': 443}], u'vip': [{u'ip_address': {u'type': u'V4', u'addr': u'10.10.2.28'}}], u'name': u'production_vs'} ``` - **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 {u'vip': [{u'subnet': {u'ip_addr': {u'type': u'V4', u'addr': u'10.10.10.0'}, u'mask': 24}, u'auto_allocate_ip': True}], u'name': u'production_vs', u'fqdn': u'production_vs.prod.corp'} ``` - **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 {u'vip': [{u'subnet': {u'ip_addr': {u'type': u'V4', u'addr': u'10.10.10.0'}, u'mask': 24}, u'auto_allocate_ip': True, u'network_ref': u'/api/network/network-042975ea-376d-4e59-b8da-1b299be51eb1'}], u'name': u'production_vs', u'fqdn': u'production_vs.prod.corp'} ```
More information: https://avinetworks.com/contact-us
Contact Info: support@avinetworks.com
Version: 17.2.4
BasePath:/api
All rights reserved
http://apache.org/licenses/LICENSE-2.0.html

Access

  1. HTTP Basic Authentication

Methods

[ Jump to Models ]

Table of Contents

  1. get /virtualservice
  2. post /virtualservice
  3. post /virtualservice/{uuid}/apicplacement
  4. get /virtualservice/{uuid}/authstats/
  5. get /virtualservice/{uuid}/candidatesehostlist/
  6. post /virtualservice/{uuid}/clear
  7. get /virtualservice/{uuid}/client/
  8. get /virtualservice/{uuid}/clientsummary/
  9. get /virtualservice/{uuid}/cltrack/
  10. get /virtualservice/{uuid}/cltracksummary/
  11. get /virtualservice/{uuid}/connections/
  12. delete /virtualservice/{uuid}
  13. get /virtualservice/{uuid}/dnspolicystats/
  14. get /virtualservice/{uuid}/dnstable/
  15. get /virtualservice/{uuid}/dosstat/
  16. get /virtualservice/{uuid}/geodbinternal/
  17. get /virtualservice/{uuid}/geolocationinfo/
  18. get /virtualservice/{uuid}
  19. get /virtualservice/{uuid}/gslbservicedetail/
  20. get /virtualservice/{uuid}/gslbservicehmonstat/
  21. get /virtualservice/{uuid}/gslbserviceinternal/
  22. get /virtualservice/{uuid}/gslbsiteinternal/
  23. get /virtualservice/{uuid}/httppolicyset/
  24. get /virtualservice/{uuid}/httppolicysetstats/
  25. get /virtualservice/{uuid}/httpstats/
  26. get /virtualservice/{uuid}/keyval/
  27. get /virtualservice/{uuid}/keyvalsummary/
  28. post /virtualservice/{uuid}/migrate
  29. get /virtualservice/{uuid}/networksecuritypolicy/detail/
  30. get /virtualservice/{uuid}/networksecuritypolicystats/
  31. patch /virtualservice/{uuid}
  32. get /virtualservice/{uuid}/placement/
  33. put /virtualservice/{uuid}
  34. post /virtualservice/{uuid}/resync
  35. post /virtualservice/{uuid}/retryplacement
  36. post /virtualservice/{uuid}/rotatekeys
  37. get /virtualservice/{uuid}/runtime/detail/
  38. get /virtualservice/{uuid}/runtime/
  39. get /virtualservice/{uuid}/runtime/internal/
  40. post /virtualservice/{uuid}/scalein
  41. post /virtualservice/{uuid}/scaleout
  42. post /virtualservice/{uuid}/switchover
  43. get /virtualservice/{uuid}/tcpstat/
  44. get /virtualservice/{uuid}/traffic_clone_stats/
  45. get /virtualservice/{uuid}/udpstat/
  46. get /virtualservice/{uuid}/userdefineddatascriptcounters/
Up
get /virtualservice
(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.
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

VirtualServiceApiResponse

Example data

Content-Type: application/json
{
  "count" : 123,
  "results" : [ {
    "client_auth" : {
      "request_uri_path" : "",
      "auth_profile_ref" : "aeiou",
      "realm" : "aeiou",
      "type" : "aeiou"
    },
    "subnet" : "",
    "dns_policies" : [ {
      "dns_policy_ref" : "aeiou",
      "index" : 123
    } ],
    "enable_autogw" : true,
    "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,
    "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",
    "uuid" : "aeiou",
    "vh_domain_name" : [ "aeiou" ],
    "pool_ref" : "aeiou",
    "delay_fairness" : true,
    "snat_ip" : [ "" ],
    "cloud_ref" : "aeiou",
    "microservice_ref" : "aeiou",
    "error_page_profile_ref" : "aeiou",
    "avi_allocated_fip" : true,
    "server_network_profile_ref" : "aeiou",
    "use_vip_as_snat" : true,
    "analytics_policy" : {
      "significant_log_throttle" : 123,
      "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,
      "enabled" : true,
      "full_client_logs" : {
        "duration" : 123,
        "all_headers" : true,
        "throttle" : 123,
        "enabled" : true
      }
    },
    "ipam_network_subnet" : {
      "subnet" : "",
      "subnet_uuid" : "aeiou",
      "subnet6" : "",
      "subnet6_uuid" : "aeiou",
      "network_ref" : "aeiou"
    },
    "enable_rhi_snat" : true,
    "sideband_profile" : {
      "ip" : [ "" ],
      "sideband_max_request_body_size" : 123
    },
    "vip" : [ {
      "availability_zone" : "aeiou",
      "ip6_address" : "",
      "subnet" : "",
      "port_uuid" : "aeiou",
      "subnet_uuid" : "aeiou",
      "avi_allocated_vip" : true,
      "vip_id" : "aeiou",
      "ip_address" : "",
      "auto_allocate_floating_ip" : true,
      "enabled" : true,
      "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",
      "discovered_networks" : [ "" ]
    } ],
    "performance_limits" : {
      "max_concurrent_connections" : 123,
      "max_throughput" : 123
    },
    "sp_pool_refs" : [ "aeiou" ],
    "static_dns_records" : [ {
      "wildcard_match" : true,
      "fqdn" : [ "aeiou" ],
      "ns" : [ {
        "ip_address" : "",
        "nsname" : "aeiou"
      } ],
      "num_records_in_response" : 123,
      "service_locator" : [ {
        "port" : 123,
        "weight" : 123,
        "priority" : 123,
        "target" : "aeiou"
      } ],
      "cname" : "",
      "description" : "aeiou",
      "delegated" : true,
      "ip_address" : [ {
        "ip_address" : ""
      } ],
      "type" : "aeiou",
      "ttl" : 123,
      "algorithm" : "aeiou"
    } ],
    "subnet_uuid" : "aeiou",
    "fqdn" : "aeiou",
    "weight" : 123,
    "auto_allocate_floating_ip" : true,
    "waf_policy_ref" : "aeiou",
    "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
    } ],
    "application_profile_ref" : "aeiou",
    "ssl_sess_cache_avg_size" : 123,
    "cloud_type" : "aeiou",
    "scaleout_ecmp" : true,
    "flow_label_type" : "aeiou",
    "name" : "aeiou",
    "cloud_config_cksum" : "aeiou",
    "traffic_clone_profile_ref" : "aeiou",
    "remove_listening_port_on_vs_down" : true,
    "vsvip_ref" : "aeiou",
    "host_name_xlate" : "aeiou",
    "connections_rate_limit" : {
      "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"
    },
    "network_security_policy_ref" : "aeiou",
    "port_uuid" : "aeiou",
    "description" : "aeiou",
    "vs_datascripts" : [ {
      "index" : 123,
      "vs_datascript_set_ref" : "aeiou"
    } ],
    "pool_group_ref" : "aeiou",
    "ssl_key_and_certificate_refs" : [ "aeiou" ],
    "ssl_profile_ref" : "aeiou",
    "enabled" : true,
    "limit_doser" : true,
    "se_group_ref" : "aeiou",
    "discovered_subnet" : [ "" ],
    "network_profile_ref" : "aeiou",
    "auto_allocate_ip" : true,
    "close_client_conn_on_config_update" : true,
    "max_cps_per_client" : 123,
    "floating_ip" : "",
    "floating_subnet_uuid" : "aeiou",
    "network_ref" : "aeiou",
    "http_policies" : [ {
      "http_policy_set_ref" : "aeiou",
      "index" : 123
    } ],
    "discovered_network_ref" : [ "aeiou" ],
    "analytics_profile_ref" : "aeiou",
    "availability_zone" : "aeiou",
    "service_metadata" : "aeiou",
    "use_bridge_ip_as_vip" : true,
    "requests_rate_limit" : "",
    "enable_rhi" : true,
    "ip_address" : "",
    "services" : [ {
      "override_network_profile_ref" : "aeiou",
      "port" : 123,
      "port_range_end" : 123,
      "enable_ssl" : true,
      "override_application_profile_ref" : "aeiou"
    } ],
    "url" : "aeiou",
    "active_standby_se_tag" : "aeiou",
    "nsx_securitygroup" : [ "aeiou" ],
    "tenant_ref" : "aeiou",
    "vh_parent_vs_uuid" : "aeiou",
    "ign_pool_net_reach" : true,
    "discovered_networks" : [ {
      "subnet" : [ "" ],
      "network_ref" : "aeiou"
    } ],
    "east_west_placement" : true
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK VirtualServiceApiResponse

401

log in failed

Up
post /virtualservice
(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

VirtualService

Example data

Content-Type: application/json
{
  "client_auth" : {
    "request_uri_path" : "",
    "auth_profile_ref" : "aeiou",
    "realm" : "aeiou",
    "type" : "aeiou"
  },
  "subnet" : "",
  "dns_policies" : [ {
    "dns_policy_ref" : "aeiou",
    "index" : 123
  } ],
  "enable_autogw" : true,
  "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,
  "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",
  "uuid" : "aeiou",
  "vh_domain_name" : [ "aeiou" ],
  "pool_ref" : "aeiou",
  "delay_fairness" : true,
  "snat_ip" : [ "" ],
  "cloud_ref" : "aeiou",
  "microservice_ref" : "aeiou",
  "error_page_profile_ref" : "aeiou",
  "avi_allocated_fip" : true,
  "server_network_profile_ref" : "aeiou",
  "use_vip_as_snat" : true,
  "analytics_policy" : {
    "significant_log_throttle" : 123,
    "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,
    "enabled" : true,
    "full_client_logs" : {
      "duration" : 123,
      "all_headers" : true,
      "throttle" : 123,
      "enabled" : true
    }
  },
  "ipam_network_subnet" : {
    "subnet" : "",
    "subnet_uuid" : "aeiou",
    "subnet6" : "",
    "subnet6_uuid" : "aeiou",
    "network_ref" : "aeiou"
  },
  "enable_rhi_snat" : true,
  "sideband_profile" : {
    "ip" : [ "" ],
    "sideband_max_request_body_size" : 123
  },
  "vip" : [ {
    "availability_zone" : "aeiou",
    "ip6_address" : "",
    "subnet" : "",
    "port_uuid" : "aeiou",
    "subnet_uuid" : "aeiou",
    "avi_allocated_vip" : true,
    "vip_id" : "aeiou",
    "ip_address" : "",
    "auto_allocate_floating_ip" : true,
    "enabled" : true,
    "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",
    "discovered_networks" : [ "" ]
  } ],
  "performance_limits" : {
    "max_concurrent_connections" : 123,
    "max_throughput" : 123
  },
  "sp_pool_refs" : [ "aeiou" ],
  "static_dns_records" : [ {
    "wildcard_match" : true,
    "fqdn" : [ "aeiou" ],
    "ns" : [ {
      "ip_address" : "",
      "nsname" : "aeiou"
    } ],
    "num_records_in_response" : 123,
    "service_locator" : [ {
      "port" : 123,
      "weight" : 123,
      "priority" : 123,
      "target" : "aeiou"
    } ],
    "cname" : "",
    "description" : "aeiou",
    "delegated" : true,
    "ip_address" : [ {
      "ip_address" : ""
    } ],
    "type" : "aeiou",
    "ttl" : 123,
    "algorithm" : "aeiou"
  } ],
  "subnet_uuid" : "aeiou",
  "fqdn" : "aeiou",
  "weight" : 123,
  "auto_allocate_floating_ip" : true,
  "waf_policy_ref" : "aeiou",
  "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
  } ],
  "application_profile_ref" : "aeiou",
  "ssl_sess_cache_avg_size" : 123,
  "cloud_type" : "aeiou",
  "scaleout_ecmp" : true,
  "flow_label_type" : "aeiou",
  "name" : "aeiou",
  "cloud_config_cksum" : "aeiou",
  "traffic_clone_profile_ref" : "aeiou",
  "remove_listening_port_on_vs_down" : true,
  "vsvip_ref" : "aeiou",
  "host_name_xlate" : "aeiou",
  "connections_rate_limit" : {
    "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"
  },
  "network_security_policy_ref" : "aeiou",
  "port_uuid" : "aeiou",
  "description" : "aeiou",
  "vs_datascripts" : [ {
    "index" : 123,
    "vs_datascript_set_ref" : "aeiou"
  } ],
  "pool_group_ref" : "aeiou",
  "ssl_key_and_certificate_refs" : [ "aeiou" ],
  "ssl_profile_ref" : "aeiou",
  "enabled" : true,
  "limit_doser" : true,
  "se_group_ref" : "aeiou",
  "discovered_subnet" : [ "" ],
  "network_profile_ref" : "aeiou",
  "auto_allocate_ip" : true,
  "close_client_conn_on_config_update" : true,
  "max_cps_per_client" : 123,
  "floating_ip" : "",
  "floating_subnet_uuid" : "aeiou",
  "network_ref" : "aeiou",
  "http_policies" : [ {
    "http_policy_set_ref" : "aeiou",
    "index" : 123
  } ],
  "discovered_network_ref" : [ "aeiou" ],
  "analytics_profile_ref" : "aeiou",
  "availability_zone" : "aeiou",
  "service_metadata" : "aeiou",
  "use_bridge_ip_as_vip" : true,
  "requests_rate_limit" : "",
  "enable_rhi" : true,
  "ip_address" : "",
  "services" : [ {
    "override_network_profile_ref" : "aeiou",
    "port" : 123,
    "port_range_end" : 123,
    "enable_ssl" : true,
    "override_application_profile_ref" : "aeiou"
  } ],
  "url" : "aeiou",
  "active_standby_se_tag" : "aeiou",
  "nsx_securitygroup" : [ "aeiou" ],
  "tenant_ref" : "aeiou",
  "vh_parent_vs_uuid" : "aeiou",
  "ign_pool_net_reach" : true,
  "discovered_networks" : [ {
    "subnet" : [ "" ],
    "network_ref" : "aeiou"
  } ],
  "east_west_placement" : true
}

Produces

This API call produces the following media types according to the Accept 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 Accept 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 Accept 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 Accept 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}/clear
(virtualserviceUuidClearPost)

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 Accept 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 Accept 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 Accept 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 Accept 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 Accept 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 Accept 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 Accept 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 Accept 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 Accept 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 Accept 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 Accept 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 Accept 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.
join_subresources (optional)
Query Parameter — It automatically returns additional dependent resources like runtime. Eg. join_subresources=runtime.

Return type

VirtualService

Example data

Content-Type: application/json
{
  "client_auth" : {
    "request_uri_path" : "",
    "auth_profile_ref" : "aeiou",
    "realm" : "aeiou",
    "type" : "aeiou"
  },
  "subnet" : "",
  "dns_policies" : [ {
    "dns_policy_ref" : "aeiou",
    "index" : 123
  } ],
  "enable_autogw" : true,
  "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,
  "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",
  "uuid" : "aeiou",
  "vh_domain_name" : [ "aeiou" ],
  "pool_ref" : "aeiou",
  "delay_fairness" : true,
  "snat_ip" : [ "" ],
  "cloud_ref" : "aeiou",
  "microservice_ref" : "aeiou",
  "error_page_profile_ref" : "aeiou",
  "avi_allocated_fip" : true,
  "server_network_profile_ref" : "aeiou",
  "use_vip_as_snat" : true,
  "analytics_policy" : {
    "significant_log_throttle" : 123,
    "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,
    "enabled" : true,
    "full_client_logs" : {
      "duration" : 123,
      "all_headers" : true,
      "throttle" : 123,
      "enabled" : true
    }
  },
  "ipam_network_subnet" : {
    "subnet" : "",
    "subnet_uuid" : "aeiou",
    "subnet6" : "",
    "subnet6_uuid" : "aeiou",
    "network_ref" : "aeiou"
  },
  "enable_rhi_snat" : true,
  "sideband_profile" : {
    "ip" : [ "" ],
    "sideband_max_request_body_size" : 123
  },
  "vip" : [ {
    "availability_zone" : "aeiou",
    "ip6_address" : "",
    "subnet" : "",
    "port_uuid" : "aeiou",
    "subnet_uuid" : "aeiou",
    "avi_allocated_vip" : true,
    "vip_id" : "aeiou",
    "ip_address" : "",
    "auto_allocate_floating_ip" : true,
    "enabled" : true,
    "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",
    "discovered_networks" : [ "" ]
  } ],
  "performance_limits" : {
    "max_concurrent_connections" : 123,
    "max_throughput" : 123
  },
  "sp_pool_refs" : [ "aeiou" ],
  "static_dns_records" : [ {
    "wildcard_match" : true,
    "fqdn" : [ "aeiou" ],
    "ns" : [ {
      "ip_address" : "",
      "nsname" : "aeiou"
    } ],
    "num_records_in_response" : 123,
    "service_locator" : [ {
      "port" : 123,
      "weight" : 123,
      "priority" : 123,
      "target" : "aeiou"
    } ],
    "cname" : "",
    "description" : "aeiou",
    "delegated" : true,
    "ip_address" : [ {
      "ip_address" : ""
    } ],
    "type" : "aeiou",
    "ttl" : 123,
    "algorithm" : "aeiou"
  } ],
  "subnet_uuid" : "aeiou",
  "fqdn" : "aeiou",
  "weight" : 123,
  "auto_allocate_floating_ip" : true,
  "waf_policy_ref" : "aeiou",
  "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
  } ],
  "application_profile_ref" : "aeiou",
  "ssl_sess_cache_avg_size" : 123,
  "cloud_type" : "aeiou",
  "scaleout_ecmp" : true,
  "flow_label_type" : "aeiou",
  "name" : "aeiou",
  "cloud_config_cksum" : "aeiou",
  "traffic_clone_profile_ref" : "aeiou",
  "remove_listening_port_on_vs_down" : true,
  "vsvip_ref" : "aeiou",
  "host_name_xlate" : "aeiou",
  "connections_rate_limit" : {
    "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"
  },
  "network_security_policy_ref" : "aeiou",
  "port_uuid" : "aeiou",
  "description" : "aeiou",
  "vs_datascripts" : [ {
    "index" : 123,
    "vs_datascript_set_ref" : "aeiou"
  } ],
  "pool_group_ref" : "aeiou",
  "ssl_key_and_certificate_refs" : [ "aeiou" ],
  "ssl_profile_ref" : "aeiou",
  "enabled" : true,
  "limit_doser" : true,
  "se_group_ref" : "aeiou",
  "discovered_subnet" : [ "" ],
  "network_profile_ref" : "aeiou",
  "auto_allocate_ip" : true,
  "close_client_conn_on_config_update" : true,
  "max_cps_per_client" : 123,
  "floating_ip" : "",
  "floating_subnet_uuid" : "aeiou",
  "network_ref" : "aeiou",
  "http_policies" : [ {
    "http_policy_set_ref" : "aeiou",
    "index" : 123
  } ],
  "discovered_network_ref" : [ "aeiou" ],
  "analytics_profile_ref" : "aeiou",
  "availability_zone" : "aeiou",
  "service_metadata" : "aeiou",
  "use_bridge_ip_as_vip" : true,
  "requests_rate_limit" : "",
  "enable_rhi" : true,
  "ip_address" : "",
  "services" : [ {
    "override_network_profile_ref" : "aeiou",
    "port" : 123,
    "port_range_end" : 123,
    "enable_ssl" : true,
    "override_application_profile_ref" : "aeiou"
  } ],
  "url" : "aeiou",
  "active_standby_se_tag" : "aeiou",
  "nsx_securitygroup" : [ "aeiou" ],
  "tenant_ref" : "aeiou",
  "vh_parent_vs_uuid" : "aeiou",
  "ign_pool_net_reach" : true,
  "discovered_networks" : [ {
    "subnet" : [ "" ],
    "network_ref" : "aeiou"
  } ],
  "east_west_placement" : true
}

Produces

This API call produces the following media types according to the Accept 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}/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 Accept 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 Accept 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 Accept 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 Accept 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 Accept 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 Accept 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 Accept 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 Accept 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 Accept 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 Accept 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 Accept 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 Accept 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

VirtualService

Example data

Content-Type: application/json
{
  "client_auth" : {
    "request_uri_path" : "",
    "auth_profile_ref" : "aeiou",
    "realm" : "aeiou",
    "type" : "aeiou"
  },
  "subnet" : "",
  "dns_policies" : [ {
    "dns_policy_ref" : "aeiou",
    "index" : 123
  } ],
  "enable_autogw" : true,
  "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,
  "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",
  "uuid" : "aeiou",
  "vh_domain_name" : [ "aeiou" ],
  "pool_ref" : "aeiou",
  "delay_fairness" : true,
  "snat_ip" : [ "" ],
  "cloud_ref" : "aeiou",
  "microservice_ref" : "aeiou",
  "error_page_profile_ref" : "aeiou",
  "avi_allocated_fip" : true,
  "server_network_profile_ref" : "aeiou",
  "use_vip_as_snat" : true,
  "analytics_policy" : {
    "significant_log_throttle" : 123,
    "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,
    "enabled" : true,
    "full_client_logs" : {
      "duration" : 123,
      "all_headers" : true,
      "throttle" : 123,
      "enabled" : true
    }
  },
  "ipam_network_subnet" : {
    "subnet" : "",
    "subnet_uuid" : "aeiou",
    "subnet6" : "",
    "subnet6_uuid" : "aeiou",
    "network_ref" : "aeiou"
  },
  "enable_rhi_snat" : true,
  "sideband_profile" : {
    "ip" : [ "" ],
    "sideband_max_request_body_size" : 123
  },
  "vip" : [ {
    "availability_zone" : "aeiou",
    "ip6_address" : "",
    "subnet" : "",
    "port_uuid" : "aeiou",
    "subnet_uuid" : "aeiou",
    "avi_allocated_vip" : true,
    "vip_id" : "aeiou",
    "ip_address" : "",
    "auto_allocate_floating_ip" : true,
    "enabled" : true,
    "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",
    "discovered_networks" : [ "" ]
  } ],
  "performance_limits" : {
    "max_concurrent_connections" : 123,
    "max_throughput" : 123
  },
  "sp_pool_refs" : [ "aeiou" ],
  "static_dns_records" : [ {
    "wildcard_match" : true,
    "fqdn" : [ "aeiou" ],
    "ns" : [ {
      "ip_address" : "",
      "nsname" : "aeiou"
    } ],
    "num_records_in_response" : 123,
    "service_locator" : [ {
      "port" : 123,
      "weight" : 123,
      "priority" : 123,
      "target" : "aeiou"
    } ],
    "cname" : "",
    "description" : "aeiou",
    "delegated" : true,
    "ip_address" : [ {
      "ip_address" : ""
    } ],
    "type" : "aeiou",
    "ttl" : 123,
    "algorithm" : "aeiou"
  } ],
  "subnet_uuid" : "aeiou",
  "fqdn" : "aeiou",
  "weight" : 123,
  "auto_allocate_floating_ip" : true,
  "waf_policy_ref" : "aeiou",
  "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
  } ],
  "application_profile_ref" : "aeiou",
  "ssl_sess_cache_avg_size" : 123,
  "cloud_type" : "aeiou",
  "scaleout_ecmp" : true,
  "flow_label_type" : "aeiou",
  "name" : "aeiou",
  "cloud_config_cksum" : "aeiou",
  "traffic_clone_profile_ref" : "aeiou",
  "remove_listening_port_on_vs_down" : true,
  "vsvip_ref" : "aeiou",
  "host_name_xlate" : "aeiou",
  "connections_rate_limit" : {
    "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"
  },
  "network_security_policy_ref" : "aeiou",
  "port_uuid" : "aeiou",
  "description" : "aeiou",
  "vs_datascripts" : [ {
    "index" : 123,
    "vs_datascript_set_ref" : "aeiou"
  } ],
  "pool_group_ref" : "aeiou",
  "ssl_key_and_certificate_refs" : [ "aeiou" ],
  "ssl_profile_ref" : "aeiou",
  "enabled" : true,
  "limit_doser" : true,
  "se_group_ref" : "aeiou",
  "discovered_subnet" : [ "" ],
  "network_profile_ref" : "aeiou",
  "auto_allocate_ip" : true,
  "close_client_conn_on_config_update" : true,
  "max_cps_per_client" : 123,
  "floating_ip" : "",
  "floating_subnet_uuid" : "aeiou",
  "network_ref" : "aeiou",
  "http_policies" : [ {
    "http_policy_set_ref" : "aeiou",
    "index" : 123
  } ],
  "discovered_network_ref" : [ "aeiou" ],
  "analytics_profile_ref" : "aeiou",
  "availability_zone" : "aeiou",
  "service_metadata" : "aeiou",
  "use_bridge_ip_as_vip" : true,
  "requests_rate_limit" : "",
  "enable_rhi" : true,
  "ip_address" : "",
  "services" : [ {
    "override_network_profile_ref" : "aeiou",
    "port" : 123,
    "port_range_end" : 123,
    "enable_ssl" : true,
    "override_application_profile_ref" : "aeiou"
  } ],
  "url" : "aeiou",
  "active_standby_se_tag" : "aeiou",
  "nsx_securitygroup" : [ "aeiou" ],
  "tenant_ref" : "aeiou",
  "vh_parent_vs_uuid" : "aeiou",
  "ign_pool_net_reach" : true,
  "discovered_networks" : [ {
    "subnet" : [ "" ],
    "network_ref" : "aeiou"
  } ],
  "east_west_placement" : true
}

Produces

This API call produces the following media types according to the Accept 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 Accept 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

VirtualService

Example data

Content-Type: application/json
{
  "client_auth" : {
    "request_uri_path" : "",
    "auth_profile_ref" : "aeiou",
    "realm" : "aeiou",
    "type" : "aeiou"
  },
  "subnet" : "",
  "dns_policies" : [ {
    "dns_policy_ref" : "aeiou",
    "index" : 123
  } ],
  "enable_autogw" : true,
  "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,
  "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",
  "uuid" : "aeiou",
  "vh_domain_name" : [ "aeiou" ],
  "pool_ref" : "aeiou",
  "delay_fairness" : true,
  "snat_ip" : [ "" ],
  "cloud_ref" : "aeiou",
  "microservice_ref" : "aeiou",
  "error_page_profile_ref" : "aeiou",
  "avi_allocated_fip" : true,
  "server_network_profile_ref" : "aeiou",
  "use_vip_as_snat" : true,
  "analytics_policy" : {
    "significant_log_throttle" : 123,
    "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,
    "enabled" : true,
    "full_client_logs" : {
      "duration" : 123,
      "all_headers" : true,
      "throttle" : 123,
      "enabled" : true
    }
  },
  "ipam_network_subnet" : {
    "subnet" : "",
    "subnet_uuid" : "aeiou",
    "subnet6" : "",
    "subnet6_uuid" : "aeiou",
    "network_ref" : "aeiou"
  },
  "enable_rhi_snat" : true,
  "sideband_profile" : {
    "ip" : [ "" ],
    "sideband_max_request_body_size" : 123
  },
  "vip" : [ {
    "availability_zone" : "aeiou",
    "ip6_address" : "",
    "subnet" : "",
    "port_uuid" : "aeiou",
    "subnet_uuid" : "aeiou",
    "avi_allocated_vip" : true,
    "vip_id" : "aeiou",
    "ip_address" : "",
    "auto_allocate_floating_ip" : true,
    "enabled" : true,
    "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",
    "discovered_networks" : [ "" ]
  } ],
  "performance_limits" : {
    "max_concurrent_connections" : 123,
    "max_throughput" : 123
  },
  "sp_pool_refs" : [ "aeiou" ],
  "static_dns_records" : [ {
    "wildcard_match" : true,
    "fqdn" : [ "aeiou" ],
    "ns" : [ {
      "ip_address" : "",
      "nsname" : "aeiou"
    } ],
    "num_records_in_response" : 123,
    "service_locator" : [ {
      "port" : 123,
      "weight" : 123,
      "priority" : 123,
      "target" : "aeiou"
    } ],
    "cname" : "",
    "description" : "aeiou",
    "delegated" : true,
    "ip_address" : [ {
      "ip_address" : ""
    } ],
    "type" : "aeiou",
    "ttl" : 123,
    "algorithm" : "aeiou"
  } ],
  "subnet_uuid" : "aeiou",
  "fqdn" : "aeiou",
  "weight" : 123,
  "auto_allocate_floating_ip" : true,
  "waf_policy_ref" : "aeiou",
  "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
  } ],
  "application_profile_ref" : "aeiou",
  "ssl_sess_cache_avg_size" : 123,
  "cloud_type" : "aeiou",
  "scaleout_ecmp" : true,
  "flow_label_type" : "aeiou",
  "name" : "aeiou",
  "cloud_config_cksum" : "aeiou",
  "traffic_clone_profile_ref" : "aeiou",
  "remove_listening_port_on_vs_down" : true,
  "vsvip_ref" : "aeiou",
  "host_name_xlate" : "aeiou",
  "connections_rate_limit" : {
    "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"
  },
  "network_security_policy_ref" : "aeiou",
  "port_uuid" : "aeiou",
  "description" : "aeiou",
  "vs_datascripts" : [ {
    "index" : 123,
    "vs_datascript_set_ref" : "aeiou"
  } ],
  "pool_group_ref" : "aeiou",
  "ssl_key_and_certificate_refs" : [ "aeiou" ],
  "ssl_profile_ref" : "aeiou",
  "enabled" : true,
  "limit_doser" : true,
  "se_group_ref" : "aeiou",
  "discovered_subnet" : [ "" ],
  "network_profile_ref" : "aeiou",
  "auto_allocate_ip" : true,
  "close_client_conn_on_config_update" : true,
  "max_cps_per_client" : 123,
  "floating_ip" : "",
  "floating_subnet_uuid" : "aeiou",
  "network_ref" : "aeiou",
  "http_policies" : [ {
    "http_policy_set_ref" : "aeiou",
    "index" : 123
  } ],
  "discovered_network_ref" : [ "aeiou" ],
  "analytics_profile_ref" : "aeiou",
  "availability_zone" : "aeiou",
  "service_metadata" : "aeiou",
  "use_bridge_ip_as_vip" : true,
  "requests_rate_limit" : "",
  "enable_rhi" : true,
  "ip_address" : "",
  "services" : [ {
    "override_network_profile_ref" : "aeiou",
    "port" : 123,
    "port_range_end" : 123,
    "enable_ssl" : true,
    "override_application_profile_ref" : "aeiou"
  } ],
  "url" : "aeiou",
  "active_standby_se_tag" : "aeiou",
  "nsx_securitygroup" : [ "aeiou" ],
  "tenant_ref" : "aeiou",
  "vh_parent_vs_uuid" : "aeiou",
  "ign_pool_net_reach" : true,
  "discovered_networks" : [ {
    "subnet" : [ "" ],
    "network_ref" : "aeiou"
  } ],
  "east_west_placement" : true
}

Produces

This API call produces the following media types according to the Accept 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 Accept 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 Accept 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 Accept 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 Accept 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 Accept 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 Accept 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 Accept 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 Accept 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 Accept 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 Accept 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 Accept 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 Accept 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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK String

401

log in failed

Up

Models

[ Jump to Methods ]

Table of Contents

  1. APICNetworkRel
  2. AnalyticsPolicy
  3. ApicVSPlacementReq
  4. Cif
  5. ClientInsightsSampling
  6. ClientLogFilter
  7. ConnectionClearFilter
  8. ContentRewriteProfile
  9. DiscoveredNetwork
  10. DnsARdata
  11. DnsCnameRdata
  12. DnsInfo
  13. DnsNsRdata
  14. DnsPolicies
  15. DnsRecord
  16. DnsSrvRdata
  17. FullClientLogs
  18. HTTPClientAuthenticationParams
  19. HTTPLocalFile
  20. HTTPPolicies
  21. HTTPRedirectAction
  22. IPNetworkSubnet
  23. IpAddr
  24. IpAddrMatch
  25. IpAddrPrefix
  26. IpAddrRange
  27. Lif
  28. MatchReplacePair
  29. MetricsRealTimeUpdate
  30. PerformanceLimits
  31. RateLimiterAction
  32. RateProfile
  33. ReplaceStringVar
  34. RetryPlacementParams
  35. Service
  36. ServicePoolSelector
  37. SidebandProfile
  38. StringMatch
  39. URIParam
  40. URIParamToken
  41. VSDataScripts
  42. Vip
  43. VirtualService
  44. VirtualServiceApiResponse
  45. VsMigrateParams
  46. VsResyncParams
  47. VsScaleinParams
  48. VsScaleoutParams
  49. VsSwitchoverParams

APICNetworkRel Up

connector (optional)
String connector of APICNetworkRel.
rel_key (optional)
String rel_key of APICNetworkRel.
target_network (optional)
String target_network of APICNetworkRel.

AnalyticsPolicy Up

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 Disable Analytics on this VirtualService. This will disable the collection of both metrics and logs. 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
metrics_realtime_update (optional)
MetricsRealTimeUpdate Settings to turn on realtime metrics and set duration for realtime updates.
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 disable throttling. Field introduced in 17.1.3. 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 disable throttling. Field introduced in 17.1.3. format: int32

ApicVSPlacementReq Up

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.

Cif Up

adapter (optional)
String adapter of Cif.
cif (optional)
String cif of Cif.
mac_address (optional)
String mac_address of Cif.
resources (optional)
array[String] resources of Cif.
se_uuid (optional)
String Unique object identifier of se.

ClientInsightsSampling Up

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.

ClientLogFilter Up

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'. 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
String Name of the object.
uri (optional)
StringMatch Placeholder for description of property uri of obj type ClientLogFilter field type str type object

ConnectionClearFilter Up

ip_addr (optional)
String IP address in dotted decimal notation.
port (optional)
Integer Port number. format: int32

ContentRewriteProfile Up

req_match_replace_pair (optional)
array[MatchReplacePair] Strings to be matched and replaced with on the request body.
request_rewrite_enabled (optional)
Boolean Enable rewrite on request body.
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.

DiscoveredNetwork Up

network_ref
String Discovered network for this IP. It is a reference to an object of type Network.
subnet (optional)
array[IpAddrPrefix] Discovered subnet for this IP.

DnsARdata Up

ip_address
IpAddr IP address for fqdn.

DnsCnameRdata Up

cname
String Canonical name.

DnsInfo Up

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.

DnsNsRdata Up

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.

DnsPolicies Up

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

DnsRecord Up

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)
DnsCnameRdata Canonical name in CNAME record.
delegated (optional)
Boolean Configured FQDNs are delegated domains (i.e. they represent a zone cut). Field introduced in 17.1.2.
description (optional)
String Details of DNS record.
fqdn (optional)
array[String] Fully Qualified Domain Name.
ip_address (optional)
array[DnsARdata] IP address in A record.
ns (optional)
array[DnsNsRdata] Name Server information in NS record. Field introduced in 17.1.1.
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)
array[DnsSrvRdata] Service locator info in SRV record.
ttl (optional)
Integer Time To Live for this DNS record. format: int32
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.

DnsSrvRdata Up

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

FullClientLogs Up

all_headers (optional)
Boolean Log all headers.
duration (optional)
Integer How long should the system capture all logs, measured in minutes. Set to 0 for infinite. Special values are 0 - 'infinite'. format: int32
enabled
Boolean Capture all client logs including connections and requests. When disabled, only errors will be logged.
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 disable throttling. Field introduced in 17.1.3. format: int32

HTTPClientAuthenticationParams Up

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.

HTTPLocalFile Up

content_type
String Mime-type of the content in the file.
file_content
String File content to used in the local HTTP response body.

HTTPPolicies Up

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

HTTPRedirectAction Up

host (optional)
URIParam Host config.
keep_query (optional)
Boolean Keep or drop the query of the incoming request URI in the redirected URI.
path (optional)
URIParam Path config.
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.

IPNetworkSubnet Up

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 17.2.1.
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 17.2.1.
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.

IpAddr Up

addr
String IP address.
type
String Enum options - V4, DNS.

IpAddrMatch Up

addrs (optional)
array[IpAddr] IP address(es).
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)
array[IpAddrPrefix] IP address prefix(es).
ranges (optional)
array[IpAddrRange] IP address range(s).

IpAddrPrefix Up

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

IpAddrRange Up

begin
IpAddr Starting IP address of the range.
end
IpAddr Ending IP address of the range.

Lif Up

cifs (optional)
array[Cif] Placeholder for description of property cifs of obj type Lif field type str type object
lif (optional)
String lif of Lif.
lif_label (optional)
String lif_label of Lif.
subnet (optional)
String subnet of Lif.

MatchReplacePair Up

match_string (optional)
String String to be matched.
replacement_string (optional)
ReplaceStringVar Replacement string.

MetricsRealTimeUpdate Up

duration (optional)
Integer Real time metrics collection duration in minutes. 0 for infinite. Special values are 0 - 'infinite'. format: int32
enabled
Boolean Enables real time metrics collection. When disabled, 6 hour view is the most granular the system will track.

PerformanceLimits Up

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

RateLimiterAction Up

file (optional)
HTTPLocalFile File to be used for HTTP Local response rate limit action.
redirect (optional)
HTTPRedirectAction Parameters for HTTP Redirect rate limit action.
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_403, HTTP_LOCAL_RESPONSE_STATUS_CODE_404, HTTP_LOCAL_RESPONSE_STATUS_CODE_429.
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.

RateProfile Up

action (optional)
RateLimiterAction Action to perform upon rate limiting.
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'. format: int32
count (optional)
Integer Maximum number of connections or requests or packets. Allowed values are 10-2500. Special values are 0- 'unlimited'. format: int32
explicit_tracking (optional)
Boolean Explicitly tracks an attacker across rate periods.
fine_grain (optional)
Boolean Enable fine granularity.
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. format: int32

ReplaceStringVar Up

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.

RetryPlacementParams Up

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.

Service Up

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.
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 1-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

ServicePoolSelector Up

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.

SidebandProfile Up

ip (optional)
array[IpAddr] IP Address of the sideband server.
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. format: int32

StringMatch Up

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.
match_str (optional)
array[String] String value(s).
string_group_refs (optional)
array[String] UUID of the string group(s). It is a reference to an object of type StringGroup.

URIParam Up

tokens (optional)
array[URIParamToken] Token config either for the URI components or a constant string.
type
String URI param type. Enum options - URI_PARAM_TYPE_TOKENIZED.

URIParamToken Up

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.

VSDataScripts Up

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.

Vip Up

auto_allocate_floating_ip (optional)
Boolean Auto-allocate floating/elastic IP from the Cloud infrastructure. Field introduced in 17.1.1.
auto_allocate_ip (optional)
Boolean Auto-allocate VIP from the provided subnet. Field introduced in 17.1.1.
availability_zone (optional)
String Availability-zone to place the Virtual Service. Field introduced in 17.1.1.
avi_allocated_fip (optional)
Boolean (internal-use) FIP allocated by Avi in the Cloud infrastructure. Field introduced in 17.1.1.
avi_allocated_vip (optional)
Boolean (internal-use) VIP allocated by Avi in the Cloud infrastructure. Field introduced in 17.1.1.
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.
floating_ip6 (optional)
IpAddr Floating IPv6 address to associate with this Vip. Field introduced in 17.2.1.
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 17.2.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. Field introduced in 17.1.1.
ip6_address (optional)
IpAddr IPv6 Address of the Vip. Field introduced in 17.2.1.
ip_address (optional)
IpAddr IPv4 Address of the Vip. For IPv6 address support please use ip6_address field. 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.
port_uuid (optional)
String (internal-use) Network port assigned to the Vip IP address. Field introduced in 17.1.1.
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 17.2.1.
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 17.2.1.
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.

VirtualService Up

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.
analytics_policy (optional)
AnalyticsPolicy Determines analytics settings for the application.
analytics_profile_ref (optional)
String Specifies settings related to analytics. It is a reference to an object of type AnalyticsProfile.
application_profile_ref (optional)
String Enable application layer specific features for the Virtual Service. It is a reference to an object of type ApplicationProfile.
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.
client_auth (optional)
HTTPClientAuthenticationParams HTTP authentication configuration for protected resources.
close_client_conn_on_config_update (optional)
Boolean close client connection on vs config update. Field introduced in 17.2.4.
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.
connections_rate_limit (optional)
RateProfile Rate limit the incoming connections to this virtual service.
content_rewrite (optional)
ContentRewriteProfile Profile used to match and rewrite strings in request and/or response body.
created_by (optional)
String Creator name.
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.
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.
dns_policies (optional)
array[DnsPolicies] DNS Policies applied on the dns traffic of the Virtual Service. Field introduced in 17.1.1.
east_west_placement (optional)
Boolean Force placement on all SE's in service group (Mesos mode only).
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.
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.
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.
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)
array[HTTPPolicies] HTTP Policies applied on the data traffic of the Virtual Service.
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.
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.
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.
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.
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 Service 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.
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.
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)
array[ServicePoolSelector] Select pool based on destination port.
services (optional)
array[Service] List of Services defined for this Virtual Service.
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.
sp_pool_refs (optional)
array[String] Site persistence pools used for site persistence functionality. . 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_sess_cache_avg_size (optional)
Integer Expected number of SSL session cache entries (may be exceeded). Allowed values are 1024-16383. format: int32
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.
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.
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.
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.
url (optional)
String url
use_bridge_ip_as_vip (optional)
Boolean Use Bridge IP as VIP on each Host in Mesos deployments.
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.
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_parent_vs_uuid (optional)
String Specifies the Virtual Service acting as Virtual Hosting (SNI) parent.
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)
array[VSDataScripts] Datascripts applied on the data traffic of the Virtual Service.
vsvip_ref (optional)
String Mostly used during the creation of Shared VS, this fieldrefers 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.
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. format: int32

VirtualServiceApiResponse Up

count
Integer format: int32
results

VsMigrateParams Up

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.

VsResyncParams Up

se_ref (optional)
array[String] It is a reference to an object of type ServiceEngine.
uuid (optional)
String Unique object identifier of the object.

VsScaleinParams Up

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.

VsScaleoutParams Up

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.

VsSwitchoverParams Up

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.