openapi: 3.0.0 info: title: Avi VirtualService Object API description: > CLI ``` - configure virtualservice - show virtualservice - scaleout virtualservice - scalein virtualservice - migrate virtualservice - switchover virtualservice - clear virtualservice - resync virtualservice - rotatekeys virtualservice - apicplacement virtualservice - retryplacement virtualservice ``` Examples - **virtualservice_example_1**: To create a basic virtualservice object that has both http and https enabled ```json {'name': 'production_vs', 'services': [{'port': 80}, {'port': 443, 'enable_ssl': True}], 'vip': [{'ip_address': {'addr': '10.10.2.28', 'type': 'V4'}}]} ``` - **virtualservice_example_ipamdns_infoblox**: Create a basic virtualservice object that requires IP to be auto-allocated and DNS record to be registered. @Assumptions: - This example assumes the virtualservice being created is part of a Cloud with Infoblox as IPAM & DNS provider - On Infoblox server - "10.10.10.0/24" is configured for VIPs - "prod.corp" is configured as zone ```json {'name': 'production_vs', 'fqdn': 'production_vs.prod.corp', 'vip': [{'subnet': {'ip_addr': {'addr': '10.10.10.0', 'type': 'V4'}, 'mask': 24}, 'auto_allocate_ip': True}]} ``` - **virtualservice_example_ipamdns_internal**: Create a basic virtualservice object that requires IP to be auto-allocated and DNS record to be registered. @Assumptions: - This example assumes the virtualservice being created is part of a Cloud with Internal IPAM & DNS provider - On Avi - Network object containing free IPs from "10.10.10.0/24" is already created - "prod.corp" is configured as a domain name in DNS provider config in Avi ```json {'name': 'production_vs', 'fqdn': 'production_vs.prod.corp', 'vip': [{'subnet': {'ip_addr': {'addr': '10.10.10.0', 'type': 'V4'}, 'mask': 24}, 'auto_allocate_ip': True, 'network_ref': '/api/network/network-042975ea-376d-4e59-b8da-1b299be51eb1'}]} ``` contact: name: Avi Networks Inc. url: https://avinetworks.com/contact-us email: support@avinetworks.com version: '20.1.1' servers: - url: https://{defaultHost} variables: defaultHost: default: www.example.com/api paths: /virtualservice: get: summary: Virtualservice_GET description: '' operationId: Virtualservice_GET parameters: - name: name in: query description: object name style: form explode: true schema: type: string - name: refers_to in: query description: Filter to request all objects that refers to another Avi resource. Its syntax is refers_to=:. Eg. get all virtual services referring to pool p1 will be refers_to=pool:pool_p1_uuid style: form explode: true schema: type: string - name: referred_by in: query description: Filter to request all objects that are referred by another Avi resource. Its syntax is referred_by=:. Eg. get all pools referred_by virtual service vs1 - referred_by=virtualservice:vs_vs1_uuid style: form explode: true schema: type: string - name: fields in: query description: List of fields to be returned for the resource. Some fields like name, URL, uuid etc. are always returned. style: form explode: true schema: type: string - name: include_name in: query description: 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. style: form explode: true schema: type: boolean - name: skip_default in: query description: Default values are not set. style: form explode: true schema: type: boolean - name: join_subresources in: query description: It automatically returns additional dependent resources like runtime. Eg. join_subresources=runtime. style: form explode: true schema: type: string - name: X-Avi-Tenant in: header description: Avi Tenant Header style: simple schema: type: string - name: X-Avi-Tenant-UUID in: header description: Avi Tenant Header UUID style: simple schema: type: string - name: X-Avi-Version in: header description: The caller is required to set Avi Version Header to the expected version of configuration. The response from the controller will provide and accept data according to the specified version. The controller will reject POST and PUT requests where the data is not compatible with the specified version. required: true style: simple schema: type: string - name: X-CSRFToken in: header description: Avi Controller may send back CSRF token in the response cookies. The caller should update the request headers with this token else controller will reject requests. style: simple schema: type: string - name: cloud_uuid in: query description: Filter to get objects that belongs to a specific cloud using its uuid. Eg. cloud_uuid=cloud-xyz. style: form explode: true schema: type: string - name: cloud_ref.name in: query description: 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. style: form explode: true schema: type: string responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/VirtualServiceApiResponse' '401': description: log in failed headers: {} content: {} deprecated: false post: summary: Virtualservice_POST description: '' operationId: Virtualservice_POST parameters: - name: X-Avi-Tenant in: header description: Avi Tenant Header style: simple schema: type: string - name: X-Avi-Tenant-UUID in: header description: Avi Tenant Header UUID style: simple schema: type: string - name: X-Avi-Version in: header description: The caller is required to set Avi Version Header to the expected version of configuration. The response from the controller will provide and accept data according to the specified version. The controller will reject POST and PUT requests where the data is not compatible with the specified version. required: true style: simple schema: type: string - name: X-CSRFToken in: header description: Avi Controller may send back CSRF token in the response cookies. The caller should update the request headers with this token else controller will reject requests. style: simple schema: type: string requestBody: description: VirtualService object creation content: application/json: schema: allOf: - $ref: '#/components/schemas/VirtualService' - description: VirtualService object creation required: true responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/VirtualService' '401': description: log in failed headers: {} content: {} deprecated: false /virtualservice/{uuid}: get: summary: VirtualserviceByUuid_GET description: '' operationId: VirtualserviceByUuid_GET parameters: - name: name in: query description: object name style: form explode: true schema: type: string - name: X-Avi-Tenant in: header description: Avi Tenant Header style: simple schema: type: string - name: X-Avi-Tenant-UUID in: header description: Avi Tenant Header UUID style: simple schema: type: string - name: X-Avi-Version in: header description: The caller is required to set Avi Version Header to the expected version of configuration. The response from the controller will provide and accept data according to the specified version. The controller will reject POST and PUT requests where the data is not compatible with the specified version. required: true style: simple schema: type: string - name: X-CSRFToken in: header description: Avi Controller may send back CSRF token in the response cookies. The caller should update the request headers with this token else controller will reject requests. style: simple schema: type: string - name: uuid in: path description: UUID of the object to fetch required: true style: simple schema: type: string - name: fields in: query description: List of fields to be returned for the resource. Some fields like name, URL, uuid etc. are always returned. style: form explode: true schema: type: string - name: include_name in: query description: 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. style: form explode: true schema: type: boolean - name: skip_default in: query description: Default values are not set. style: form explode: true schema: type: boolean - name: join_subresources in: query description: It automatically returns additional dependent resources like runtime. Eg. join_subresources=runtime. style: form explode: true schema: type: string responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/VirtualService' '401': description: log in failed headers: {} content: {} deprecated: false put: summary: VirtualserviceByUuid_PUT description: '' operationId: VirtualserviceByUuid_PUT parameters: - name: name in: query description: object name style: form explode: true schema: type: string - name: X-Avi-Tenant in: header description: Avi Tenant Header style: simple schema: type: string - name: X-Avi-Tenant-UUID in: header description: Avi Tenant Header UUID style: simple schema: type: string - name: X-Avi-Version in: header description: The caller is required to set Avi Version Header to the expected version of configuration. The response from the controller will provide and accept data according to the specified version. The controller will reject POST and PUT requests where the data is not compatible with the specified version. required: true style: simple schema: type: string - name: X-CSRFToken in: header description: Avi Controller may send back CSRF token in the response cookies. The caller should update the request headers with this token else controller will reject requests. style: simple schema: type: string - name: uuid in: path description: UUID of the object to fetch required: true style: simple schema: type: string requestBody: description: VirtualService object creation content: application/json: schema: allOf: - $ref: '#/components/schemas/VirtualService' - description: VirtualService object creation required: true responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/VirtualService' '401': description: log in failed headers: {} content: {} deprecated: false patch: summary: VirtualserviceByUuid_PATCH description: '' operationId: VirtualserviceByUuid_PATCH parameters: - name: name in: query description: object name style: form explode: true schema: type: string - name: X-Avi-Tenant in: header description: Avi Tenant Header style: simple schema: type: string - name: X-Avi-Tenant-UUID in: header description: Avi Tenant Header UUID style: simple schema: type: string - name: X-Avi-Version in: header description: The caller is required to set Avi Version Header to the expected version of configuration. The response from the controller will provide and accept data according to the specified version. The controller will reject POST and PUT requests where the data is not compatible with the specified version. required: true style: simple schema: type: string - name: X-CSRFToken in: header description: Avi Controller may send back CSRF token in the response cookies. The caller should update the request headers with this token else controller will reject requests. style: simple schema: type: string - name: uuid in: path description: UUID of the object to fetch required: true style: simple schema: type: string requestBody: description: VirtualService object creation content: application/json: schema: allOf: - $ref: '#/components/schemas/VirtualService' - description: VirtualService object creation required: true responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/VirtualService' '401': description: log in failed headers: {} content: {} deprecated: false delete: summary: VirtualserviceByUuid_DELETE description: '' operationId: VirtualserviceByUuid_DELETE parameters: - name: name in: query description: object name style: form explode: true schema: type: string - name: X-Avi-Tenant in: header description: Avi Tenant Header style: simple schema: type: string - name: X-Avi-Tenant-UUID in: header description: Avi Tenant Header UUID style: simple schema: type: string - name: X-Avi-Version in: header description: The caller is required to set Avi Version Header to the expected version of configuration. The response from the controller will provide and accept data according to the specified version. The controller will reject POST and PUT requests where the data is not compatible with the specified version. required: true style: simple schema: type: string - name: X-CSRFToken in: header description: Avi Controller may send back CSRF token in the response cookies. The caller should update the request headers with this token else controller will reject requests. style: simple schema: type: string - name: uuid in: path description: UUID of the object to fetch required: true style: simple schema: type: string responses: '204': description: object deleted headers: {} content: application/json: schema: type: string description: object deleted '404': description: not found headers: {} content: {} deprecated: false /virtualservice/{uuid}/scaleout: post: summary: VirtualserviceScaleoutByUuid_POST description: '' operationId: VirtualserviceScaleoutByUuid_POST parameters: - name: X-Avi-Tenant in: header description: Avi Tenant Header style: simple schema: type: string - name: X-Avi-Tenant-UUID in: header description: Avi Tenant Header UUID style: simple schema: type: string - name: X-Avi-Version in: header description: The caller is required to set Avi Version Header to the expected version of configuration. The response from the controller will provide and accept data according to the specified version. The controller will reject POST and PUT requests where the data is not compatible with the specified version. required: true style: simple schema: type: string - name: X-CSRFToken in: header description: Avi Controller may send back CSRF token in the response cookies. The caller should update the request headers with this token else controller will reject requests. style: simple schema: type: string - name: uuid in: path description: UUID of the object to fetch required: true style: simple schema: type: string requestBody: description: VsScaleoutParams content: application/json: schema: allOf: - $ref: '#/components/schemas/VsScaleoutParams' - description: VsScaleoutParams required: true responses: '200': description: OK headers: {} content: application/json: schema: type: string description: OK '401': description: log in failed headers: {} content: {} deprecated: false /virtualservice/{uuid}/scalein: post: summary: VirtualserviceScaleinByUuid_POST description: '' operationId: VirtualserviceScaleinByUuid_POST parameters: - name: X-Avi-Tenant in: header description: Avi Tenant Header style: simple schema: type: string - name: X-Avi-Tenant-UUID in: header description: Avi Tenant Header UUID style: simple schema: type: string - name: X-Avi-Version in: header description: The caller is required to set Avi Version Header to the expected version of configuration. The response from the controller will provide and accept data according to the specified version. The controller will reject POST and PUT requests where the data is not compatible with the specified version. required: true style: simple schema: type: string - name: X-CSRFToken in: header description: Avi Controller may send back CSRF token in the response cookies. The caller should update the request headers with this token else controller will reject requests. style: simple schema: type: string - name: uuid in: path description: UUID of the object to fetch required: true style: simple schema: type: string requestBody: description: VsScaleinParams content: application/json: schema: allOf: - $ref: '#/components/schemas/VsScaleinParams' - description: VsScaleinParams required: true responses: '200': description: OK headers: {} content: application/json: schema: type: string description: OK '401': description: log in failed headers: {} content: {} deprecated: false /virtualservice/{uuid}/migrate: post: summary: VirtualserviceMigrateByUuid_POST description: '' operationId: VirtualserviceMigrateByUuid_POST parameters: - name: X-Avi-Tenant in: header description: Avi Tenant Header style: simple schema: type: string - name: X-Avi-Tenant-UUID in: header description: Avi Tenant Header UUID style: simple schema: type: string - name: X-Avi-Version in: header description: The caller is required to set Avi Version Header to the expected version of configuration. The response from the controller will provide and accept data according to the specified version. The controller will reject POST and PUT requests where the data is not compatible with the specified version. required: true style: simple schema: type: string - name: X-CSRFToken in: header description: Avi Controller may send back CSRF token in the response cookies. The caller should update the request headers with this token else controller will reject requests. style: simple schema: type: string - name: uuid in: path description: UUID of the object to fetch required: true style: simple schema: type: string requestBody: description: VsMigrateParams content: application/json: schema: allOf: - $ref: '#/components/schemas/VsMigrateParams' - description: VsMigrateParams required: true responses: '200': description: OK headers: {} content: application/json: schema: type: string description: OK '401': description: log in failed headers: {} content: {} deprecated: false /virtualservice/{uuid}/switchover: post: summary: VirtualserviceSwitchoverByUuid_POST description: '' operationId: VirtualserviceSwitchoverByUuid_POST parameters: - name: X-Avi-Tenant in: header description: Avi Tenant Header style: simple schema: type: string - name: X-Avi-Tenant-UUID in: header description: Avi Tenant Header UUID style: simple schema: type: string - name: X-Avi-Version in: header description: The caller is required to set Avi Version Header to the expected version of configuration. The response from the controller will provide and accept data according to the specified version. The controller will reject POST and PUT requests where the data is not compatible with the specified version. required: true style: simple schema: type: string - name: X-CSRFToken in: header description: Avi Controller may send back CSRF token in the response cookies. The caller should update the request headers with this token else controller will reject requests. style: simple schema: type: string - name: uuid in: path description: UUID of the object to fetch required: true style: simple schema: type: string requestBody: description: VsSwitchoverParams content: application/json: schema: allOf: - $ref: '#/components/schemas/VsSwitchoverParams' - description: VsSwitchoverParams required: true responses: '200': description: OK headers: {} content: application/json: schema: type: string description: OK '401': description: log in failed headers: {} content: {} deprecated: false /virtualservice/{uuid}/clear: post: summary: VirtualserviceClearByUuid_POST description: '' operationId: VirtualserviceClearByUuid_POST parameters: - name: X-Avi-Tenant in: header description: Avi Tenant Header style: simple schema: type: string - name: X-Avi-Tenant-UUID in: header description: Avi Tenant Header UUID style: simple schema: type: string - name: X-Avi-Version in: header description: The caller is required to set Avi Version Header to the expected version of configuration. The response from the controller will provide and accept data according to the specified version. The controller will reject POST and PUT requests where the data is not compatible with the specified version. required: true style: simple schema: type: string - name: X-CSRFToken in: header description: Avi Controller may send back CSRF token in the response cookies. The caller should update the request headers with this token else controller will reject requests. style: simple schema: type: string - name: uuid in: path description: UUID of the object to fetch required: true style: simple schema: type: string requestBody: description: empty content: application/json: schema: type: object additionalProperties: type: string description: empty required: true responses: '200': description: OK headers: {} content: application/json: schema: type: string description: OK '401': description: log in failed headers: {} content: {} deprecated: false /virtualservice/{uuid}/resync: post: summary: VirtualserviceResyncByUuid_POST description: '' operationId: VirtualserviceResyncByUuid_POST parameters: - name: X-Avi-Tenant in: header description: Avi Tenant Header style: simple schema: type: string - name: X-Avi-Tenant-UUID in: header description: Avi Tenant Header UUID style: simple schema: type: string - name: X-Avi-Version in: header description: The caller is required to set Avi Version Header to the expected version of configuration. The response from the controller will provide and accept data according to the specified version. The controller will reject POST and PUT requests where the data is not compatible with the specified version. required: true style: simple schema: type: string - name: X-CSRFToken in: header description: Avi Controller may send back CSRF token in the response cookies. The caller should update the request headers with this token else controller will reject requests. style: simple schema: type: string - name: uuid in: path description: UUID of the object to fetch required: true style: simple schema: type: string requestBody: description: VsResyncParams content: application/json: schema: allOf: - $ref: '#/components/schemas/VsResyncParams' - description: VsResyncParams required: true responses: '200': description: OK headers: {} content: application/json: schema: type: string description: OK '401': description: log in failed headers: {} content: {} deprecated: false /virtualservice/{uuid}/rotatekeys: post: summary: VirtualserviceRotatekeysByUuid_POST description: '' operationId: VirtualserviceRotatekeysByUuid_POST parameters: - name: X-Avi-Tenant in: header description: Avi Tenant Header style: simple schema: type: string - name: X-Avi-Tenant-UUID in: header description: Avi Tenant Header UUID style: simple schema: type: string - name: X-Avi-Version in: header description: The caller is required to set Avi Version Header to the expected version of configuration. The response from the controller will provide and accept data according to the specified version. The controller will reject POST and PUT requests where the data is not compatible with the specified version. required: true style: simple schema: type: string - name: X-CSRFToken in: header description: Avi Controller may send back CSRF token in the response cookies. The caller should update the request headers with this token else controller will reject requests. style: simple schema: type: string - name: uuid in: path description: UUID of the object to fetch required: true style: simple schema: type: string requestBody: description: empty content: application/json: schema: type: object additionalProperties: type: string description: empty required: true responses: '200': description: OK headers: {} content: application/json: schema: type: string description: OK '401': description: log in failed headers: {} content: {} deprecated: false /virtualservice/{uuid}/apicplacement: post: summary: VirtualserviceApicplacementByUuid_POST description: '' operationId: VirtualserviceApicplacementByUuid_POST parameters: - name: X-Avi-Tenant in: header description: Avi Tenant Header style: simple schema: type: string - name: X-Avi-Tenant-UUID in: header description: Avi Tenant Header UUID style: simple schema: type: string - name: X-Avi-Version in: header description: The caller is required to set Avi Version Header to the expected version of configuration. The response from the controller will provide and accept data according to the specified version. The controller will reject POST and PUT requests where the data is not compatible with the specified version. required: true style: simple schema: type: string - name: X-CSRFToken in: header description: Avi Controller may send back CSRF token in the response cookies. The caller should update the request headers with this token else controller will reject requests. style: simple schema: type: string - name: uuid in: path description: UUID of the object to fetch required: true style: simple schema: type: string requestBody: description: ApicVSPlacementReq content: application/json: schema: allOf: - $ref: '#/components/schemas/ApicVSPlacementReq' - description: ApicVSPlacementReq required: true responses: '200': description: OK headers: {} content: application/json: schema: type: string description: OK '401': description: log in failed headers: {} content: {} deprecated: false /virtualservice/{uuid}/retryplacement: post: summary: VirtualserviceRetryplacementByUuid_POST description: '' operationId: VirtualserviceRetryplacementByUuid_POST parameters: - name: X-Avi-Tenant in: header description: Avi Tenant Header style: simple schema: type: string - name: X-Avi-Tenant-UUID in: header description: Avi Tenant Header UUID style: simple schema: type: string - name: X-Avi-Version in: header description: The caller is required to set Avi Version Header to the expected version of configuration. The response from the controller will provide and accept data according to the specified version. The controller will reject POST and PUT requests where the data is not compatible with the specified version. required: true style: simple schema: type: string - name: X-CSRFToken in: header description: Avi Controller may send back CSRF token in the response cookies. The caller should update the request headers with this token else controller will reject requests. style: simple schema: type: string - name: uuid in: path description: UUID of the object to fetch required: true style: simple schema: type: string requestBody: description: RetryPlacementParams content: application/json: schema: allOf: - $ref: '#/components/schemas/RetryPlacementParams' - description: RetryPlacementParams required: true responses: '200': description: OK headers: {} content: application/json: schema: type: string description: OK '401': description: log in failed headers: {} content: {} deprecated: false /virtualservice/{uuid}/runtime/: get: summary: VirtualserviceRuntimeByUuid_GET description: '' operationId: VirtualserviceRuntimeByUuid_GET parameters: - name: X-Avi-Tenant in: header description: Avi Tenant Header style: simple schema: type: string - name: X-Avi-Tenant-UUID in: header description: Avi Tenant Header UUID style: simple schema: type: string - name: X-CSRFToken in: header description: Avi Controller may send back CSRF token in the response cookies. The caller should update the request headers with this token else controller will reject requests. style: simple schema: type: string - name: X-Avi-Version in: header description: The caller is required to set Avi Version Header to the expected version of configuration. The response from the controller will provide and accept data according to the specified version. The controller will reject POST and PUT requests where the data is not compatible with the specified version. required: true style: simple schema: type: string - name: uuid in: path description: UUID of the object to fetch required: true style: simple schema: type: string responses: '200': description: OK headers: {} content: application/json: schema: type: string description: OK '401': description: log in failed headers: {} content: {} deprecated: false /virtualservice/{uuid}/runtime/detail/: get: summary: VirtualserviceRuntimeDetailByUuid_GET description: '' operationId: VirtualserviceRuntimeDetailByUuid_GET parameters: - name: X-Avi-Tenant in: header description: Avi Tenant Header style: simple schema: type: string - name: X-Avi-Tenant-UUID in: header description: Avi Tenant Header UUID style: simple schema: type: string - name: X-CSRFToken in: header description: Avi Controller may send back CSRF token in the response cookies. The caller should update the request headers with this token else controller will reject requests. style: simple schema: type: string - name: X-Avi-Version in: header description: The caller is required to set Avi Version Header to the expected version of configuration. The response from the controller will provide and accept data according to the specified version. The controller will reject POST and PUT requests where the data is not compatible with the specified version. required: true style: simple schema: type: string - name: uuid in: path description: UUID of the object to fetch required: true style: simple schema: type: string responses: '200': description: OK headers: {} content: application/json: schema: type: string description: OK '401': description: log in failed headers: {} content: {} deprecated: false /virtualservice/{uuid}/runtime/internal/: get: summary: VirtualserviceRuntimeInternalByUuid_GET description: '' operationId: VirtualserviceRuntimeInternalByUuid_GET parameters: - name: X-Avi-Tenant in: header description: Avi Tenant Header style: simple schema: type: string - name: X-Avi-Tenant-UUID in: header description: Avi Tenant Header UUID style: simple schema: type: string - name: X-CSRFToken in: header description: Avi Controller may send back CSRF token in the response cookies. The caller should update the request headers with this token else controller will reject requests. style: simple schema: type: string - name: X-Avi-Version in: header description: The caller is required to set Avi Version Header to the expected version of configuration. The response from the controller will provide and accept data according to the specified version. The controller will reject POST and PUT requests where the data is not compatible with the specified version. required: true style: simple schema: type: string - name: uuid in: path description: UUID of the object to fetch required: true style: simple schema: type: string responses: '200': description: OK headers: {} content: application/json: schema: type: string description: OK '401': description: log in failed headers: {} content: {} deprecated: false /virtualservice/{uuid}/udpstat/: get: summary: VirtualserviceUdpstatByUuid_GET description: '' operationId: VirtualserviceUdpstatByUuid_GET parameters: - name: X-Avi-Tenant in: header description: Avi Tenant Header style: simple schema: type: string - name: X-Avi-Tenant-UUID in: header description: Avi Tenant Header UUID style: simple schema: type: string - name: X-CSRFToken in: header description: Avi Controller may send back CSRF token in the response cookies. The caller should update the request headers with this token else controller will reject requests. style: simple schema: type: string - name: X-Avi-Version in: header description: The caller is required to set Avi Version Header to the expected version of configuration. The response from the controller will provide and accept data according to the specified version. The controller will reject POST and PUT requests where the data is not compatible with the specified version. required: true style: simple schema: type: string - name: uuid in: path description: UUID of the object to fetch required: true style: simple schema: type: string responses: '200': description: OK headers: {} content: application/json: schema: type: string description: OK '401': description: log in failed headers: {} content: {} deprecated: false /virtualservice/{uuid}/tcpstat/: get: summary: VirtualserviceTcpstatByUuid_GET description: '' operationId: VirtualserviceTcpstatByUuid_GET parameters: - name: X-Avi-Tenant in: header description: Avi Tenant Header style: simple schema: type: string - name: X-Avi-Tenant-UUID in: header description: Avi Tenant Header UUID style: simple schema: type: string - name: X-CSRFToken in: header description: Avi Controller may send back CSRF token in the response cookies. The caller should update the request headers with this token else controller will reject requests. style: simple schema: type: string - name: X-Avi-Version in: header description: The caller is required to set Avi Version Header to the expected version of configuration. The response from the controller will provide and accept data according to the specified version. The controller will reject POST and PUT requests where the data is not compatible with the specified version. required: true style: simple schema: type: string - name: uuid in: path description: UUID of the object to fetch required: true style: simple schema: type: string responses: '200': description: OK headers: {} content: application/json: schema: type: string description: OK '401': description: log in failed headers: {} content: {} deprecated: false /virtualservice/{uuid}/traffic_clone_stats/: get: summary: VirtualserviceTrafficCloneStatsByUuid_GET description: '' operationId: VirtualserviceTrafficCloneStatsByUuid_GET parameters: - name: X-Avi-Tenant in: header description: Avi Tenant Header style: simple schema: type: string - name: X-Avi-Tenant-UUID in: header description: Avi Tenant Header UUID style: simple schema: type: string - name: X-CSRFToken in: header description: Avi Controller may send back CSRF token in the response cookies. The caller should update the request headers with this token else controller will reject requests. style: simple schema: type: string - name: X-Avi-Version in: header description: The caller is required to set Avi Version Header to the expected version of configuration. The response from the controller will provide and accept data according to the specified version. The controller will reject POST and PUT requests where the data is not compatible with the specified version. required: true style: simple schema: type: string - name: uuid in: path description: UUID of the object to fetch required: true style: simple schema: type: string responses: '200': description: OK headers: {} content: application/json: schema: type: string description: OK '401': description: log in failed headers: {} content: {} deprecated: false /virtualservice/{uuid}/dosstat/: get: summary: VirtualserviceDosstatByUuid_GET description: '' operationId: VirtualserviceDosstatByUuid_GET parameters: - name: X-Avi-Tenant in: header description: Avi Tenant Header style: simple schema: type: string - name: X-Avi-Tenant-UUID in: header description: Avi Tenant Header UUID style: simple schema: type: string - name: X-CSRFToken in: header description: Avi Controller may send back CSRF token in the response cookies. The caller should update the request headers with this token else controller will reject requests. style: simple schema: type: string - name: X-Avi-Version in: header description: The caller is required to set Avi Version Header to the expected version of configuration. The response from the controller will provide and accept data according to the specified version. The controller will reject POST and PUT requests where the data is not compatible with the specified version. required: true style: simple schema: type: string - name: uuid in: path description: UUID of the object to fetch required: true style: simple schema: type: string responses: '200': description: OK headers: {} content: application/json: schema: type: string description: OK '401': description: log in failed headers: {} content: {} deprecated: false /virtualservice/{uuid}/connections/: get: summary: VirtualserviceConnectionsByUuid_GET description: '' operationId: VirtualserviceConnectionsByUuid_GET parameters: - name: X-Avi-Tenant in: header description: Avi Tenant Header style: simple schema: type: string - name: X-Avi-Tenant-UUID in: header description: Avi Tenant Header UUID style: simple schema: type: string - name: X-CSRFToken in: header description: Avi Controller may send back CSRF token in the response cookies. The caller should update the request headers with this token else controller will reject requests. style: simple schema: type: string - name: X-Avi-Version in: header description: The caller is required to set Avi Version Header to the expected version of configuration. The response from the controller will provide and accept data according to the specified version. The controller will reject POST and PUT requests where the data is not compatible with the specified version. required: true style: simple schema: type: string - name: uuid in: path description: UUID of the object to fetch required: true style: simple schema: type: string responses: '200': description: OK headers: {} content: application/json: schema: type: string description: OK '401': description: log in failed headers: {} content: {} deprecated: false /virtualservice/{uuid}/httpconnections/: get: summary: VirtualserviceHttpconnectionsByUuid_GET description: '' operationId: VirtualserviceHttpconnectionsByUuid_GET parameters: - name: X-Avi-Tenant in: header description: Avi Tenant Header style: simple schema: type: string - name: X-Avi-Tenant-UUID in: header description: Avi Tenant Header UUID style: simple schema: type: string - name: X-CSRFToken in: header description: Avi Controller may send back CSRF token in the response cookies. The caller should update the request headers with this token else controller will reject requests. style: simple schema: type: string - name: X-Avi-Version in: header description: The caller is required to set Avi Version Header to the expected version of configuration. The response from the controller will provide and accept data according to the specified version. The controller will reject POST and PUT requests where the data is not compatible with the specified version. required: true style: simple schema: type: string - name: uuid in: path description: UUID of the object to fetch required: true style: simple schema: type: string responses: '200': description: OK headers: {} content: application/json: schema: type: string description: OK '401': description: log in failed headers: {} content: {} deprecated: false /virtualservice/{uuid}/httpconnections/detail/: get: summary: VirtualserviceHttpconnectionsDetail_GET description: '' operationId: VirtualserviceHttpconnectionsDetail_GET parameters: - name: X-Avi-Tenant in: header description: Avi Tenant Header style: simple schema: type: string - name: X-Avi-Tenant-UUID in: header description: Avi Tenant Header UUID style: simple schema: type: string - name: X-CSRFToken in: header description: Avi Controller may send back CSRF token in the response cookies. The caller should update the request headers with this token else controller will reject requests. style: simple schema: type: string - name: X-Avi-Version in: header description: The caller is required to set Avi Version Header to the expected version of configuration. The response from the controller will provide and accept data according to the specified version. The controller will reject POST and PUT requests where the data is not compatible with the specified version. required: true style: simple schema: type: string - name: uuid in: path description: UUID of the object to fetch required: true style: simple schema: type: string responses: '200': description: OK headers: {} content: application/json: schema: type: string description: OK '401': description: log in failed headers: {} content: {} deprecated: false /virtualservice/{uuid}/httpstats/: get: summary: VirtualserviceHttpstatsByUuid_GET description: '' operationId: VirtualserviceHttpstatsByUuid_GET parameters: - name: X-Avi-Tenant in: header description: Avi Tenant Header style: simple schema: type: string - name: X-Avi-Tenant-UUID in: header description: Avi Tenant Header UUID style: simple schema: type: string - name: X-CSRFToken in: header description: Avi Controller may send back CSRF token in the response cookies. The caller should update the request headers with this token else controller will reject requests. style: simple schema: type: string - name: X-Avi-Version in: header description: The caller is required to set Avi Version Header to the expected version of configuration. The response from the controller will provide and accept data according to the specified version. The controller will reject POST and PUT requests where the data is not compatible with the specified version. required: true style: simple schema: type: string - name: uuid in: path description: UUID of the object to fetch required: true style: simple schema: type: string responses: '200': description: OK headers: {} content: application/json: schema: type: string description: OK '401': description: log in failed headers: {} content: {} deprecated: false /virtualservice/{uuid}/authstats/: get: summary: VirtualserviceAuthstatsByUuid_GET description: '' operationId: VirtualserviceAuthstatsByUuid_GET parameters: - name: X-Avi-Tenant in: header description: Avi Tenant Header style: simple schema: type: string - name: X-Avi-Tenant-UUID in: header description: Avi Tenant Header UUID style: simple schema: type: string - name: X-CSRFToken in: header description: Avi Controller may send back CSRF token in the response cookies. The caller should update the request headers with this token else controller will reject requests. style: simple schema: type: string - name: X-Avi-Version in: header description: The caller is required to set Avi Version Header to the expected version of configuration. The response from the controller will provide and accept data according to the specified version. The controller will reject POST and PUT requests where the data is not compatible with the specified version. required: true style: simple schema: type: string - name: uuid in: path description: UUID of the object to fetch required: true style: simple schema: type: string responses: '200': description: OK headers: {} content: application/json: schema: type: string description: OK '401': description: log in failed headers: {} content: {} deprecated: false /virtualservice/{uuid}/httppolicyset/: get: summary: VirtualserviceHttppolicysetByUuid_GET description: '' operationId: VirtualserviceHttppolicysetByUuid_GET parameters: - name: X-Avi-Tenant in: header description: Avi Tenant Header style: simple schema: type: string - name: X-Avi-Tenant-UUID in: header description: Avi Tenant Header UUID style: simple schema: type: string - name: X-CSRFToken in: header description: Avi Controller may send back CSRF token in the response cookies. The caller should update the request headers with this token else controller will reject requests. style: simple schema: type: string - name: X-Avi-Version in: header description: The caller is required to set Avi Version Header to the expected version of configuration. The response from the controller will provide and accept data according to the specified version. The controller will reject POST and PUT requests where the data is not compatible with the specified version. required: true style: simple schema: type: string - name: uuid in: path description: UUID of the object to fetch required: true style: simple schema: type: string responses: '200': description: OK headers: {} content: application/json: schema: type: string description: OK '401': description: log in failed headers: {} content: {} deprecated: false /virtualservice/{uuid}/httppolicysetstats/: get: summary: VirtualserviceHttppolicysetstatsByUuid_GET description: '' operationId: VirtualserviceHttppolicysetstatsByUuid_GET parameters: - name: X-Avi-Tenant in: header description: Avi Tenant Header style: simple schema: type: string - name: X-Avi-Tenant-UUID in: header description: Avi Tenant Header UUID style: simple schema: type: string - name: X-CSRFToken in: header description: Avi Controller may send back CSRF token in the response cookies. The caller should update the request headers with this token else controller will reject requests. style: simple schema: type: string - name: X-Avi-Version in: header description: The caller is required to set Avi Version Header to the expected version of configuration. The response from the controller will provide and accept data according to the specified version. The controller will reject POST and PUT requests where the data is not compatible with the specified version. required: true style: simple schema: type: string - name: uuid in: path description: UUID of the object to fetch required: true style: simple schema: type: string responses: '200': description: OK headers: {} content: application/json: schema: type: string description: OK '401': description: log in failed headers: {} content: {} deprecated: false /virtualservice/{uuid}/dnspolicystats/: get: summary: VirtualserviceDnspolicystatsByUuid_GET description: '' operationId: VirtualserviceDnspolicystatsByUuid_GET parameters: - name: X-Avi-Tenant in: header description: Avi Tenant Header style: simple schema: type: string - name: X-Avi-Tenant-UUID in: header description: Avi Tenant Header UUID style: simple schema: type: string - name: X-CSRFToken in: header description: Avi Controller may send back CSRF token in the response cookies. The caller should update the request headers with this token else controller will reject requests. style: simple schema: type: string - name: X-Avi-Version in: header description: The caller is required to set Avi Version Header to the expected version of configuration. The response from the controller will provide and accept data according to the specified version. The controller will reject POST and PUT requests where the data is not compatible with the specified version. required: true style: simple schema: type: string - name: uuid in: path description: UUID of the object to fetch required: true style: simple schema: type: string responses: '200': description: OK headers: {} content: application/json: schema: type: string description: OK '401': description: log in failed headers: {} content: {} deprecated: false /virtualservice/{uuid}/networksecuritypolicystats/: get: summary: VirtualserviceNetworksecuritypolicystats_GET description: '' operationId: VirtualserviceNetworksecuritypolicystats_GET parameters: - name: X-Avi-Tenant in: header description: Avi Tenant Header style: simple schema: type: string - name: X-Avi-Tenant-UUID in: header description: Avi Tenant Header UUID style: simple schema: type: string - name: X-CSRFToken in: header description: Avi Controller may send back CSRF token in the response cookies. The caller should update the request headers with this token else controller will reject requests. style: simple schema: type: string - name: X-Avi-Version in: header description: The caller is required to set Avi Version Header to the expected version of configuration. The response from the controller will provide and accept data according to the specified version. The controller will reject POST and PUT requests where the data is not compatible with the specified version. required: true style: simple schema: type: string - name: uuid in: path description: UUID of the object to fetch required: true style: simple schema: type: string responses: '200': description: OK headers: {} content: application/json: schema: type: string description: OK '401': description: log in failed headers: {} content: {} deprecated: false /virtualservice/{uuid}/networksecuritypolicy/detail/: get: summary: VirtualserviceNetworksecuritypolicyDetail_GET description: '' operationId: VirtualserviceNetworksecuritypolicyDetail_GET parameters: - name: X-Avi-Tenant in: header description: Avi Tenant Header style: simple schema: type: string - name: X-Avi-Tenant-UUID in: header description: Avi Tenant Header UUID style: simple schema: type: string - name: X-CSRFToken in: header description: Avi Controller may send back CSRF token in the response cookies. The caller should update the request headers with this token else controller will reject requests. style: simple schema: type: string - name: X-Avi-Version in: header description: The caller is required to set Avi Version Header to the expected version of configuration. The response from the controller will provide and accept data according to the specified version. The controller will reject POST and PUT requests where the data is not compatible with the specified version. required: true style: simple schema: type: string - name: uuid in: path description: UUID of the object to fetch required: true style: simple schema: type: string responses: '200': description: OK headers: {} content: application/json: schema: type: string description: OK '401': description: log in failed headers: {} content: {} deprecated: false /virtualservice/{uuid}/candidatesehostlist/: get: summary: VirtualserviceCandidatesehostlistByUuid_GET description: '' operationId: VirtualserviceCandidatesehostlistByUuid_GET parameters: - name: X-Avi-Tenant in: header description: Avi Tenant Header style: simple schema: type: string - name: X-Avi-Tenant-UUID in: header description: Avi Tenant Header UUID style: simple schema: type: string - name: X-CSRFToken in: header description: Avi Controller may send back CSRF token in the response cookies. The caller should update the request headers with this token else controller will reject requests. style: simple schema: type: string - name: X-Avi-Version in: header description: The caller is required to set Avi Version Header to the expected version of configuration. The response from the controller will provide and accept data according to the specified version. The controller will reject POST and PUT requests where the data is not compatible with the specified version. required: true style: simple schema: type: string - name: uuid in: path description: UUID of the object to fetch required: true style: simple schema: type: string responses: '200': description: OK headers: {} content: application/json: schema: type: string description: OK '401': description: log in failed headers: {} content: {} deprecated: false /virtualservice/{uuid}/placement/: get: summary: VirtualservicePlacementByUuid_GET description: '' operationId: VirtualservicePlacementByUuid_GET parameters: - name: X-Avi-Tenant in: header description: Avi Tenant Header style: simple schema: type: string - name: X-Avi-Tenant-UUID in: header description: Avi Tenant Header UUID style: simple schema: type: string - name: X-CSRFToken in: header description: Avi Controller may send back CSRF token in the response cookies. The caller should update the request headers with this token else controller will reject requests. style: simple schema: type: string - name: X-Avi-Version in: header description: The caller is required to set Avi Version Header to the expected version of configuration. The response from the controller will provide and accept data according to the specified version. The controller will reject POST and PUT requests where the data is not compatible with the specified version. required: true style: simple schema: type: string - name: uuid in: path description: UUID of the object to fetch required: true style: simple schema: type: string responses: '200': description: OK headers: {} content: application/json: schema: type: string description: OK '401': description: log in failed headers: {} content: {} deprecated: false /virtualservice/{uuid}/keyval/: get: summary: VirtualserviceKeyvalByUuid_GET description: '' operationId: VirtualserviceKeyvalByUuid_GET parameters: - name: X-Avi-Tenant in: header description: Avi Tenant Header style: simple schema: type: string - name: X-Avi-Tenant-UUID in: header description: Avi Tenant Header UUID style: simple schema: type: string - name: X-CSRFToken in: header description: Avi Controller may send back CSRF token in the response cookies. The caller should update the request headers with this token else controller will reject requests. style: simple schema: type: string - name: X-Avi-Version in: header description: The caller is required to set Avi Version Header to the expected version of configuration. The response from the controller will provide and accept data according to the specified version. The controller will reject POST and PUT requests where the data is not compatible with the specified version. required: true style: simple schema: type: string - name: uuid in: path description: UUID of the object to fetch required: true style: simple schema: type: string responses: '200': description: OK headers: {} content: application/json: schema: type: string description: OK '401': description: log in failed headers: {} content: {} deprecated: false /virtualservice/{uuid}/keyvalsummary/: get: summary: VirtualserviceKeyvalsummaryByUuid_GET description: '' operationId: VirtualserviceKeyvalsummaryByUuid_GET parameters: - name: X-Avi-Tenant in: header description: Avi Tenant Header style: simple schema: type: string - name: X-Avi-Tenant-UUID in: header description: Avi Tenant Header UUID style: simple schema: type: string - name: X-CSRFToken in: header description: Avi Controller may send back CSRF token in the response cookies. The caller should update the request headers with this token else controller will reject requests. style: simple schema: type: string - name: X-Avi-Version in: header description: The caller is required to set Avi Version Header to the expected version of configuration. The response from the controller will provide and accept data according to the specified version. The controller will reject POST and PUT requests where the data is not compatible with the specified version. required: true style: simple schema: type: string - name: uuid in: path description: UUID of the object to fetch required: true style: simple schema: type: string responses: '200': description: OK headers: {} content: application/json: schema: type: string description: OK '401': description: log in failed headers: {} content: {} deprecated: false /virtualservice/{uuid}/sslsessioncache/: get: summary: VirtualserviceSslsessioncacheByUuid_GET description: '' operationId: VirtualserviceSslsessioncacheByUuid_GET parameters: - name: X-Avi-Tenant in: header description: Avi Tenant Header style: simple schema: type: string - name: X-Avi-Tenant-UUID in: header description: Avi Tenant Header UUID style: simple schema: type: string - name: X-CSRFToken in: header description: Avi Controller may send back CSRF token in the response cookies. The caller should update the request headers with this token else controller will reject requests. style: simple schema: type: string - name: X-Avi-Version in: header description: The caller is required to set Avi Version Header to the expected version of configuration. The response from the controller will provide and accept data according to the specified version. The controller will reject POST and PUT requests where the data is not compatible with the specified version. required: true style: simple schema: type: string - name: uuid in: path description: UUID of the object to fetch required: true style: simple schema: type: string responses: '200': description: OK headers: {} content: application/json: schema: type: string description: OK '401': description: log in failed headers: {} content: {} deprecated: false /virtualservice/{uuid}/cltrack/: get: summary: VirtualserviceCltrackByUuid_GET description: '' operationId: VirtualserviceCltrackByUuid_GET parameters: - name: X-Avi-Tenant in: header description: Avi Tenant Header style: simple schema: type: string - name: X-Avi-Tenant-UUID in: header description: Avi Tenant Header UUID style: simple schema: type: string - name: X-CSRFToken in: header description: Avi Controller may send back CSRF token in the response cookies. The caller should update the request headers with this token else controller will reject requests. style: simple schema: type: string - name: X-Avi-Version in: header description: The caller is required to set Avi Version Header to the expected version of configuration. The response from the controller will provide and accept data according to the specified version. The controller will reject POST and PUT requests where the data is not compatible with the specified version. required: true style: simple schema: type: string - name: uuid in: path description: UUID of the object to fetch required: true style: simple schema: type: string responses: '200': description: OK headers: {} content: application/json: schema: type: string description: OK '401': description: log in failed headers: {} content: {} deprecated: false /virtualservice/{uuid}/cltracksummary/: get: summary: VirtualserviceCltracksummaryByUuid_GET description: '' operationId: VirtualserviceCltracksummaryByUuid_GET parameters: - name: X-Avi-Tenant in: header description: Avi Tenant Header style: simple schema: type: string - name: X-Avi-Tenant-UUID in: header description: Avi Tenant Header UUID style: simple schema: type: string - name: X-CSRFToken in: header description: Avi Controller may send back CSRF token in the response cookies. The caller should update the request headers with this token else controller will reject requests. style: simple schema: type: string - name: X-Avi-Version in: header description: The caller is required to set Avi Version Header to the expected version of configuration. The response from the controller will provide and accept data according to the specified version. The controller will reject POST and PUT requests where the data is not compatible with the specified version. required: true style: simple schema: type: string - name: uuid in: path description: UUID of the object to fetch required: true style: simple schema: type: string responses: '200': description: OK headers: {} content: application/json: schema: type: string description: OK '401': description: log in failed headers: {} content: {} deprecated: false /virtualservice/{uuid}/client/: get: summary: VirtualserviceClientByUuid_GET description: '' operationId: VirtualserviceClientByUuid_GET parameters: - name: X-Avi-Tenant in: header description: Avi Tenant Header style: simple schema: type: string - name: X-Avi-Tenant-UUID in: header description: Avi Tenant Header UUID style: simple schema: type: string - name: X-CSRFToken in: header description: Avi Controller may send back CSRF token in the response cookies. The caller should update the request headers with this token else controller will reject requests. style: simple schema: type: string - name: X-Avi-Version in: header description: The caller is required to set Avi Version Header to the expected version of configuration. The response from the controller will provide and accept data according to the specified version. The controller will reject POST and PUT requests where the data is not compatible with the specified version. required: true style: simple schema: type: string - name: uuid in: path description: UUID of the object to fetch required: true style: simple schema: type: string responses: '200': description: OK headers: {} content: application/json: schema: type: string description: OK '401': description: log in failed headers: {} content: {} deprecated: false /virtualservice/{uuid}/clientsummary/: get: summary: VirtualserviceClientsummaryByUuid_GET description: '' operationId: VirtualserviceClientsummaryByUuid_GET parameters: - name: X-Avi-Tenant in: header description: Avi Tenant Header style: simple schema: type: string - name: X-Avi-Tenant-UUID in: header description: Avi Tenant Header UUID style: simple schema: type: string - name: X-CSRFToken in: header description: Avi Controller may send back CSRF token in the response cookies. The caller should update the request headers with this token else controller will reject requests. style: simple schema: type: string - name: X-Avi-Version in: header description: The caller is required to set Avi Version Header to the expected version of configuration. The response from the controller will provide and accept data according to the specified version. The controller will reject POST and PUT requests where the data is not compatible with the specified version. required: true style: simple schema: type: string - name: uuid in: path description: UUID of the object to fetch required: true style: simple schema: type: string responses: '200': description: OK headers: {} content: application/json: schema: type: string description: OK '401': description: log in failed headers: {} content: {} deprecated: false /virtualservice/{uuid}/dnstable/: get: summary: VirtualserviceDnstableByUuid_GET description: '' operationId: VirtualserviceDnstableByUuid_GET parameters: - name: X-Avi-Tenant in: header description: Avi Tenant Header style: simple schema: type: string - name: X-Avi-Tenant-UUID in: header description: Avi Tenant Header UUID style: simple schema: type: string - name: X-CSRFToken in: header description: Avi Controller may send back CSRF token in the response cookies. The caller should update the request headers with this token else controller will reject requests. style: simple schema: type: string - name: X-Avi-Version in: header description: The caller is required to set Avi Version Header to the expected version of configuration. The response from the controller will provide and accept data according to the specified version. The controller will reject POST and PUT requests where the data is not compatible with the specified version. required: true style: simple schema: type: string - name: uuid in: path description: UUID of the object to fetch required: true style: simple schema: type: string responses: '200': description: OK headers: {} content: application/json: schema: type: string description: OK '401': description: log in failed headers: {} content: {} deprecated: false /virtualservice/{uuid}/gslbservicedetail/: get: summary: VirtualserviceGslbservicedetailByUuid_GET description: '' operationId: VirtualserviceGslbservicedetailByUuid_GET parameters: - name: X-Avi-Tenant in: header description: Avi Tenant Header style: simple schema: type: string - name: X-Avi-Tenant-UUID in: header description: Avi Tenant Header UUID style: simple schema: type: string - name: X-CSRFToken in: header description: Avi Controller may send back CSRF token in the response cookies. The caller should update the request headers with this token else controller will reject requests. style: simple schema: type: string - name: X-Avi-Version in: header description: The caller is required to set Avi Version Header to the expected version of configuration. The response from the controller will provide and accept data according to the specified version. The controller will reject POST and PUT requests where the data is not compatible with the specified version. required: true style: simple schema: type: string - name: uuid in: path description: UUID of the object to fetch required: true style: simple schema: type: string responses: '200': description: OK headers: {} content: application/json: schema: type: string description: OK '401': description: log in failed headers: {} content: {} deprecated: false /virtualservice/{uuid}/gslbserviceinternal/: get: summary: VirtualserviceGslbserviceinternalByUuid_GET description: '' operationId: VirtualserviceGslbserviceinternalByUuid_GET parameters: - name: X-Avi-Tenant in: header description: Avi Tenant Header style: simple schema: type: string - name: X-Avi-Tenant-UUID in: header description: Avi Tenant Header UUID style: simple schema: type: string - name: X-CSRFToken in: header description: Avi Controller may send back CSRF token in the response cookies. The caller should update the request headers with this token else controller will reject requests. style: simple schema: type: string - name: X-Avi-Version in: header description: The caller is required to set Avi Version Header to the expected version of configuration. The response from the controller will provide and accept data according to the specified version. The controller will reject POST and PUT requests where the data is not compatible with the specified version. required: true style: simple schema: type: string - name: uuid in: path description: UUID of the object to fetch required: true style: simple schema: type: string responses: '200': description: OK headers: {} content: application/json: schema: type: string description: OK '401': description: log in failed headers: {} content: {} deprecated: false /virtualservice/{uuid}/gslbservicealgostat/: get: summary: VirtualserviceGslbservicealgostatByUuid_GET description: '' operationId: VirtualserviceGslbservicealgostatByUuid_GET parameters: - name: X-Avi-Tenant in: header description: Avi Tenant Header style: simple schema: type: string - name: X-Avi-Tenant-UUID in: header description: Avi Tenant Header UUID style: simple schema: type: string - name: X-CSRFToken in: header description: Avi Controller may send back CSRF token in the response cookies. The caller should update the request headers with this token else controller will reject requests. style: simple schema: type: string - name: X-Avi-Version in: header description: The caller is required to set Avi Version Header to the expected version of configuration. The response from the controller will provide and accept data according to the specified version. The controller will reject POST and PUT requests where the data is not compatible with the specified version. required: true style: simple schema: type: string - name: uuid in: path description: UUID of the object to fetch required: true style: simple schema: type: string responses: '200': description: OK headers: {} content: application/json: schema: type: string description: OK '401': description: log in failed headers: {} content: {} deprecated: false /virtualservice/{uuid}/gslbservicehmonstat/: get: summary: VirtualserviceGslbservicehmonstatByUuid_GET description: '' operationId: VirtualserviceGslbservicehmonstatByUuid_GET parameters: - name: X-Avi-Tenant in: header description: Avi Tenant Header style: simple schema: type: string - name: X-Avi-Tenant-UUID in: header description: Avi Tenant Header UUID style: simple schema: type: string - name: X-CSRFToken in: header description: Avi Controller may send back CSRF token in the response cookies. The caller should update the request headers with this token else controller will reject requests. style: simple schema: type: string - name: X-Avi-Version in: header description: The caller is required to set Avi Version Header to the expected version of configuration. The response from the controller will provide and accept data according to the specified version. The controller will reject POST and PUT requests where the data is not compatible with the specified version. required: true style: simple schema: type: string - name: uuid in: path description: UUID of the object to fetch required: true style: simple schema: type: string responses: '200': description: OK headers: {} content: application/json: schema: type: string description: OK '401': description: log in failed headers: {} content: {} deprecated: false /virtualservice/{uuid}/geolocationinfo/: get: summary: VirtualserviceGeolocationinfoByUuid_GET description: '' operationId: VirtualserviceGeolocationinfoByUuid_GET parameters: - name: X-Avi-Tenant in: header description: Avi Tenant Header style: simple schema: type: string - name: X-Avi-Tenant-UUID in: header description: Avi Tenant Header UUID style: simple schema: type: string - name: X-CSRFToken in: header description: Avi Controller may send back CSRF token in the response cookies. The caller should update the request headers with this token else controller will reject requests. style: simple schema: type: string - name: X-Avi-Version in: header description: The caller is required to set Avi Version Header to the expected version of configuration. The response from the controller will provide and accept data according to the specified version. The controller will reject POST and PUT requests where the data is not compatible with the specified version. required: true style: simple schema: type: string - name: uuid in: path description: UUID of the object to fetch required: true style: simple schema: type: string responses: '200': description: OK headers: {} content: application/json: schema: type: string description: OK '401': description: log in failed headers: {} content: {} deprecated: false /virtualservice/{uuid}/geodbinternal/: get: summary: VirtualserviceGeodbinternalByUuid_GET description: '' operationId: VirtualserviceGeodbinternalByUuid_GET parameters: - name: X-Avi-Tenant in: header description: Avi Tenant Header style: simple schema: type: string - name: X-Avi-Tenant-UUID in: header description: Avi Tenant Header UUID style: simple schema: type: string - name: X-CSRFToken in: header description: Avi Controller may send back CSRF token in the response cookies. The caller should update the request headers with this token else controller will reject requests. style: simple schema: type: string - name: X-Avi-Version in: header description: The caller is required to set Avi Version Header to the expected version of configuration. The response from the controller will provide and accept data according to the specified version. The controller will reject POST and PUT requests where the data is not compatible with the specified version. required: true style: simple schema: type: string - name: uuid in: path description: UUID of the object to fetch required: true style: simple schema: type: string responses: '200': description: OK headers: {} content: application/json: schema: type: string description: OK '401': description: log in failed headers: {} content: {} deprecated: false /virtualservice/{uuid}/gslbsiteinternal/: get: summary: VirtualserviceGslbsiteinternalByUuid_GET description: '' operationId: VirtualserviceGslbsiteinternalByUuid_GET parameters: - name: X-Avi-Tenant in: header description: Avi Tenant Header style: simple schema: type: string - name: X-Avi-Tenant-UUID in: header description: Avi Tenant Header UUID style: simple schema: type: string - name: X-CSRFToken in: header description: Avi Controller may send back CSRF token in the response cookies. The caller should update the request headers with this token else controller will reject requests. style: simple schema: type: string - name: X-Avi-Version in: header description: The caller is required to set Avi Version Header to the expected version of configuration. The response from the controller will provide and accept data according to the specified version. The controller will reject POST and PUT requests where the data is not compatible with the specified version. required: true style: simple schema: type: string - name: uuid in: path description: UUID of the object to fetch required: true style: simple schema: type: string responses: '200': description: OK headers: {} content: application/json: schema: type: string description: OK '401': description: log in failed headers: {} content: {} deprecated: false /virtualservice/{uuid}/userdefineddatascriptcounters/: get: summary: VirtualserviceUserdefineddatascriptcounters_GET description: '' operationId: VirtualserviceUserdefineddatascriptcounters_GET parameters: - name: X-Avi-Tenant in: header description: Avi Tenant Header style: simple schema: type: string - name: X-Avi-Tenant-UUID in: header description: Avi Tenant Header UUID style: simple schema: type: string - name: X-CSRFToken in: header description: Avi Controller may send back CSRF token in the response cookies. The caller should update the request headers with this token else controller will reject requests. style: simple schema: type: string - name: X-Avi-Version in: header description: The caller is required to set Avi Version Header to the expected version of configuration. The response from the controller will provide and accept data according to the specified version. The controller will reject POST and PUT requests where the data is not compatible with the specified version. required: true style: simple schema: type: string - name: uuid in: path description: UUID of the object to fetch required: true style: simple schema: type: string responses: '200': description: OK headers: {} content: application/json: schema: type: string description: OK '401': description: log in failed headers: {} content: {} deprecated: false /virtualservice/{uuid}/l4policysetstats/: get: summary: VirtualserviceL4policysetstatsByUuid_GET description: '' operationId: VirtualserviceL4policysetstatsByUuid_GET parameters: - name: X-Avi-Tenant in: header description: Avi Tenant Header style: simple schema: type: string - name: X-Avi-Tenant-UUID in: header description: Avi Tenant Header UUID style: simple schema: type: string - name: X-CSRFToken in: header description: Avi Controller may send back CSRF token in the response cookies. The caller should update the request headers with this token else controller will reject requests. style: simple schema: type: string - name: X-Avi-Version in: header description: The caller is required to set Avi Version Header to the expected version of configuration. The response from the controller will provide and accept data according to the specified version. The controller will reject POST and PUT requests where the data is not compatible with the specified version. required: true style: simple schema: type: string - name: uuid in: path description: UUID of the object to fetch required: true style: simple schema: type: string responses: '200': description: OK headers: {} content: application/json: schema: type: string description: OK '401': description: log in failed headers: {} content: {} deprecated: false /virtualservice/{uuid}/sescaleoutstatus/: get: summary: VirtualserviceSescaleoutstatusByUuid_GET description: '' operationId: VirtualserviceSescaleoutstatusByUuid_GET parameters: - name: X-Avi-Tenant in: header description: Avi Tenant Header style: simple schema: type: string - name: X-Avi-Tenant-UUID in: header description: Avi Tenant Header UUID style: simple schema: type: string - name: X-CSRFToken in: header description: Avi Controller may send back CSRF token in the response cookies. The caller should update the request headers with this token else controller will reject requests. style: simple schema: type: string - name: X-Avi-Version in: header description: The caller is required to set Avi Version Header to the expected version of configuration. The response from the controller will provide and accept data according to the specified version. The controller will reject POST and PUT requests where the data is not compatible with the specified version. required: true style: simple schema: type: string - name: uuid in: path description: UUID of the object to fetch required: true style: simple schema: type: string responses: '200': description: OK headers: {} content: application/json: schema: type: string description: OK '401': description: log in failed headers: {} content: {} deprecated: false /virtualservice/{uuid}/scaleoutstatus/: get: summary: VirtualserviceScaleoutstatusByUuid_GET description: '' operationId: VirtualserviceScaleoutstatusByUuid_GET parameters: - name: X-Avi-Tenant in: header description: Avi Tenant Header style: simple schema: type: string - name: X-Avi-Tenant-UUID in: header description: Avi Tenant Header UUID style: simple schema: type: string - name: X-CSRFToken in: header description: Avi Controller may send back CSRF token in the response cookies. The caller should update the request headers with this token else controller will reject requests. style: simple schema: type: string - name: X-Avi-Version in: header description: The caller is required to set Avi Version Header to the expected version of configuration. The response from the controller will provide and accept data according to the specified version. The controller will reject POST and PUT requests where the data is not compatible with the specified version. required: true style: simple schema: type: string - name: uuid in: path description: UUID of the object to fetch required: true style: simple schema: type: string responses: '200': description: OK headers: {} content: application/json: schema: type: string description: OK '401': description: log in failed headers: {} content: {} deprecated: false /virtualservice/{uuid}/scaleoutstatus/detail/: get: summary: VirtualserviceScaleoutstatusDetailByUuid_GET description: '' operationId: VirtualserviceScaleoutstatusDetailByUuid_GET parameters: - name: X-Avi-Tenant in: header description: Avi Tenant Header style: simple schema: type: string - name: X-Avi-Tenant-UUID in: header description: Avi Tenant Header UUID style: simple schema: type: string - name: X-CSRFToken in: header description: Avi Controller may send back CSRF token in the response cookies. The caller should update the request headers with this token else controller will reject requests. style: simple schema: type: string - name: X-Avi-Version in: header description: The caller is required to set Avi Version Header to the expected version of configuration. The response from the controller will provide and accept data according to the specified version. The controller will reject POST and PUT requests where the data is not compatible with the specified version. required: true style: simple schema: type: string - name: uuid in: path description: UUID of the object to fetch required: true style: simple schema: type: string responses: '200': description: OK headers: {} content: application/json: schema: type: string description: OK '401': description: log in failed headers: {} content: {} deprecated: false /virtualservice/{uuid}/ssopolicystats/: get: summary: VirtualserviceSsopolicystatsByUuid_GET description: '' operationId: VirtualserviceSsopolicystatsByUuid_GET parameters: - name: X-Avi-Tenant in: header description: Avi Tenant Header style: simple schema: type: string - name: X-Avi-Tenant-UUID in: header description: Avi Tenant Header UUID style: simple schema: type: string - name: X-CSRFToken in: header description: Avi Controller may send back CSRF token in the response cookies. The caller should update the request headers with this token else controller will reject requests. style: simple schema: type: string - name: X-Avi-Version in: header description: The caller is required to set Avi Version Header to the expected version of configuration. The response from the controller will provide and accept data according to the specified version. The controller will reject POST and PUT requests where the data is not compatible with the specified version. required: true style: simple schema: type: string - name: uuid in: path description: UUID of the object to fetch required: true style: simple schema: type: string responses: '200': description: OK headers: {} content: application/json: schema: type: string description: OK '401': description: log in failed headers: {} content: {} deprecated: false /ssopolicy: get: summary: Ssopolicy_GET description: '' operationId: Ssopolicy_GET parameters: - name: name in: query description: object name style: form explode: true schema: type: string - name: refers_to in: query description: Filter to request all objects that refers to another Avi resource. Its syntax is refers_to=:. Eg. get all virtual services referring to pool p1 will be refers_to=pool:pool_p1_uuid style: form explode: true schema: type: string - name: referred_by in: query description: Filter to request all objects that are referred by another Avi resource. Its syntax is referred_by=:. Eg. get all pools referred_by virtual service vs1 - referred_by=virtualservice:vs_vs1_uuid style: form explode: true schema: type: string - name: fields in: query description: List of fields to be returned for the resource. Some fields like name, URL, uuid etc. are always returned. style: form explode: true schema: type: string - name: include_name in: query description: 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. style: form explode: true schema: type: boolean - name: skip_default in: query description: Default values are not set. style: form explode: true schema: type: boolean - name: join_subresources in: query description: It automatically returns additional dependent resources like runtime. Eg. join_subresources=runtime. style: form explode: true schema: type: string - name: X-Avi-Tenant in: header description: Avi Tenant Header style: simple schema: type: string - name: X-Avi-Tenant-UUID in: header description: Avi Tenant Header UUID style: simple schema: type: string - name: X-Avi-Version in: header description: The caller is required to set Avi Version Header to the expected version of configuration. The response from the controller will provide and accept data according to the specified version. The controller will reject POST and PUT requests where the data is not compatible with the specified version. required: true style: simple schema: type: string - name: X-CSRFToken in: header description: Avi Controller may send back CSRF token in the response cookies. The caller should update the request headers with this token else controller will reject requests. style: simple schema: type: string responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/SSOPolicyApiResponse' '401': description: log in failed headers: {} content: {} deprecated: false post: summary: Ssopolicy_POST description: '' operationId: Ssopolicy_POST parameters: - name: X-Avi-Tenant in: header description: Avi Tenant Header style: simple schema: type: string - name: X-Avi-Tenant-UUID in: header description: Avi Tenant Header UUID style: simple schema: type: string - name: X-Avi-Version in: header description: The caller is required to set Avi Version Header to the expected version of configuration. The response from the controller will provide and accept data according to the specified version. The controller will reject POST and PUT requests where the data is not compatible with the specified version. required: true style: simple schema: type: string - name: X-CSRFToken in: header description: Avi Controller may send back CSRF token in the response cookies. The caller should update the request headers with this token else controller will reject requests. style: simple schema: type: string requestBody: description: SSOPolicy object creation content: application/json: schema: allOf: - $ref: '#/components/schemas/SSOPolicy' - description: SSOPolicy object creation required: true responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/SSOPolicy' '401': description: log in failed headers: {} content: {} deprecated: false /ssopolicy/{uuid}: get: summary: SsopolicyByUuid_GET description: '' operationId: SsopolicyByUuid_GET parameters: - name: name in: query description: object name style: form explode: true schema: type: string - name: X-Avi-Tenant in: header description: Avi Tenant Header style: simple schema: type: string - name: X-Avi-Tenant-UUID in: header description: Avi Tenant Header UUID style: simple schema: type: string - name: X-Avi-Version in: header description: The caller is required to set Avi Version Header to the expected version of configuration. The response from the controller will provide and accept data according to the specified version. The controller will reject POST and PUT requests where the data is not compatible with the specified version. required: true style: simple schema: type: string - name: X-CSRFToken in: header description: Avi Controller may send back CSRF token in the response cookies. The caller should update the request headers with this token else controller will reject requests. style: simple schema: type: string - name: uuid in: path description: UUID of the object to fetch required: true style: simple schema: type: string - name: fields in: query description: List of fields to be returned for the resource. Some fields like name, URL, uuid etc. are always returned. style: form explode: true schema: type: string - name: include_name in: query description: 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. style: form explode: true schema: type: boolean - name: skip_default in: query description: Default values are not set. style: form explode: true schema: type: boolean - name: join_subresources in: query description: It automatically returns additional dependent resources like runtime. Eg. join_subresources=runtime. style: form explode: true schema: type: string responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/SSOPolicy' '401': description: log in failed headers: {} content: {} deprecated: false put: summary: SsopolicyByUuid_PUT description: '' operationId: SsopolicyByUuid_PUT parameters: - name: name in: query description: object name style: form explode: true schema: type: string - name: X-Avi-Tenant in: header description: Avi Tenant Header style: simple schema: type: string - name: X-Avi-Tenant-UUID in: header description: Avi Tenant Header UUID style: simple schema: type: string - name: X-Avi-Version in: header description: The caller is required to set Avi Version Header to the expected version of configuration. The response from the controller will provide and accept data according to the specified version. The controller will reject POST and PUT requests where the data is not compatible with the specified version. required: true style: simple schema: type: string - name: X-CSRFToken in: header description: Avi Controller may send back CSRF token in the response cookies. The caller should update the request headers with this token else controller will reject requests. style: simple schema: type: string - name: uuid in: path description: UUID of the object to fetch required: true style: simple schema: type: string requestBody: description: SSOPolicy object creation content: application/json: schema: allOf: - $ref: '#/components/schemas/SSOPolicy' - description: SSOPolicy object creation required: true responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/SSOPolicy' '401': description: log in failed headers: {} content: {} deprecated: false patch: summary: SsopolicyByUuid_PATCH description: '' operationId: SsopolicyByUuid_PATCH parameters: - name: name in: query description: object name style: form explode: true schema: type: string - name: X-Avi-Tenant in: header description: Avi Tenant Header style: simple schema: type: string - name: X-Avi-Tenant-UUID in: header description: Avi Tenant Header UUID style: simple schema: type: string - name: X-Avi-Version in: header description: The caller is required to set Avi Version Header to the expected version of configuration. The response from the controller will provide and accept data according to the specified version. The controller will reject POST and PUT requests where the data is not compatible with the specified version. required: true style: simple schema: type: string - name: X-CSRFToken in: header description: Avi Controller may send back CSRF token in the response cookies. The caller should update the request headers with this token else controller will reject requests. style: simple schema: type: string - name: uuid in: path description: UUID of the object to fetch required: true style: simple schema: type: string requestBody: description: SSOPolicy object creation content: application/json: schema: allOf: - $ref: '#/components/schemas/SSOPolicy' - description: SSOPolicy object creation required: true responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/SSOPolicy' '401': description: log in failed headers: {} content: {} deprecated: false delete: summary: SsopolicyByUuid_DELETE description: '' operationId: SsopolicyByUuid_DELETE parameters: - name: name in: query description: object name style: form explode: true schema: type: string - name: X-Avi-Tenant in: header description: Avi Tenant Header style: simple schema: type: string - name: X-Avi-Tenant-UUID in: header description: Avi Tenant Header UUID style: simple schema: type: string - name: X-Avi-Version in: header description: The caller is required to set Avi Version Header to the expected version of configuration. The response from the controller will provide and accept data according to the specified version. The controller will reject POST and PUT requests where the data is not compatible with the specified version. required: true style: simple schema: type: string - name: X-CSRFToken in: header description: Avi Controller may send back CSRF token in the response cookies. The caller should update the request headers with this token else controller will reject requests. style: simple schema: type: string - name: uuid in: path description: UUID of the object to fetch required: true style: simple schema: type: string responses: '204': description: object deleted headers: {} content: application/json: schema: type: string description: object deleted '404': description: not found headers: {} content: {} deprecated: false components: schemas: AnalyticsPolicy: title: AnalyticsPolicy type: object properties: all_headers: type: boolean description: Log all headers. Field introduced in 18.1.4, 18.2.1. client_insights: type: string description: Gain insights from sampled client to server HTTP requests and responses. Enum options - NO_INSIGHTS, PASSIVE, ACTIVE. default: NO_INSIGHTS client_insights_sampling: $ref: '#/components/schemas/ClientInsightsSampling' client_log_filters: type: array items: $ref: '#/components/schemas/ClientLogFilter' description: Placeholder for description of property client_log_filters of obj type AnalyticsPolicy field type str type object enabled: type: boolean description: '[DEPRECATED] Disable Analytics on this VirtualService. This will disable the collection of both metrics and logs. Please use following fields in AnalytcsProfile to control this behavior instead. disable_vs_analytics (for VirtualServices metrics), disable_server_analytics (for Pool metrics) and client_log_config (for logs). Field deprecated in 18.2.1. Field introduced in 17.2.4.' full_client_logs: $ref: '#/components/schemas/FullClientLogs' metrics_realtime_update: $ref: '#/components/schemas/MetricsRealTimeUpdate' significant_log_throttle: type: integer description: 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 default: 10 udf_log_throttle: type: integer description: 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 default: 10 APICNetworkRel: title: APICNetworkRel type: object properties: connector: type: string description: connector of APICNetworkRel. rel_key: type: string description: rel_key of APICNetworkRel. target_network: type: string description: target_network of APICNetworkRel. ApicVSPlacementReq: title: ApicVSPlacementReq type: object properties: graph: type: string description: graph of ApicVSPlacementReq. lifs: type: array items: $ref: '#/components/schemas/Lif' description: Placeholder for description of property lifs of obj type ApicVSPlacementReq field type str type object network_rel: type: array items: $ref: '#/components/schemas/APICNetworkRel' description: Placeholder for description of property network_rel of obj type ApicVSPlacementReq field type str type object tenant_name: type: string description: tenant_name of ApicVSPlacementReq. vdev: type: string description: vdev of ApicVSPlacementReq. vgrp: type: string description: vgrp of ApicVSPlacementReq. AuthAttributeMatch: title: AuthAttributeMatch required: - attribute_name - attribute_value_list type: object properties: attribute_name: type: string description: Attribute name whose values will be looked up in the access lists. Field introduced in 18.2.5. attribute_value_list: $ref: '#/components/schemas/StringMatch' AuthenticationAction: title: AuthenticationAction required: - type type: object properties: type: type: string description: Authentication Action to be taken for a matched Rule. Enum options - SKIP_AUTHENTICATION, USE_DEFAULT_AUTHENTICATION. Field introduced in 18.2.5. example: USE_DEFAULT_AUTHENTICATION AuthenticationMatch: title: AuthenticationMatch type: object properties: client_ip: $ref: '#/components/schemas/IpAddrMatch' host_hdr: $ref: '#/components/schemas/HostHdrMatch' path: $ref: '#/components/schemas/PathMatch' AuthenticationPolicy: title: AuthenticationPolicy required: - default_auth_profile_ref type: object properties: auth_profile_ref: type: string description: Auth Profile to use for validating users. It is a reference to an object of type AuthProfile. Field deprecated in 18.2.3. Field introduced in 18.2.1. authn_rules: type: array items: $ref: '#/components/schemas/AuthenticationRule' description: Add rules to apply auth profile to specific targets. Field introduced in 18.2.5. cookie_name: type: string description: HTTP cookie name for authenticated session. Field deprecated in 18.2.3. Field introduced in 18.2.1. cookie_timeout: type: integer description: Cookie timeout in minutes. Allowed values are 1-1440. Field deprecated in 18.2.3. Field introduced in 18.2.1. format: int32 default: 60 default_auth_profile_ref: type: string description: Auth Profile to use for validating users. It is a reference to an object of type AuthProfile. Field introduced in 18.2.3. entity_id: type: string description: Globally unique entityID for this node. Entity ID on the IDP should match this. Field deprecated in 18.2.3. Field introduced in 18.2.1. key: type: array items: $ref: '#/components/schemas/HttpCookiePersistenceKey' description: Key to generate the cookie. Field deprecated in 18.2.3. Field introduced in 18.2.1. single_signon_url: type: string description: Single Signon URL to be programmed on the IDP. Field deprecated in 18.2.3. Field introduced in 18.2.1. sp_metadata: type: string description: SAML SP metadata. Field deprecated in 18.2.3. Field introduced in 18.2.1. AuthenticationRule: title: AuthenticationRule required: - enable - index - name type: object properties: action: $ref: '#/components/schemas/AuthenticationAction' enable: type: boolean description: Enable or disable the rule. Field introduced in 18.2.5. example: true index: type: integer description: Index of the rule. Field introduced in 18.2.5. format: int32 match: $ref: '#/components/schemas/AuthenticationMatch' name: type: string description: Name of the rule. Field introduced in 18.2.5. AuthorizationAction: title: AuthorizationAction type: object properties: status_code: type: string description: HTTP status code to use for local response when an policy rule is matched. Enum options - HTTP_RESPONSE_STATUS_CODE_403. Field introduced in 18.2.5. default: HTTP_RESPONSE_STATUS_CODE_403 type: type: string description: Defines the action taken when an authorization policy rule is matched.By default, access is allowed to the requested resource. Enum options - ALLOW_ACCESS, CLOSE_CONNECTION, HTTP_LOCAL_RESPONSE. Field introduced in 18.2.5. default: ALLOW_ACCESS AuthorizationMatch: title: AuthorizationMatch type: object properties: attr_matches: type: array items: $ref: '#/components/schemas/AuthAttributeMatch' description: Attributes whose values need to be matched . Field introduced in 18.2.5. host_hdr: $ref: '#/components/schemas/HostHdrMatch' method: $ref: '#/components/schemas/MethodMatch' path: $ref: '#/components/schemas/PathMatch' AuthorizationPolicy: title: AuthorizationPolicy type: object properties: authz_rules: type: array items: $ref: '#/components/schemas/AuthorizationRule' description: Authorization Policy Rules. Field introduced in 18.2.5. AuthorizationRule: title: AuthorizationRule required: - action - enable - index - match - name type: object properties: action: $ref: '#/components/schemas/AuthorizationAction' enable: type: boolean description: Enable or disable the rule. Field introduced in 18.2.5. example: true index: type: integer description: Index of the Authorization Policy rule. Field introduced in 18.2.5. format: int32 match: $ref: '#/components/schemas/AuthorizationMatch' name: type: string description: Name of the rule. Field introduced in 18.2.5. Cif: title: Cif type: object properties: adapter: type: string description: adapter of Cif. cif: type: string description: cif of Cif. mac_address: type: string description: mac_address of Cif. resources: type: array items: type: string description: resources of Cif. se_uuid: type: string description: Unique object identifier of se. ClientInsightsSampling: title: ClientInsightsSampling type: object properties: client_ip: $ref: '#/components/schemas/IpAddrMatch' sample_uris: $ref: '#/components/schemas/StringMatch' skip_uris: $ref: '#/components/schemas/StringMatch' ClientLogFilter: title: ClientLogFilter required: - enabled - index - name type: object properties: all_headers: type: boolean description: Placeholder for description of property all_headers of obj type ClientLogFilter field type str type boolean client_ip: $ref: '#/components/schemas/IpAddrMatch' duration: type: integer description: Special values are 0 - 'infinite'. format: int32 default: 30 enabled: type: boolean description: Placeholder for description of property enabled of obj type ClientLogFilter field type str type boolean index: type: integer description: Number of index. format: int32 name: type: string description: Name of the object. uri: $ref: '#/components/schemas/StringMatch' ConnectionClearFilter: title: ConnectionClearFilter type: object properties: ip_addr: type: string description: IP address in dotted decimal notation. port: type: integer description: Port number. format: int32 ContentRewriteProfile: title: ContentRewriteProfile type: object properties: req_match_replace_pair: type: array items: $ref: '#/components/schemas/MatchReplacePair' description: Strings to be matched and replaced with on the request body. request_rewrite_enabled: type: boolean description: Enable rewrite on request body. response_rewrite_enabled: type: boolean description: Enable rewrite on response body. rewritable_content_ref: type: string description: 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: type: array items: $ref: '#/components/schemas/MatchReplacePair' description: Strings to be matched and replaced with on the response body. DiscoveredNetwork: title: DiscoveredNetwork required: - network_ref type: object properties: network_ref: type: string description: Discovered network for this IP. It is a reference to an object of type Network. subnet: type: array items: $ref: '#/components/schemas/IpAddrPrefix' description: Discovered subnet for this IP. subnet6: type: array items: $ref: '#/components/schemas/IpAddrPrefix' description: Discovered IPv6 subnet for this IP. Field introduced in 18.1.1. DnsAAAARdata: title: DnsAAAARdata required: - ip6_address type: object properties: ip6_address: $ref: '#/components/schemas/IpAddr' DnsARdata: title: DnsARdata required: - ip_address type: object properties: ip_address: $ref: '#/components/schemas/IpAddr' DnsCnameRdata: title: DnsCnameRdata required: - cname type: object properties: cname: type: string description: Canonical name. DnsInfo: title: DnsInfo type: object properties: algorithm: type: string description: 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. default: DNS_RECORD_RESPONSE_CONSISTENT_HASH cname: $ref: '#/components/schemas/DnsCnameRdata' fqdn: type: string description: Fully qualified domain name. metadata: type: string description: Any metadata associated with this record. Field introduced in 17.2.2. num_records_in_response: type: integer description: 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 default: 1 ttl: type: integer description: Time to live for fqdn record. Default value is chosen from DNS profile for this cloud if no value provided. format: int32 type: type: string description: 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. default: DNS_RECORD_A DnsMxRdata: title: DnsMxRdata required: - host - priority type: object properties: host: type: string description: Fully qualified domain name of a mailserver . The host name maps directly to one or more address records in the DNS table, and must not point to any CNAME records (RFC 2181). Field introduced in 18.2.9, 20.1.1. priority: type: integer description: The priority field identifies which mail server should be preferred. Allowed values are 0-65535. Field introduced in 18.2.9, 20.1.1. format: int32 DnsNsRdata: title: DnsNsRdata required: - nsname type: object properties: ip6_address: $ref: '#/components/schemas/IpAddr' ip_address: $ref: '#/components/schemas/IpAddr' nsname: type: string description: Name Server name. Field introduced in 17.1.1. DnsPolicies: title: DnsPolicies required: - dns_policy_ref - index type: object properties: dns_policy_ref: type: string description: UUID of the dns policy. It is a reference to an object of type DnsPolicy. Field introduced in 17.1.1. index: type: integer description: Index of the dns policy. Field introduced in 17.1.1. format: int32 DnsRecord: title: DnsRecord required: - type type: object properties: algorithm: type: string description: 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. default: DNS_RECORD_RESPONSE_ROUND_ROBIN cname: $ref: '#/components/schemas/DnsCnameRdata' delegated: type: boolean description: Configured FQDNs are delegated domains (i.e. they represent a zone cut). Field introduced in 17.1.2. description: type: string description: Details of DNS record. fqdn: type: array items: type: string description: Fully Qualified Domain Name. ip6_address: type: array items: $ref: '#/components/schemas/DnsAAAARdata' description: IPv6 address in AAAA record. Field introduced in 18.1.1. ip_address: type: array items: $ref: '#/components/schemas/DnsARdata' description: IP address in A record. metadata: type: string description: Internal metadata for the DNS record. Field introduced in 18.2.5. mx_records: type: array items: $ref: '#/components/schemas/DnsMxRdata' description: MX record. Field introduced in 18.2.9, 20.1.1. ns: type: array items: $ref: '#/components/schemas/DnsNsRdata' description: Name Server information in NS record. Field introduced in 17.1.1. num_records_in_response: type: integer description: 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: type: array items: $ref: '#/components/schemas/DnsSrvRdata' description: Service locator info in SRV record. ttl: type: integer description: Time To Live for this DNS record. format: int32 txt_records: type: array items: $ref: '#/components/schemas/DnsTxtRdata' description: Text record. Field introduced in 18.2.9, 20.1.1. type: type: string description: 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: type: boolean description: 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: title: DnsSrvRdata required: - port type: object properties: port: type: integer description: Service port. Allowed values are 0-65535. format: int32 priority: type: integer description: Priority of the target hosting the service, low value implies higher priority for this service record. Allowed values are 0-65535. format: int32 target: type: string description: Canonical hostname, of the machine hosting the service, with no trailing period. 'default.host' is valid but not 'default.host.'. default: default.host weight: type: integer description: Relative weight for service records with same priority, high value implies higher preference for this service record. Allowed values are 0-65535. format: int32 DnsTxtRdata: title: DnsTxtRdata required: - text_str type: object properties: text_str: type: string description: Text data associated with the FQDN. Field introduced in 18.2.9, 20.1.1. FullClientLogs: title: FullClientLogs required: - enabled type: object properties: all_headers: type: boolean description: '[DEPRECATED] Log all headers. Please use the all_headers flag in AnalyticsPolicy. Field deprecated in 18.1.4, 18.2.1.' duration: type: integer description: How long should the system capture all logs, measured in minutes. Set to 0 for infinite. Special values are 0 - 'infinite'. format: int32 default: 30 enabled: type: boolean description: Capture all client logs including connections and requests. When disabled, only errors will be logged. throttle: type: integer description: 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 default: 10 HostHdrMatch: title: HostHdrMatch required: - match_criteria type: object properties: match_case: type: string description: Case sensitivity to use for the match. Enum options - SENSITIVE, INSENSITIVE. default: INSENSITIVE match_criteria: type: string description: Criterion to use for the host header value match. Enum options - HDR_EXISTS, HDR_DOES_NOT_EXIST, HDR_BEGINS_WITH, HDR_DOES_NOT_BEGIN_WITH, HDR_CONTAINS, HDR_DOES_NOT_CONTAIN, HDR_ENDS_WITH, HDR_DOES_NOT_END_WITH, HDR_EQUALS, HDR_DOES_NOT_EQUAL. value: type: array items: type: string description: String value(s) in the host header. HTTPClientAuthenticationParams: title: HTTPClientAuthenticationParams type: object properties: auth_profile_ref: type: string description: Auth Profile to use for validating users. It is a reference to an object of type AuthProfile. realm: type: string description: Basic authentication realm to present to a user along with the prompt for credentials. request_uri_path: $ref: '#/components/schemas/StringMatch' type: type: string description: type of client authentication. Enum options - HTTP_BASIC_AUTH. HttpCookiePersistenceKey: title: HttpCookiePersistenceKey type: object properties: aes_key: type: string description: aes_key of HttpCookiePersistenceKey. hmac_key: type: string description: hmac_key of HttpCookiePersistenceKey. name: type: string description: name to use for cookie encryption. HTTPLocalFile: title: HTTPLocalFile required: - content_type - file_content type: object properties: content_type: type: string description: Mime-type of the content in the file. file_content: type: string description: File content to used in the local HTTP response body. HTTPPolicies: title: HTTPPolicies required: - http_policy_set_ref - index type: object properties: http_policy_set_ref: type: string description: UUID of the virtual service HTTP policy collection. It is a reference to an object of type HTTPPolicySet. index: type: integer description: Index of the virtual service HTTP policy collection. format: int32 HTTPRedirectAction: title: HTTPRedirectAction required: - protocol type: object properties: host: $ref: '#/components/schemas/URIParam' keep_query: type: boolean description: Keep or drop the query of the incoming request URI in the redirected URI. default: true path: $ref: '#/components/schemas/URIParam' port: type: integer description: Port to which redirect the request. Allowed values are 1-65535. format: int32 protocol: type: string description: Protocol type. Enum options - HTTP, HTTPS. status_code: type: string description: HTTP redirect status code. Enum options - HTTP_REDIRECT_STATUS_CODE_301, HTTP_REDIRECT_STATUS_CODE_302, HTTP_REDIRECT_STATUS_CODE_307. default: HTTP_REDIRECT_STATUS_CODE_302 IpAddr: title: IpAddr required: - addr - type type: object properties: addr: type: string description: IP address. type: type: string description: Enum options - V4, DNS, V6. IpAddrMatch: title: IpAddrMatch required: - match_criteria type: object properties: addrs: type: array items: $ref: '#/components/schemas/IpAddr' description: IP address(es). group_refs: type: array items: type: string description: UUID of IP address group(s). It is a reference to an object of type IpAddrGroup. match_criteria: type: string description: Criterion to use for IP address matching the HTTP request. Enum options - IS_IN, IS_NOT_IN. prefixes: type: array items: $ref: '#/components/schemas/IpAddrPrefix' description: IP address prefix(es). ranges: type: array items: $ref: '#/components/schemas/IpAddrRange' description: IP address range(s). IpAddrPrefix: title: IpAddrPrefix required: - ip_addr - mask type: object properties: ip_addr: $ref: '#/components/schemas/IpAddr' mask: type: integer description: Number of mask. format: int32 IpAddrRange: title: IpAddrRange required: - begin - end type: object properties: begin: $ref: '#/components/schemas/IpAddr' end: $ref: '#/components/schemas/IpAddr' IPNetworkSubnet: title: IPNetworkSubnet type: object properties: network_ref: type: string description: 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: $ref: '#/components/schemas/IpAddrPrefix' subnet6: $ref: '#/components/schemas/IpAddrPrefix' subnet6_uuid: type: string description: Subnet UUID or Name or Prefix for VirtualService IPv6 allocation with AWS or OpenStack as the IPAM provider. Only one of subnet or subnet_uuid configuration is allowed. Field introduced in 18.1.1. subnet_uuid: type: string description: 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. L4Policies: title: L4Policies required: - index - l4_policy_set_ref type: object properties: index: type: integer description: Index of the virtual service L4 policy set. Field introduced in 17.2.7. format: int32 l4_policy_set_ref: type: string description: ID of the virtual service L4 policy set. It is a reference to an object of type L4PolicySet. Field introduced in 17.2.7. Lif: title: Lif type: object properties: cifs: type: array items: $ref: '#/components/schemas/Cif' description: Placeholder for description of property cifs of obj type Lif field type str type object lif: type: string description: lif of Lif. lif_label: type: string description: lif_label of Lif. subnet: type: string description: subnet of Lif. MatchReplacePair: title: MatchReplacePair required: - match_string type: object properties: match_string: type: string description: String to be matched. replacement_string: $ref: '#/components/schemas/ReplaceStringVar' MethodMatch: title: MethodMatch required: - match_criteria type: object properties: match_criteria: type: string description: Criterion to use for HTTP method matching the method in the HTTP request. Enum options - IS_IN, IS_NOT_IN. methods: type: array items: type: string description: Configure HTTP method(s). Enum options - HTTP_METHOD_GET, HTTP_METHOD_HEAD, HTTP_METHOD_PUT, HTTP_METHOD_DELETE, HTTP_METHOD_POST, HTTP_METHOD_OPTIONS, HTTP_METHOD_TRACE, HTTP_METHOD_CONNECT, HTTP_METHOD_PATCH, HTTP_METHOD_PROPFIND, HTTP_METHOD_PROPPATCH, HTTP_METHOD_MKCOL, HTTP_METHOD_COPY, HTTP_METHOD_MOVE, HTTP_METHOD_LOCK, HTTP_METHOD_UNLOCK. MetricsRealTimeUpdate: title: MetricsRealTimeUpdate required: - enabled type: object properties: duration: type: integer description: Real time metrics collection duration in minutes. 0 for infinite. Special values are 0 - 'infinite'. format: int32 default: 30 enabled: type: boolean description: Enables real time metrics collection. When disabled, 6 hour view is the most granular the system will track. PathMatch: title: PathMatch required: - match_criteria type: object properties: match_case: type: string description: Case sensitivity to use for the matching. Enum options - SENSITIVE, INSENSITIVE. default: INSENSITIVE match_criteria: type: string description: Criterion to use for matching the path in the HTTP request URI. Enum options - BEGINS_WITH, DOES_NOT_BEGIN_WITH, CONTAINS, DOES_NOT_CONTAIN, ENDS_WITH, DOES_NOT_END_WITH, EQUALS, DOES_NOT_EQUAL, REGEX_MATCH, REGEX_DOES_NOT_MATCH. example: CONTAINS match_str: type: array items: type: string description: String values. string_group_refs: type: array items: type: string description: UUID of the string group(s). It is a reference to an object of type StringGroup. PerformanceLimits: title: PerformanceLimits type: object properties: max_concurrent_connections: type: integer description: The maximum number of concurrent client conections allowed to the Virtual Service. format: int32 max_throughput: type: integer description: The maximum throughput per second for all clients allowed through the client side of the Virtual Service. format: int32 RateLimiter: title: RateLimiter required: - count - period type: object properties: burst_sz: type: integer description: Maximum number of connections, requests or packets to be let through instantaneously. If this is less than count, it will have no effect. Allowed values are 0-1000000000. Field introduced in 18.2.9. format: int32 count: type: integer description: Maximum number of connections, requests or packets permitted each period. Allowed values are 1-1000000000. Field introduced in 18.2.9. format: int32 example: 1000000000 name: type: string description: Identifier for Rate Limit. Constructed according to context. Field introduced in 18.2.9. period: type: integer description: Time value in seconds to enforce rate count. Allowed values are 1-1000000000. Field introduced in 18.2.9. format: int32 example: 1 RateLimiterAction: title: RateLimiterAction type: object properties: file: $ref: '#/components/schemas/HTTPLocalFile' redirect: $ref: '#/components/schemas/HTTPRedirectAction' status_code: type: string description: HTTP status code for Local Response rate limit action. Enum options - HTTP_LOCAL_RESPONSE_STATUS_CODE_200, HTTP_LOCAL_RESPONSE_STATUS_CODE_204, HTTP_LOCAL_RESPONSE_STATUS_CODE_403, HTTP_LOCAL_RESPONSE_STATUS_CODE_404, HTTP_LOCAL_RESPONSE_STATUS_CODE_429, HTTP_LOCAL_RESPONSE_STATUS_CODE_501. default: HTTP_LOCAL_RESPONSE_STATUS_CODE_429 type: type: string description: 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. default: RL_ACTION_NONE RateProfile: title: RateProfile required: - action type: object properties: action: $ref: '#/components/schemas/RateLimiterAction' burst_sz: type: integer description: Maximum number of connections or requests or packets to be let through instantaneously. Allowed values are 10-2500. Special values are 0- 'automatic'. Field deprecated in 18.2.9. format: int32 count: type: integer description: Maximum number of connections or requests or packets. Allowed values are 1-1000000000. Special values are 0- 'unlimited'. Field deprecated in 18.2.9. format: int32 explicit_tracking: type: boolean description: Explicitly tracks an attacker across rate periods. fine_grain: type: boolean description: Enable fine granularity. http_cookie: type: string description: HTTP cookie name. Field introduced in 17.1.1. http_header: type: string description: HTTP header name. Field introduced in 17.1.1. period: type: integer description: Time value in seconds to enforce rate count. Allowed values are 1-300. Field deprecated in 18.2.9. format: int32 rate_limiter: $ref: '#/components/schemas/RateLimiter' ReplaceStringVar: title: ReplaceStringVar type: object properties: type: type: string description: 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: type: string description: Value of the replacement string - name of variable exposed from datascript, name of the HTTP header or a custom user-input literal string. RetryPlacementParams: title: RetryPlacementParams required: - vip_id type: object properties: all_east_west: type: boolean description: Retry placement operations for all East-West services. Field introduced in 17.1.6,17.2.2. uuid: type: string description: Unique object identifier of the object. vip_id: type: string description: Indicates the vip_id that needs placement retrial. Field introduced in 17.1.2. SAMLSPConfig: title: SAMLSPConfig required: - entity_id - single_signon_url type: object properties: cookie_name: type: string description: HTTP cookie name for authenticated session. Field introduced in 18.2.3. cookie_timeout: type: integer description: Cookie timeout in minutes. Allowed values are 1-1440. Field introduced in 18.2.3. format: int32 default: 60 entity_id: type: string description: Globally unique SAML entityID for this node. The SAML application entity ID on the IDP should match this. Field introduced in 18.2.3. key: type: array items: $ref: '#/components/schemas/HttpCookiePersistenceKey' description: Key to generate the cookie. Field introduced in 18.2.3. signing_ssl_key_and_certificate_ref: type: string description: SP will use this SSL certificate to sign requests going to the IdP and decrypt the assertions coming from IdP. It is a reference to an object of type SSLKeyAndCertificate. Field introduced in 18.2.3. single_signon_url: type: string description: SAML Single Signon URL to be programmed on the IDP. Field introduced in 18.2.3. sp_metadata: type: string description: SAML SP metadata for this application. Field introduced in 18.2.3. use_idp_session_timeout: type: boolean description: By enabling this field IdP can control how long the SP session can exist through the SessionNotOnOrAfter field in the AuthNStatement of SAML Response. Field introduced in 20.1.1. Service: title: Service required: - port type: object properties: enable_http2: type: boolean description: Enable HTTP2 on this port. Field introduced in 20.1.1. enable_ssl: type: boolean description: Enable SSL termination and offload for traffic from clients. override_application_profile_ref: type: string description: 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: type: string description: Override the network profile for this specific service port. It is a reference to an object of type NetworkProfile. port: type: integer description: The Virtual Service's port number. Allowed values are 0-65535. format: int32 port_range_end: type: integer description: The end of the Virtual Service's port number range. Allowed values are 1-65535. Special values are 0- 'single port'. format: int32 ServicePoolSelector: title: ServicePoolSelector required: - service_port type: object properties: service_pool_group_ref: type: string description: It is a reference to an object of type PoolGroup. service_pool_ref: type: string description: It is a reference to an object of type Pool. service_port: type: integer description: Pool based destination port. Allowed values are 1-65535. format: int32 service_port_range_end: type: integer description: 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: type: string description: Destination protocol to match for the pool selection. If not specified, it will match any protocol. Enum options - PROTOCOL_TYPE_TCP_PROXY, PROTOCOL_TYPE_TCP_FAST_PATH, PROTOCOL_TYPE_UDP_FAST_PATH, PROTOCOL_TYPE_UDP_PROXY. SidebandProfile: title: SidebandProfile type: object properties: ip: type: array items: $ref: '#/components/schemas/IpAddr' description: IP Address of the sideband server. sideband_max_request_body_size: type: integer description: Maximum size of the request body that will be sent on the sideband. Allowed values are 0-16384. format: int32 default: 1024 SSLCacheFilter: title: SSLCacheFilter type: object properties: ssl_session_id: type: string description: Hexadecimal representation of the SSL session ID. Field introduced in 20.1.1. SSLProfileSelector: title: SSLProfileSelector required: - client_ip_list - ssl_profile_ref type: object properties: client_ip_list: $ref: '#/components/schemas/IpAddrMatch' ssl_profile_ref: type: string description: SSL profile for the client IP addresses listed. It is a reference to an object of type SSLProfile. Field introduced in 18.2.3. SSOPolicy: title: SSOPolicy required: - authentication_policy - name - type type: object properties: _last_modified: type: string description: UNIX time since epoch in microseconds. Units(MICROSECONDS). authentication_policy: $ref: '#/components/schemas/AuthenticationPolicy' authorization_policy: $ref: '#/components/schemas/AuthorizationPolicy' name: type: string description: Name of the SSO Policy. Field introduced in 18.2.3. tenant_ref: type: string description: UUID of the Tenant. It is a reference to an object of type Tenant. Field introduced in 18.2.3. type: type: string description: SSO Policy Type. Enum options - SSO_TYPE_SAML, SSO_TYPE_PINGACCESS. Field introduced in 18.2.5. example: SSO_TYPE_SAML url: type: string description: url uuid: type: string description: UUID of the SSO Policy. Field introduced in 18.2.3. SSOPolicyApiResponse: title: SSOPolicyApiResponse required: - count - results type: object properties: count: type: integer format: int32 results: type: array items: $ref: '#/components/schemas/SSOPolicy' description: '' next: type: string StringMatch: title: StringMatch required: - match_criteria type: object properties: match_criteria: type: string description: 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: type: array items: type: string description: String value(s). string_group_refs: type: array items: type: string description: UUID of the string group(s). It is a reference to an object of type StringGroup. URIParam: title: URIParam required: - type type: object properties: tokens: type: array items: $ref: '#/components/schemas/URIParamToken' description: Token config either for the URI components or a constant string. type: type: string description: URI param type. Enum options - URI_PARAM_TYPE_TOKENIZED. URIParamToken: title: URIParamToken required: - type type: object properties: end_index: type: integer description: 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: type: integer description: Index of the starting token in the incoming URI. format: int32 str_value: type: string description: Constant string to use as a token. type: type: string description: 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. Vip: title: Vip required: - vip_id type: object properties: auto_allocate_floating_ip: type: boolean description: Auto-allocate floating/elastic IP from the Cloud infrastructure. Field introduced in 17.1.1. auto_allocate_ip: type: boolean description: Auto-allocate VIP from the provided subnet. Field introduced in 17.1.1. auto_allocate_ip_type: type: string description: Specifies whether to auto-allocate only a V4 address, only a V6 address, or one of each type. Enum options - V4_ONLY, V6_ONLY, V4_V6. Field introduced in 18.1.1. default: V4_ONLY availability_zone: type: string description: Availability-zone to place the Virtual Service. Field introduced in 17.1.1. avi_allocated_fip: type: boolean description: (internal-use) FIP allocated by Avi in the Cloud infrastructure. Field introduced in 17.1.1. avi_allocated_vip: type: boolean description: (internal-use) VIP allocated by Avi in the Cloud infrastructure. Field introduced in 17.1.1. discovered_networks: type: array items: $ref: '#/components/schemas/DiscoveredNetwork' description: Discovered networks providing reachability for client facing Vip IP. Field introduced in 17.1.1. enabled: type: boolean description: Enable or disable the Vip. Field introduced in 17.1.1. default: true floating_ip: $ref: '#/components/schemas/IpAddr' floating_ip6: $ref: '#/components/schemas/IpAddr' floating_subnet6_uuid: type: string description: If auto_allocate_floating_ip is True and more than one floating-ip subnets exist, then the subnet for the floating IPv6 address allocation. Field introduced in 18.1.1. floating_subnet_uuid: type: string description: If auto_allocate_floating_ip is True and more than one floating-ip subnets exist, then the subnet for the floating IP address allocation. Field introduced in 17.1.1. ip6_address: $ref: '#/components/schemas/IpAddr' ip_address: $ref: '#/components/schemas/IpAddr' ipam_network_subnet: $ref: '#/components/schemas/IPNetworkSubnet' network_ref: type: string description: Manually override the network on which the Vip is placed. It is a reference to an object of type Network. Field introduced in 17.1.1. placement_networks: type: array items: $ref: '#/components/schemas/VipPlacementNetwork' description: Placement networks/subnets to use for vip placement. Field introduced in 18.2.5. port_uuid: type: string description: (internal-use) Network port assigned to the Vip IP address. Field introduced in 17.1.1. prefix_length: type: integer description: Mask applied for the Vip, non-default mask supported only for wildcard Vip. Allowed values are 0-32. Field introduced in 20.1.1. format: int32 default: 32 subnet: $ref: '#/components/schemas/IpAddrPrefix' subnet6: $ref: '#/components/schemas/IpAddrPrefix' subnet6_uuid: type: string description: If auto_allocate_ip is True, then the subnet for the Vip IPv6 address allocation. This field is applicable only if the VirtualService belongs to an Openstack or AWS cloud, in which case it is mandatory, if auto_allocate is selected. Field introduced in 18.1.1. subnet_uuid: type: string description: If auto_allocate_ip is True, then the subnet for the Vip IP address allocation. This field is applicable only if the VirtualService belongs to an Openstack or AWS cloud, in which case it is mandatory, if auto_allocate is selected. Field introduced in 17.1.1. vip_id: type: string description: Unique ID associated with the vip. Field introduced in 17.1.1. VipPlacementNetwork: title: VipPlacementNetwork type: object properties: network_ref: type: string description: Network to use for vip placement. It is a reference to an object of type Network. Field introduced in 18.2.5. subnet: $ref: '#/components/schemas/IpAddrPrefix' subnet6: $ref: '#/components/schemas/IpAddrPrefix' VirtualService: title: VirtualService required: - name type: object properties: _last_modified: type: string description: UNIX time since epoch in microseconds. Units(MICROSECONDS). active_standby_se_tag: type: string description: 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. default: ACTIVE_STANDBY_SE_1 advertise_down_vs: type: boolean description: Keep advertising Virtual Service via BGP even if it is marked down by health monitor. This setting takes effect for future Virtual Service flaps. To advertise current VSes that are down, please disable and re-enable the Virtual Service. Field introduced in 20.1.1. allow_invalid_client_cert: type: boolean description: Process request even if invalid client certificate is presented. Datascript APIs need to be used for processing of such requests. Field introduced in 18.2.3. analytics_policy: $ref: '#/components/schemas/AnalyticsPolicy' analytics_profile_ref: type: string description: Specifies settings related to analytics. It is a reference to an object of type AnalyticsProfile. apic_contract_graph: type: string description: The name of the Contract/Graph associated with the Virtual Service. Should be in the format. This is applicable only for Service Integration mode with Cisco APIC Controller . Field introduced in 17.2.12,18.1.2. application_profile_ref: type: string description: Enable application layer specific features for the Virtual Service. It is a reference to an object of type ApplicationProfile. auto_allocate_floating_ip: type: boolean description: Auto-allocate floating/elastic IP from the Cloud infrastructure. Field deprecated in 17.1.1. auto_allocate_ip: type: boolean description: Auto-allocate VIP from the provided subnet. Field deprecated in 17.1.1. availability_zone: type: string description: Availability-zone to place the Virtual Service. Field deprecated in 17.1.1. avi_allocated_fip: type: boolean description: (internal-use) FIP allocated by Avi in the Cloud infrastructure. Field deprecated in 17.1.1. avi_allocated_vip: type: boolean description: (internal-use) VIP allocated by Avi in the Cloud infrastructure. Field deprecated in 17.1.1. azure_availability_set: type: string description: (internal-use)Applicable for Azure only. Azure Availability set to which this VS is associated. Internally set by the cloud connector. Field introduced in 17.2.12, 18.1.2. bulk_sync_kvcache: type: boolean description: (This is a beta feature). Sync Key-Value cache to the new SEs when VS is scaled out. For ex SSL sessions are stored using VS's Key-Value cache. When the VS is scaled out, the SSL session information is synced to the new SE, allowing existing SSL sessions to be reused on the new SE. . Field introduced in 17.2.7, 18.1.1. client_auth: $ref: '#/components/schemas/HTTPClientAuthenticationParams' close_client_conn_on_config_update: type: boolean description: close client connection on vs config update. Field introduced in 17.2.4. cloud_config_cksum: type: string description: Checksum of cloud configuration for VS. Internally set by cloud connector. cloud_ref: type: string description: It is a reference to an object of type Cloud. cloud_type: type: string description: Enum options - CLOUD_NONE, CLOUD_VCENTER, CLOUD_OPENSTACK, CLOUD_AWS, CLOUD_VCA, CLOUD_APIC, CLOUD_MESOS, CLOUD_LINUXSERVER, CLOUD_DOCKER_UCP, CLOUD_RANCHER, CLOUD_OSHIFT_K8S, CLOUD_AZURE, CLOUD_GCP, CLOUD_NSXT. default: CLOUD_NONE connections_rate_limit: $ref: '#/components/schemas/RateProfile' content_rewrite: $ref: '#/components/schemas/ContentRewriteProfile' created_by: type: string description: Creator name. delay_fairness: type: boolean description: 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: type: string description: User defined description for the object. discovered_network_ref: type: array items: type: string description: (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: type: array items: $ref: '#/components/schemas/DiscoveredNetwork' description: (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: type: array items: $ref: '#/components/schemas/IpAddrPrefix' description: (internal-use) Discovered subnets providing reachability for client facing Virtual Service IP. This field is deprecated. Field deprecated in 17.1.1. dns_info: type: array items: $ref: '#/components/schemas/DnsInfo' description: 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: type: array items: $ref: '#/components/schemas/DnsPolicies' description: DNS Policies applied on the dns traffic of the Virtual Service. Field introduced in 17.1.1. east_west_placement: type: boolean description: Force placement on all SE's in service group (Mesos mode only). enable_autogw: type: boolean description: Response traffic to clients will be sent back to the source MAC address of the connection, rather than statically sent to a default gateway. default: true enable_rhi: type: boolean description: Enable Route Health Injection using the BGP Config in the vrf context. enable_rhi_snat: type: boolean description: Enable Route Health Injection for Source NAT'ted floating IP Address using the BGP Config in the vrf context. enabled: type: boolean description: Enable or disable the Virtual Service. default: true error_page_profile_ref: type: string description: 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: $ref: '#/components/schemas/IpAddr' floating_subnet_uuid: type: string description: If auto_allocate_floating_ip is True and more than one floating-ip subnets exist, then the subnet for the floating IP address allocation. 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: type: string description: Criteria for flow distribution among SEs. Enum options - LOAD_AWARE, CONSISTENT_HASH_SOURCE_IP_ADDRESS, CONSISTENT_HASH_SOURCE_IP_ADDRESS_AND_PORT. default: LOAD_AWARE flow_label_type: type: string description: Criteria for flow labelling. Enum options - NO_LABEL, APPLICATION_LABEL, SERVICE_LABEL. default: NO_LABEL fqdn: type: string description: DNS resolvable, fully qualified domain name of the virtualservice. Only one of 'fqdn' and 'dns_info' configuration is allowed. host_name_xlate: type: string description: 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: type: array items: $ref: '#/components/schemas/HTTPPolicies' description: HTTP Policies applied on the data traffic of the Virtual Service. icap_request_profile_refs: type: array items: type: string description: The config settings for the ICAP server when checking the HTTP request. It is a reference to an object of type IcapProfile. Field introduced in 20.1.1. ign_pool_net_reach: type: boolean description: Ignore Pool servers network reachability constraints for Virtual Service placement. ip_address: $ref: '#/components/schemas/IpAddr' ipam_network_subnet: $ref: '#/components/schemas/IPNetworkSubnet' l4_policies: type: array items: $ref: '#/components/schemas/L4Policies' description: L4 Policies applied to the data traffic of the Virtual Service. Field introduced in 17.2.7. limit_doser: type: boolean description: 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: type: integer description: Maximum connections per second per client IP. Allowed values are 10-1000. Special values are 0- 'unlimited'. format: int32 microservice_ref: type: string description: Microservice representing the virtual service. It is a reference to an object of type MicroService. min_pools_up: type: integer description: Minimum number of UP pools to mark VS up. Field introduced in 18.2.1, 17.2.12. format: int32 name: type: string description: Name for the Virtual Service. network_profile_ref: type: string description: 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: type: string description: 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: type: string description: Network security policies for the Virtual Service. It is a reference to an object of type NetworkSecurityPolicy. nsx_securitygroup: type: array items: type: string description: 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: $ref: '#/components/schemas/PerformanceLimits' pool_group_ref: type: string description: The pool group is an object that contains pools. It is a reference to an object of type PoolGroup. pool_ref: type: string description: 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: type: string description: (internal-use) Network port assigned to the Virtual Service IP address. Field deprecated in 17.1.1. remove_listening_port_on_vs_down: type: boolean description: Remove listening port if VirtualService is down. requests_rate_limit: $ref: '#/components/schemas/RateProfile' saml_sp_config: $ref: '#/components/schemas/SAMLSPConfig' scaleout_ecmp: type: boolean description: 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: type: string description: The Service Engine Group to use for this Virtual Service. Moving to a new SE Group is disruptive to existing connections for this VS. It is a reference to an object of type ServiceEngineGroup. security_policy_ref: type: string description: Security policy applied on the traffic of the Virtual Service. This policy is used to perform security actions such as Distributed Denial of Service (DDoS) attack mitigation, etc. It is a reference to an object of type SecurityPolicy. Field introduced in 18.2.1. server_network_profile_ref: type: string description: 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: type: string description: 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: type: array items: $ref: '#/components/schemas/ServicePoolSelector' description: Select pool based on destination port. services: type: array items: $ref: '#/components/schemas/Service' description: List of Services defined for this Virtual Service. sideband_profile: $ref: '#/components/schemas/SidebandProfile' snat_ip: type: array items: $ref: '#/components/schemas/IpAddr' description: NAT'ted floating source IP Address(es) for upstream connection to servers. sp_pool_refs: type: array items: type: string description: GSLB pools used to manage site-persistence functionality. Each site-persistence pool contains the virtualservices in all the other sites, that is auto-generated by the GSLB manager. This is a read-only field for the user. It is a reference to an object of type Pool. Field introduced in 17.2.2. ssl_key_and_certificate_refs: type: array items: type: string description: 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: type: string description: Determines the set of SSL versions and ciphers to accept for SSL/TLS terminated connections. It is a reference to an object of type SSLProfile. ssl_profile_selectors: type: array items: $ref: '#/components/schemas/SSLProfileSelector' description: Select SSL Profile based on client IP address match. Field introduced in 18.2.3. ssl_sess_cache_avg_size: type: integer description: Expected number of SSL session cache entries (may be exceeded). Allowed values are 1024-16383. format: int32 default: 1024 sso_policy: $ref: '#/components/schemas/SSOPolicy' sso_policy_ref: type: string description: The SSO Policy attached to the virtualservice. It is a reference to an object of type SSOPolicy. Field introduced in 18.2.3. static_dns_records: type: array items: $ref: '#/components/schemas/DnsRecord' description: 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: $ref: '#/components/schemas/IpAddrPrefix' subnet_uuid: type: string description: 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: type: string description: It is a reference to an object of type Tenant. test_se_datastore_level_1_ref: type: string description: Used for testing SE Datastore Upgrade 2.0 functionality. It is a reference to an object of type TestSeDatastoreLevel1. Field introduced in 18.2.6. topology_policies: type: array items: $ref: '#/components/schemas/DnsPolicies' description: Topology Policies applied on the dns traffic of the Virtual Service based onGSLB Topology algorithm. Field introduced in 18.2.3. traffic_clone_profile_ref: type: string description: 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. traffic_enabled: type: boolean description: Knob to enable the Virtual Service traffic on its assigned service engines. This setting is effective only when the enabled flag is set to True. Field introduced in 17.2.8. default: true type: type: string description: 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. default: VS_TYPE_NORMAL url: type: string description: url use_bridge_ip_as_vip: type: boolean description: Use Bridge IP as VIP on each Host in Mesos deployments. use_vip_as_snat: type: boolean description: 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: type: string description: UUID of the VirtualService. vh_domain_name: type: array items: type: string description: 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: type: string description: Specifies the Virtual Service acting as Virtual Hosting (SNI) parent. vip: type: array items: $ref: '#/components/schemas/Vip' description: 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: type: string description: 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: type: array items: $ref: '#/components/schemas/VSDataScripts' description: Datascripts applied on the data traffic of the Virtual Service. vsvip_cloud_config_cksum: type: string description: Checksum of cloud configuration for VsVip. Internally set by cloud connector. Field introduced in 17.2.9, 18.1.2. vsvip_ref: type: string description: Mostly used during the creation of Shared VS, this field refers to entities that can be shared across Virtual Services. It is a reference to an object of type VsVip. Field introduced in 17.1.1. waf_policy_ref: type: string description: WAF policy for the Virtual Service. It is a reference to an object of type WafPolicy. Field introduced in 17.2.1. weight: type: integer description: The Quality of Service weight to assign to traffic transmitted from this Virtual Service. A higher weight will prioritize traffic versus other Virtual Services sharing the same Service Engines. Allowed values are 1-128. format: int32 default: 1 VirtualServiceApiResponse: title: VirtualServiceApiResponse required: - count - results type: object properties: count: type: integer format: int32 results: type: array items: $ref: '#/components/schemas/VirtualService' description: '' next: type: string VSDataScripts: title: VSDataScripts required: - index - vs_datascript_set_ref type: object properties: index: type: integer description: Index of the virtual service datascript collection. format: int32 vs_datascript_set_ref: type: string description: UUID of the virtual service datascript collection. It is a reference to an object of type VSDataScriptSet. VsMigrateParams: title: VsMigrateParams required: - vip_id type: object properties: from_se_ref: type: string description: It is a reference to an object of type ServiceEngine. new_vcpus: type: integer description: Number of new_vcpus. format: int32 to_host_ref: type: string description: It is a reference to an object of type VIMgrHostRuntime. to_new_se: type: boolean description: Placeholder for description of property to_new_se of obj type VsMigrateParams field type str type boolean to_se_ref: type: string description: It is a reference to an object of type ServiceEngine. uuid: type: string description: Unique object identifier of the object. vip_id: type: string description: Field introduced in 17.1.1. VsResyncParams: title: VsResyncParams type: object properties: se_ref: type: array items: type: string description: It is a reference to an object of type ServiceEngine. uuid: type: string description: Unique object identifier of the object. VsScaleinParams: title: VsScaleinParams required: - vip_id type: object properties: admin_down: type: boolean description: Placeholder for description of property admin_down of obj type VsScaleinParams field type str type boolean from_se_ref: type: string description: It is a reference to an object of type ServiceEngine. scalein_primary: type: boolean description: Placeholder for description of property scalein_primary of obj type VsScaleinParams field type str type boolean uuid: type: string description: Unique object identifier of the object. vip_id: type: string description: Field introduced in 17.1.1. VsScaleoutParams: title: VsScaleoutParams required: - vip_id type: object properties: admin_up: type: boolean description: Placeholder for description of property admin_up of obj type VsScaleoutParams field type str type boolean new_vcpus: type: integer description: Number of new_vcpus. format: int32 to_host_ref: type: string description: It is a reference to an object of type VIMgrHostRuntime. to_new_se: type: boolean description: Placeholder for description of property to_new_se of obj type VsScaleoutParams field type str type boolean to_se_ref: type: string description: It is a reference to an object of type ServiceEngine. uuid: type: string description: Unique object identifier of the object. vip_id: type: string description: Field introduced in 17.1.1. VsSwitchoverParams: title: VsSwitchoverParams required: - vip_id type: object properties: se_uuid: type: string description: Unique object identifier of se. uuid: type: string description: Unique object identifier of the object. vip_id: type: string description: Field introduced in 17.1.1. securitySchemes: httpBasic: type: http scheme: basic security: - httpBasic: [] tags: []