Virtual Service APIs

Virtual Service APIs

Avi VirtualService object api

- configure virtualservice <key>
- show virtualservice <key>
- scaleout virtualservice <key>
- scalein virtualservice <key>
- migrate virtualservice <key>
- switchover virtualservice <key>
- clear virtualservice <key>
- resync virtualservice <key>
- rotatekeys virtualservice <key>
- apicplacement virtualservice <key>
- retryplacement virtualservice <key>
- logrecommendation virtualservice <key>
- applylogrecommendation virtualservice <key>

Examples

  • virtualservice_example_1: To create a basic virtualservice object that has both http and https enabled
      {'name': 'production_vs', 'services': [{'port': 80}, {'port': 443, 'enable_ssl': True}], 'vsvip_ref': '/api/vsvip/vsvip-5b310671-7784-472b-8096-8679d3e1c769'}
  • virtualservice_example_ipamdns_infoblox: Create a basic virtualservice object that requires IP to be auto-allocated and DNS record to be registered. @Assumptions: - This example assumes the virtualservice being created is part of a Cloud with Infoblox as IPAM & DNS provider - On Infoblox server - "10.10.10.0/24" is configured for VIPs - "prod.corp" is configured as zone
      {'name': 'production_vs', 'fqdn': 'production_vs.prod.corp', 'vsvip_ref': '/api/vsvip/vsvip-5b310671-7784-472b-8096-8679d3e1c769'}
  • virtualservice_example_ipamdns_internal: Create a basic virtualservice object that requires IP to be auto-allocated and DNS record to be registered. @Assumptions: - This example assumes the virtualservice being created is part of a Cloud with Internal IPAM & DNS provider - On Avi - Network object containing free IPs from "10.10.10.0/24" is already created - "prod.corp" is configured as a domain name in DNS provider config in Avi
      {'name': 'production_vs', 'fqdn': 'production_vs.prod.corp', 'vsvip_ref': '/api/vsvip/vsvip-5b310671-7784-472b-8096-8679d3e1c769'}

API permission: PERMISSION_VIRTUALSERVICE Contact Info: https://support.broadcom.com
Version: 31.2.1
BasePath: /api

Operations
GET
GET /virtualservice
POST
POST /virtualservice
GET
GET /virtualservice/{uuid}
PUT
PUT /virtualservice/{uuid}
PATCH
PATCH /virtualservice/{uuid}
DELETE
DELETE /virtualservice/{uuid}
POST
POST /virtualservice/{uuid}/scaleout
POST
POST /virtualservice/{uuid}/scalein
POST
POST /virtualservice/{uuid}/migrate
POST
POST /virtualservice/{uuid}/switchover
POST
POST /virtualservice/clear
POST
POST /virtualservice/{uuid}/resync
POST
POST /virtualservice/{uuid}/rotatekeys
POST
POST /virtualservice/{uuid}/retryplacement
POST
POST /virtualservice/{uuid}/log-recommendation
POST
POST /virtualservice/{uuid}/apply-log-recommendation
GET
GET /virtualservice/{uuid}/runtime
GET
GET /virtualservice/{uuid}/runtime/detail
GET
GET /virtualservice/{uuid}/runtime/internal
GET
GET /virtualservice/{uuid}/udpstat
GET
GET /virtualservice/{uuid}/tcpstat
GET
GET /virtualservice/{uuid}/sctpstat
GET
GET /virtualservice/{uuid}/traffic_clone_stats
GET
GET /virtualservice/{uuid}/dosstat
GET
GET /virtualservice/{uuid}/connections
GET
GET /virtualservice/{uuid}/httpconnections
GET
GET /virtualservice/{uuid}/httpconnections/detail
GET
GET /virtualservice/{uuid}/httpstats
GET
GET /virtualservice/{uuid}/authstats
GET
GET /virtualservice/{uuid}/httppolicyset
GET
GET /virtualservice/{uuid}/httppolicysetstats
GET
GET /virtualservice/{uuid}/dnspolicystats
GET
GET /virtualservice/{uuid}/networksecuritypolicystats
GET
GET /virtualservice/{uuid}/networksecuritypolicy/detail
GET
GET /virtualservice/{uuid}/candidatesehostlist
GET
GET /virtualservice/{uuid}/placement
GET
GET /virtualservice/{uuid}/keyval
GET
GET /virtualservice/{uuid}/keyvalsummary
GET
GET /virtualservice/{uuid}/keyvalsummaryobjsync
GET
GET /virtualservice/{uuid}/keyvaldispatch
GET
GET /virtualservice/{uuid}/keyvalsession
GET
GET /virtualservice/{uuid}/keyvalsessionsummary
GET
GET /virtualservice/{uuid}/sslsessioncache
GET
GET /virtualservice/{uuid}/vslogstats
GET
GET /virtualservice/{uuid}/aggrvslogstats
GET
GET /virtualservice/{uuid}/cltrack
GET
GET /virtualservice/{uuid}/cltracksummary
GET
GET /virtualservice/{uuid}/client
GET
GET /virtualservice/{uuid}/clientsummary
GET
GET /virtualservice/{uuid}/dnstable
GET
GET /virtualservice/{uuid}/gslbservicedetail
GET
GET /virtualservice/{uuid}/gslbserviceinternal
GET
GET /virtualservice/{uuid}/gslbservicealgostat
GET
GET /virtualservice/{uuid}/gslbservicehmonstat
GET
GET /virtualservice/{uuid}/geolocationinfo
GET
GET /virtualservice/{uuid}/geodbinternal
GET
GET /virtualservice/{uuid}/gslbsiteinternal
GET
GET /virtualservice/{uuid}/userdefineddatascriptcounters
GET
GET /virtualservice/{uuid}/l4policysetstats
GET
GET /virtualservice/{uuid}/sescaleoutstatus
GET
GET /virtualservice/{uuid}/scaleoutstatus
GET
GET /virtualservice/{uuid}/scaleoutstatus/detail
GET
GET /virtualservice/{uuid}/ssopolicystats
GET
GET /virtualservice/{uuid}/icapstats
GET
GET /virtualservice/{uuid}/outofbandstats
GET
GET /virtualservice/{uuid}/botstats
GET
GET /virtualservice/{uuid}/csrfmetrics
GET
GET /virtualservice/{uuid}/placement/summary
GET
GET /virtualservice/{uuid}/placement/detail
GET
GET /virtualservice/{uuid}/placement/status
GET
GET /virtualservice/{uuid}/keyvalstats