Vidcinfo APIs
Avi VIDCInfo object api
- show vcenter datacenters
API permission: PERMISSION_CLOUD Avi ErrorPageProfile object api
- configure errorpageprofile <key>
- show errorpageprofile <key>
API permission: PERMISSION_ERRORPAGEPROFILE Avi NetworkProfile object api
- configure networkprofile <key>
- show networkprofile <key>
API permission: PERMISSION_NETWORKPROFILE Avi PoolGroupInventory object api
- show poolgroupinventory <key>
API permission: PERMISSION_POOLGROUP Avi L4PolicySet object api
- configure l4policyset <key>
- show l4policyset <key>
API permission: PERMISSION_L4POLICYSET Avi UpgradeStatusInfo object api
- show upgrade status detail
- show upgrade status detail include_history
API permission: PERMISSION_CONTROLLER Avi MicroServiceGroup object api
- configure microservicegroup <key>
- show microservicegroup <key>
API permission: PERMISSION_MICROSERVICEGROUP Avi NetworkRuntime object api
- show network <key> runtime
API permission: PERMISSION_NETWORK Avi TaskJournal object api
- show taskjournal <key>
API permission: PERMISSION_TASKJOURNAL Avi VSDataScriptSet object api
- configure vsdatascriptset <key>
- show vsdatascriptset <key>
API permission: PERMISSION_VSDATASCRIPTSET Avi TrustedHostProfile object api
- configure trustedhostprofile <key>
- show trustedhostprofile <key>
API permission: PERMISSION_SYSTEMCONFIGURATION Avi ApiRateLimitProfile object api
- configure apiratelimitprofile <key>
- show apiratelimitprofile <key>
API permission: PERMISSION_APIRATELIMITPROFILE Avi ErrorPageBody object api
- configure errorpagebody <key>
- show errorpagebody <key>
API permission: PERMISSION_ERRORPAGEBODY Avi GeoDB object api
- configure geodb <key>
- show geodb <key>
- show geodb <key> data
API permission: PERMISSION_GEODB Avi HTTPPolicySet object api
- configure httppolicyset <key>
- show httppolicyset <key>
API permission: PERMISSION_HTTPPOLICYSET Avi GslbServiceInventory object api
- show gslbserviceinventory <key>
API permission: PERMISSION_GSLBSERVICE Avi SecureChannelToken object api
- show securechanneltoken <key>
API permission: PERMISSION_CONTROLLER Avi WafPolicy object api
- configure wafpolicy <key>
- show wafpolicy <key>
- updatecrsrules virtualservice <key>
API permission: PERMISSION_WAFPOLICY Avi Gslb object api
- configure gslb <key>
- show gslb <key>
API permission: PERMISSION_GSLB Avi CloudRuntime object api
- show cloudruntime
API permission: PERMISSION_CLOUD Avi VrfContext object api
- configure vrfcontext <key>
- show vrfcontext <key>
API permission: PERMISSION_VRFCONTEXT Avi CloudProperties object api
- configure cloudproperties
- show cloudproperties
API permission: PERMISSION_CLOUD Avi CSRFPolicy object api
- configure csrfpolicy <key>
- show csrfpolicy <key>
API permission: PERMISSION_CSRFPOLICY Avi BotMapping object api
- configure botmapping <key>
- show botmapping <key>
API permission: PERMISSION_BOTDETECTIONPOLICY Avi ALBServicesFileDownload object api
- configure albservicesfiledownload <key>
- show albservicesfiledownload <key>
API permission: PERMISSION_CONTROLLER Avi WafPolicyPSMGroup object api
- configure wafpolicypsmgroup <key>
- show wafpolicypsmgroup <key>
API permission: PERMISSION_WAFPOLICYPSMGROUP Avi SecurityPolicy object api
- configure securitypolicy <key>
- show securitypolicy <key>
API permission: PERMISSION_SECURITYPOLICY Avi CloudInventory object api
- show cloudinventory <key>
API permission: PERMISSION_CLOUD Avi CertificateManagementProfile object api
- configure certificatemanagementprofile <key>
- show certificatemanagementprofile <key>
API permission: PERMISSION_CERTIFICATEMANAGEMENTPROFILE Avi AlertScriptConfig object api
- configure alertscriptconfig <key>
- show alertscriptconfig <key>
API permission: PERMISSION_ALERTSCRIPTCONFIG Avi SystemConfiguration object api
- configure systemconfiguration
- show systemconfiguration
- test systememail
API permission: PERMISSION_SYSTEMCONFIGURATION Avi ControllerSite object api
- configure controllersite <key>
- show controllersite <key>
API permission: PERMISSION_CONTROLLERSITE Avi CloudConnectorUser object api
- configure cloudconnectoruser <key>
- show cloudconnectoruser <key>
- test cloudconnectoruser <key>
API permission: PERMISSION_USER_CREDENTIAL Avi GslbService object api
- configure gslbservice <key>
- show gslbservice <key>
API permission: PERMISSION_GSLBSERVICE Avi SSLKeyAndCertificate object api
- configure sslkeyandcertificate <key>
- show sslkeyandcertificate <key>
- delete sslkeyandcertificate <key>
- renew sslkeyandcertificate <key>
- update-chain sslkeyandcertificate <key>
Examples
- sslkeyandcertificate_example_1: To generate a self-signed certificate
{'name': 'mycert', 'common_name': 'ACME Company', 'organization': 'ACME Company', 'locality': 'Sunnyvale', 'state': 'CA', 'country': 'US', 'self_signed': True, 'key_params': {'algorithm': 'SSL_KEY_ALGORITHM_RSA', 'rsa_params': {'key_size': 'SSL_KEY_1024_BITS'}}} - sslkeyandcertificate_example_2: To generate a CA-signed certificate use the following sample. This will provide a Certificate Signing Request that you will have to use to get a CA-siged certificate
{'name': 'mycert2', 'common_name': 'ACME Company', 'organization': 'ACME Company', 'locality': 'Sunnyvale', 'state': 'CA', 'country': 'US', 'key_params': {'algorithm': 'SSL_KEY_ALGORITHM_RSA', 'rsa_params': {'key_size': 'SSL_KEY_1024_BITS'}}} - sslkeyandcertificate_example_3: To import a CA-signed certificate
{'certificate': '\n-----BEGIN CERTIFICATE-----\nMIICmTCCAgKgAwIBAgIJAKfrg8i8iZZqMA0GCSqGSIb3DQEBCwUAMFAxCzAJBgNV\nBAYTAlVTMQswCQYDVQQIDAJDQTEVMBMGA1UECgwMQWNtZSBDb21wYW55MR0wGwYD\nVQQDDBRTeXN0ZW0gQWRtaW5pc3RyYXRvcjAeFw0xNTAxMTkwNzEyNThaFw0xNjAx\nMTkwNzEyNThaMFAxCzAJBgNVBAYTAlVTMQswCQYDVQQIDAJDQTEVMBMGA1UECgwM\nQWNtZSBDb21wYW55MR0wGwYDVQQDDBRTeXN0ZW0gQWRtaW5pc3RyYXRvcjCBnzAN\nBgkqhkiG9w0BAQEFAAOBjQAwgYkCgYEAtT9psNKi/4oImbB4aIJLjJDPwTIAIrQP\nLoC4R/GHrBCByRYVfoyxFrHJU9WSg9KTqxc6Ph6/zK2hoR+MchQStMP+K5W+4HcR\nSW+1MJdMwRhm+egxH7hYwnrfsaQoo0GBPVb48deBB/yKTLj7trdGqWTD5oyZqr/B\nk+kR0kXGzx8CAwEAAaN7MHkwCQYDVR0TBAIwADAsBglghkgBhvhCAQ0EHxYdT3Bl\nblNTTCBHZW5lcmF0ZWQgQ2VydGlmaWNhdGUwHQYDVR0OBBYEFNhre4joManxHL+F\nDWzYSVblWVdlMB8GA1UdIwQYMBaAFNhre4joManxHL+FDWzYSVblWVdlMA0GCSqG\nSIb3DQEBCwUAA4GBAINlLdqGJW2Enow2ft+FRMZdo2qwOovuF4smNIFoXmSoywhW\n7dyeAkeCyUjZrbqFRNsCf969aUSIE8pARjSnT9P4otOvIMCaIN215F0nzKKZbsIL\nK4pA6A0h5GSd+aqol6P2vAWzLNE+kUbrE/PcZu9pozWp0GdoiAEu+BnqwWrC\n-----END CERTIFICATE-----\n'} - sslkeyandcertificate_example_4: To import both key and certificate, use the following sample.
{'name': 'mycert3', 'key': '\n-----BEGIN RSA PRIVATE KEY-----\nProc-Type: 4,ENCRYPTED\nDEK-Info: AES-256-CBC,23E2D6132285630DB8D67E25E465F0A6\n\n9sM1JGQHgo+rwuZ5L9piE7EGpp2fvY9QC8GgxEcdfw9OHfcj7CHRCCfXAUsxfBOe\nTh1aGNH9mCmZ72LdrA9cnS/fwISClUoQe0tmVWRTagQptOZfW20HvHI37HGaZ2s1\nMsqvOaqfQ1ZHa0U6WtzBw5/6PqL9LgDUGoQFSEtMHD06nuYoaynpfDk3eoftFwrx\n0U3u0O5lc0a0VqwSvJynSYO1yaxoTzTEDZws4Cf1scLi/Wx5aBQHb5I3k6Dr1Ipm\n59NCpKxjUI+XFUVMszVyQM6+dUUZ0rRU17f2toZFsGTdQ9M1vJLS1J7Ya2pAhlmm\nX7fzy1NywL5kk+jRPWXRNrSKZg+qnutPSPD1689oDNqu4fwycbC+jZ7zJYXB/vio\nagS3/UI8d2Lxs69IPFxwP0lhYuUiSEGfLwDwqEuRZNbvaZpwtp2kC6sf7xlKbQF7\n24lz/LiL5t7xFsLuruOyWfb1fUwLjTZm4O6y8SI9JTSixPm4NCLGclcaTh33harN\nQhsTf0+qMbovgAUv6myfnI4ajPCcu+Kwn2jMjUjWEFf3oj9A1NUfiT4SqiLcZ4AU\nsvR8kHs0+rUVDiZ8kFXH0HQ+LI7itVCRoCooq3uqpqeZ5J8L+hZEeILjGCVNQluU\nlTcEbAry3WibKzsk2bWARe0v+7i/r09EuwSzJ8+H2BOkrxmTr+WgC2RKBMKV+gLc\nu3rxjeddL6hc0qgo2EN/Hp38FrVBwFLrDYHsBVRwdN6OsDW0OP67EJXikMD+qe2+\nuUcXr00Sno+Wcgbm17m9SghESxXBj1N5eok6MSUZxbNlFNhxu4qbpiBDKZOrJ2e/\nn8rxlg9XmJAQPfhY1EKbX7WFiaSa0y4tvbD2tWZfw8Yt97PRSVxumRWg5pbqRr1i\nl7QTNWfIwk25xtIW5q4WnHjuVynurnREYdlTVd/vBsQcrgV0vaPVYEq+iFzkZBOy\na0Z0001SHqsQE6ThC2+7ap855EKPpU7HxXqOAEas9z4C9HGgPogSFKT9H5MrDY2C\nynuoU44hQ/qmR5TAfjO8OnBeLlAlPk0VpEAaOX5V7t8PWhhkAz3QRbQAPbDQ5BQx\naGnBmi4/12h4EywHUdacj4/9uvUPVd1E476mxePfsDr+E3wtYqUWBzgHtoDxJ9Qn\nSAL5hU3GrL3mEQQ1RK8kITANVXmlFa56XZXqGuYKxUfGGDGhLTE/VYh13I37hVZH\nQ825Y+WqZRiRsRvV9W/Wq8H5I2+QU1flB1+kqpoVTxDhzJ15dOetZDTYXqjs6gMS\nQpr/dYub0yR0zwmV1EKpuqchoYcwHpG4gsX42NRCfcdYoIxoa1Drr/xX4L0si40z\npY00CT/YuCAJFxbhpzlqKnZz3okj8vzPocT8mjFZcajnyOtaWyILnrBKO/93tkEF\nYednFMpQ2xdlq5bebhrZhYkf6XS21N8t1ETropoOX19Eh33yJUHh/rJ67I1ccRvZ\neSI1LDB18B6+k2BdYCfjEhc33WgqUmoHEjxLYEdN0N0qr4ZG2JznQ9R7h/SQusGo\nwG1rwolI5lxqX/M53KXoBoH1UcZp1yg/8qG2e8Ntx41a6j79oPh7YkXvJYHDh/xt\n-----END RSA PRIVATE KEY-----\n', 'certificate': '\n-----BEGIN CERTIFICATE-----\nMIIE+DCCAuCgAwIBAgICEAAwDQYJKoZIhvcNAQELBQAwQTELMAkGA1UEBhMCVVMx\nEzARBgNVBAgMCkNhbGlmb3JuaWExHTAbBgNVBAMMFEdyZWcgSW50ZXJtZWRpYXRl\nIENBMB4XDTE2MDIxMTE2MjYyNFoXDTE3MDIyMDE2MjYyNFowPDELMAkGA1UEBhMC\nVVMxEzARBgNVBAgMCkNhbGlmb3JuaWExGDAWBgNVBAMMD3d3dy5leGFtcGxlLmNv\nbTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAM47ljnydqleK3Yapr//\nAEqEdPuduGiqgEcY1qjx1vPwO/TU3iqNIJEUEcu/uvHxXqOmsXGUG9+/xMfsV/Lx\nQAqhneXA2fxZtODmnCWq0SldPQi0mD63ir3jFqI+slS+n9ao20krBBYKpgqjstxh\nbSez59h6Aoup8vM226gieMfw9Fac7govovJFQZ+lYywGbe2hzP3vftEoyO8itwdB\novxXk/fmQSDfDPRGSJ4eSve2o8lP9xRRiyqkRKoNQ3UaJRK9L9JSvzdjbvVmUD5S\n4le7sa6N7VgT73OiUFdwndCQNHN95+BMhGibNury7IXVg+yC94WUmp5L1UX8PixZ\nv78CAwEAAaOB/jCB+zAJBgNVHRMEAjAAMBEGCWCGSAGG+EIBAQQEAwIGQDAzBglg\nhkgBhvhCAQ0EJhYkT3BlblNTTCBHZW5lcmF0ZWQgU2VydmVyIENlcnRpZmljYXRl\nMB0GA1UdDgQWBBSqF2GsfFBj6SkSpRjG9oK1cqvm2jBiBgNVHSMEWzBZgBQGr+y3\nQMSnVEKwnT9quMhAYExFEaE9pDswOTELMAkGA1UEBhMCVVMxEzARBgNVBAgMCkNh\nbGlmb3JuaWExFTATBgNVBAMMDEdyZWcgUm9vdCBDQYICEAAwDgYDVR0PAQH/BAQD\nAgWgMBMGA1UdJQQMMAoGCCsGAQUFBwMBMA0GCSqGSIb3DQEBCwUAA4ICAQAudoCP\nRNq/keBcTcL19UYo8X4tRwm350U5ccKwiKb8caEE2Crh3dyNyKDN3+ZKl8i8OwWN\nx9PpTJANlmWYuOvhjLtvnkGidcxhCmVEpEms2h3+zrRIXijIENqhWpKzcQus7R6F\nmMxW/KPt0rY80rfrZ2ReCkuhBEZzgL5udYL+AEYkvf7oGD/W18nDCUKEsm8T45jI\ndBVs7PeFaEJSAlDW8T3OekV8CETvafwBx4UK9kHo7+mfZSHCiGhzodF3WGzPnLFs\nB4OptAHfXUjIAEZ9pxdr8C/tXU9dVyQVdHjISKQdtWUBoHSwmZnIuEtWADfRjMi8\ne2Le1qiC0IBMc7JAVZXZ1lbs7A5mKgsUy+1rRUVEkVgmgDfr1BcsstOeXpNcQS4K\nebKterF/ZDmVYJdUD6o91xfAAy1onn1mzKhIfqMeCZEcz4nvuaLM2h5HsIOJPgLL\n5LnaQxl+6cNx1u3+X1crPv0k1hs9yqn72LmD65ZqBpamiwJudSpu1RCPCAdNzzcO\n9v2I8JlXhl0IKRXoAZX+VK1PJmZJ8giRTI+92XOWJlryyknm9Znp1djibZAbLnpI\nrorY/feSmoZFEKUv74n7XrgbveEWjMbkZQHrNNPW0VZ3uXM30E81Wt6fCyyX5GO3\ndTPtEDPf9zp/r0AHZKU+4Bg2ZAkrNMltCAjXSg==\n-----END CERTIFICATE-----\n', 'key_passphrase': 'avi123'}
API permission: PERMISSION_SSLKEYANDCERTIFICATE Avi User object api
- configure user <key>
- show user <key>
API permission: PERMISSION_USER Avi SiteVersion object api
- show siteversion <key>
API permission: PERMISSION_CONTROLLER Avi AuthProfile object api
- configure authprofile <key>
- show authprofile <key>
API permission: PERMISSION_AUTHPROFILE Avi AlertObjectList object api
- configure alertobjectlist
- show alertobjectlist
API permission: PERMISSION_ALERTCONFIG Avi SecureChannelMapping object api
- show securechannelmapping <key>
API permission: PERMISSION_CONTROLLER Avi SCPoolServerStateInfo object api
- show poolserverstateinfo
API permission: PERMISSION_CONTROLLER Avi ALBServicesConfig object api
- show albservicesconfig
- configure albservicesconfig
API permission: PERMISSION_ALBSERVICESCONFIG 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 Avi DebugController object api
- debug controller <key>
- debug controller <key>
- show debug controller <key>
API permission: PERMISSION_CONTROLLER Avi Image object api
- upload image
- show image <key>
- delete image <key>
API permission: PERMISSION_IMAGE Avi SSOPolicy object api
- configure ssopolicy <key>
- show ssopolicy <key>
API permission: PERMISSION_SSOPOLICY Avi JobEntry object api
- show job <key>
API permission: PERMISSION_INTERNAL Avi SCVsStateInfo object api
- show vsstateinfo
API permission: PERMISSION_CONTROLLER Avi AutoScaleLaunchConfig object api
- configure autoscalelaunchconfig <key>
- show autoscalelaunchconfig <key>
API permission: PERMISSION_AUTOSCALE Avi PriorityLabels object api
- configure prioritylabels <key>
- show prioritylabels <key>
API permission: PERMISSION_PRIORITYLABELS Avi VsGs object api
- show vsgs
API permission: PERMISSION_GSLB Avi CustomIpamDnsProfile object api
- configure customipamdnsprofile <key>
- show customipamdnsprofile <key>
API permission: PERMISSION_CUSTOMIPAMDNSPROFILE Avi SeProperties object api
- configure serviceengineproperties
- show serviceengineproperties
API permission: PERMISSION_CONTROLLER Avi GslbSMRuntime object api
- show gslbsm <key>
API permission: PERMISSION_GSLB Avi SecurityManagerData object api
- show secmgrdata
API permission: PERMISSION_CONTROLLER Avi PoolGroup object api
- configure poolgroup <key>
- show poolgroup <key>
- clear poolgroup <key>
API permission: PERMISSION_POOLGROUP Avi ServiceEngine object api
- configure serviceengine <key>
- show serviceengine <key>
- reboot serviceengine <key>
- delete serviceengine <key>
- forcedelete serviceengine <key>
- switchover serviceengine <key>
- clear serviceengine <key>
API permission: PERMISSION_SERVICEENGINE Avi AvailabilityZone object api
- configure availabilityzone <key>
- show availabilityzone <key>
API permission: PERMISSION_CLOUD Avi LicenseLedgerDetails object api
- show license ledger details
API permission: PERMISSION_CONTROLLER Avi VsvipInventory object api
- show vsvipinventory <key>
API permission: PERMISSION_VIRTUALSERVICE Avi TechSupportMessage object api
- techsupport debuglogs
- techsupport clustering
- techsupport upgrade
- techsupport placement
- techsupport portal
- techsupport metricslogs
- techsupport virtualservice <key>
- techsupport serviceengine <key>
- techsupport gslb <key>
- techsupport pool <key>
- techsupport systeminfo
- techsupport cores
API permission: PERMISSION_TECHSUPPORTMESSAGE Avi Scheduler object api
- configure scheduler <key>
- show scheduler <key>
API permission: PERMISSION_CONTROLLER Avi ControllerProperties object api
- configure controller properties
- show controller properties
API permission: PERMISSION_CONTROLLER Avi AnalyticsProfile object api
- configure analyticsprofile <key>
- show analyticsprofile <key>
API permission: PERMISSION_ANALYTICSPROFILE Avi BotDetectionPolicy object api
- configure botdetectionpolicy <key>
- show botdetectionpolicy <key>
API permission: PERMISSION_BOTDETECTIONPOLICY Avi GslbInventory object api
- show gslbinventory <key>
API permission: PERMISSION_GSLB Avi StatediffSnapshot object api
- show statediff <key>
API permission: PERMISSION_CONTROLLER Avi TenantSystemConfiguration object api
- show tenantsystemconfiguration <key>
- configure tenantsystemconfiguration <key>
API permission: PERMISSION_TENANT_SYSTEM_CONFIGURATION Avi WebappUT object api
- configure webapput <key>
- show webapput <key>
API permission: PERMISSION_CONTROLLER Avi TechSupportProfile object api
- configure techsupportprofile
- show techsupportprofile
API permission: PERMISSION_TECHSUPPORTPROFILE Avi Backup object api
- show backup <key>
API permission: PERMISSION_CONTROLLER Avi FileObject object api
- upload fileobject file
- show fileobject
- configure fileobject <key>
- show fileobject <key>
- upload fileobject uri
API permission: PERMISSION_FILE_OBJECT Avi DnsPolicy object api
- configure dnspolicy <key>
- show dnspolicy <key>
API permission: PERMISSION_DNSPOLICY Avi TestSeDatastoreLevel3 object api
- configure testsedatastorelevel3 <key>
- show testsedatastorelevel3 <key>
API permission: PERMISSION_TESTSEDATASTORELEVEL3 Avi ActionGroupConfig object api
- configure actiongroupconfig <key>
- show actiongroupconfig <key>
API permission: PERMISSION_ACTIONGROUPCONFIG Avi VCenterServer object api
- configure vcenterserver <key>
- show vcenterserver <key>
API permission: PERMISSION_CLOUD Avi ServiceEngineGroup object api
- configure serviceenginegroup <key>
- show serviceenginegroup <key>
- redistribute serviceenginegroup <key>
- clear serviceenginegroup <key>
Examples
- serviceenginegroup_example_1: To create a SE group that is suitable for a production application with a HA policy of shared active/active with a minimum scale out of 2 SE
{'name': 'production-group', 'min_scaleout_per_vs': 2, 'ha_mode': 'HA_MODE_SHARED_PAIR'} - serviceenginegroup_example_2: To create a SE group that is of best effort category suitable for test deployments
{'name': 'test-group', 'max_se': 8, 'ha_mode': 'HA_MODE_SHARED', 'buffer_se': 0}
API permission: PERMISSION_SERVICEENGINEGROUP Avi PoolGroupDeploymentPolicy object api
- configure poolgroupdeploymentpolicy <key>
- show poolgroupdeploymentpolicy <key>
API permission: PERMISSION_POOLGROUPDEPLOYMENTPOLICY Avi TestSeDatastoreLevel2 object api
- configure testsedatastorelevel2 <key>
- show testsedatastorelevel2 <key>
API permission: PERMISSION_TESTSEDATASTORELEVEL2 Avi DynamicDnsRecord object api
- show dynamicdnsrecord <key>
API permission: PERMISSION_SYSTEMCONFIGURATION Avi ControllerPortalRegistration object api
API permission: PERMISSION_CONTROLLER Avi Cloud object api
- configure cloud <key>
- show cloud <key>
- show cloud internals
API permission: PERMISSION_CLOUD Avi RateLimitConfiguration object api
- configure ratelimitconfiguration <key>
- show ratelimitconfiguration <key>
API permission: PERMISSION_ApiRateLimitProfile Avi ALBServicesFileUpload object api
- configure albservicesfileupload <key>
- show albservicesfileupload <key>
API permission: PERMISSION_CONTROLLER Avi VIMgrClusterRuntime object api
- show vinfra cluster <key>
API permission: PERMISSION_CLOUD Avi Role object api
- configure role <key>
- show role <key>
API permission: PERMISSION_ROLE Avi WafProfile object api
- configure wafprofile <key>
- show wafprofile <key>
- updatefromcrs wafprofile <key>
API permission: PERMISSION_WAFPROFILE Avi VIMgrSEVMRuntime object api
- show vinfra serviceengine <key>
API permission: PERMISSION_CLOUD Avi VIPGNameInfo object api
- show vcenter networks
API permission: PERMISSION_CLOUD Avi Tenant object api
- configure tenant <key>
- show tenant <key>
API permission: PERMISSION_TENANT Avi SecureChannelAvailableLocalIPs object api
- show securechannelavailablelocalips <key>
API permission: PERMISSION_CONTROLLER Avi UserAccountProfile object api
- configure useraccountprofile <key>
- show useraccountprofile <key>
API permission: PERMISSION_USER Avi AlertSyslogConfig object api
- configure alertsyslogconfig <key>
- show alertsyslogconfig <key>
- test alerttestsyslog <key>
API permission: PERMISSION_ALERTSYSLOGCONFIG Avi SSLProfile object api
- configure sslprofile <key>
- show sslprofile <key>
Examples
- sslprofile_example: To create a standard security SSL profile
{'name': 'Standard', 'accepted_versions': [{'type': 'SSL_VERSION_TLS1'}, {'type': 'SSL_VERSION_TLS1'}, {'type': 'SSL_VERSION_TLS1_1'}, {'type': 'SSL_VERSION_TLS1_2'}], 'accepted_ciphers': 'aECDSA:aECDH:kEDH:kRSA'}
API permission: PERMISSION_SSLPROFILE Avi GslbCRMRuntime object api
- show gslbcrm <key>
API permission: PERMISSION_GSLB Avi NetworkInventory object api
- show networkinventory <key>
API permission: PERMISSION_NETWORK Avi InventoryFaultConfig object api
- configure inventoryfaultconfig
- show inventoryfaultconfig
API permission: PERMISSION_CONTROLLER Avi AlertEmailConfig object api
- configure alertemailconfig <key>
- show alertemailconfig <key>
- test alerttestemail <key>
API permission: PERMISSION_ALERTEMAILCONFIG Avi LogControllerMapping object api
- show logcontrollermapping
API permission: PERMISSION_CONTROLLER Avi BackupConfiguration object api
- show backupconfiguration <key>
- configure backupconfiguration <key>
API permission: PERMISSION_CONTROLLER Avi VIMgrHostRuntime object api
- show vinfra host <key>
- vinfra makehostaccessible <key>
- show vinfra quarantinedhost
API permission: PERMISSION_CLOUD Avi PKIProfile object api
- configure pkiprofile <key>
- show pkiprofile <key>
API permission: PERMISSION_PKIPROFILE Avi ServiceEngineGroupInventory object api
- show serviceenginegroupinventory <key>
API permission: PERMISSION_SERVICEENGINEGROUP Avi ProtocolParser object api
- configure protocolparser <key>
- show protocolparser <key>
API permission: PERMISSION_PROTOCOLPARSER Avi BotIPReputationTypeMapping object api
- configure botipreputationtypemapping <key>
- show botipreputationtypemapping <key>
API permission: PERMISSION_BOTDETECTIONPOLICY Avi UpgradeStatusSummary object api
- show upgrade status
API permission: PERMISSION_CONTROLLER Avi GslbGeoDbProfile object api
- configure gslbgeodbprofile <key>
- show gslbgeodbprofile <key>
API permission: PERMISSION_GSLBGEODBPROFILE Avi IcapProfile object api
- configure icapprofile <key>
- show icapprofile <key>
API permission: PERMISSION_ICAP Avi Alert object api
- show alert <key>
- delete alert <key>
API permission: PERMISSION_ALERT Avi ALBServicesJob object api
- configure albservicesjob <key>
- show albservicesjob <key>
API permission: PERMISSION_CONTROLLER Avi ServiceEngineInventory object api
- show serviceengineinventory <key>
API permission: PERMISSION_SERVICEENGINE Avi ClusterCloudDetails object api
- configure clusterclouddetails <key>
- show clusterclouddetails <key>
API permission: PERMISSION_CONTROLLER Avi NatPolicy object api
- configure natpolicy <key>
- show natpolicy <key>
API permission: PERMISSION_NATPOLICY Avi VsVip object api
- configure vsvip <key>
- show vsvip <key>
Examples
- vsvip_example_1: To create a basic vsvip object
{'name': 'production_vsvip', 'vip': [{'subnet': {'ip_addr': {'addr': '10.10.10.0', 'type': 'V4'}}, 'auto_allocate_ip': True}], 'east_west_placement': False}
API permission: PERMISSION_VIRTUALSERVICE Avi DebugServiceEngine object api
- debug serviceengine <key>
- show debug serviceengine <key>
API permission: PERMISSION_SERVICEENGINE Avi UserActivity object api
- show useractivity <key>
API permission: PERMISSION_USER Avi StringGroup object api
- configure stringgroup <key>
- show stringgroup <key>
API permission: PERMISSION_STRINGGROUP Avi NetworkService object api
- configure networkservice <key>
- show networkservice <key>
API permission: PERMISSION_NETWORKSERVICE Avi RetentionPolicy object api
- show retentionpolicy <key>
- configure retentionpolicy <key>
API permission: PERMISSION_RETENTIONPOLICY Avi ApplicationPersistenceProfile object api
- configure applicationpersistenceprofile <key>
- show applicationpersistenceprofile <key>
API permission: PERMISSION_APPLICATIONPERSISTENCEPROFILE Avi Webhook object api
- configure webhook <key>
- show webhook <key>
API permission: PERMISSION_AUTOSCALE Avi SystemLimits object api
- configure systemlimits
- show systemlimits
API permission: PERMISSION_SYSTEMCONFIGURATION Avi IpamDnsProviderProfile object api
- configure ipamdnsproviderprofile <key>
- show ipamdnsproviderprofile <key>
API permission: PERMISSION_IPAMDNSPROVIDERPROFILE Avi AuthMappingProfile object api
- configure authmappingprofile <key>
- show authmappingprofile <key>
API permission: PERMISSION_AUTHMAPPINGPROFILE Avi ReportProfile object api
- configure reportprofile
- show reportprofile
API permission: PERMISSION_REPORTPROFILE Avi VIMgrVMRuntime object api
- show vinfra virtualmachine <key>
API permission: PERMISSION_CLOUD Avi DebugVirtualService object api
- debug virtualservice <key>
- show debug virtualservice <key>
API permission: PERMISSION_TRAFFIC_CAPTURE Avi MicroService object api
- configure microservice <key>
- show microservice <key>
API permission: PERMISSION_MICROSERVICE Avi AlertConfig object api
- configure alertconfig <key>
- show alertconfig <key>
API permission: PERMISSION_ALERTCONFIG Avi LabelGroup object api
- configure labelgroup <key>
- show labelgroup <key>
API permission: PERMISSION_LABELGROUP Avi VIMgrNWRuntime object api
- show vinfra network <key>
API permission: PERMISSION_CLOUD Avi PoolInventory object api
- show poolinventory <key>
API permission: PERMISSION_POOL Avi WafCRS object api
- configure wafcrs <key>
- show wafcrs <key>
API permission: PERMISSION_WAFCRS Avi TrafficCloneProfile object api
- configure trafficcloneprofile <key>
- show trafficcloneprofile <key>
API permission: PERMISSION_TRAFFICCLONEPROFILE Avi LicenseStatus object api
- show license status
API permission: PERMISSION_CONTROLLER Avi HardwareSecurityModuleGroup object api
- configure hardwaresecuritymodulegroup <key>
- show hardwaresecuritymodulegroup <key>
API permission: PERMISSION_HARDWARESECURITYMODULEGROUP Avi TechSupport object api
- show techsupport
- show techsupport <key>
- show techsupport <key> detail
- delete techsupport <key>
API permission: PERMISSION_TECHSUPPORT Avi ServiceAuthProfile object api
- configure serviceauthprofile <key>
- show serviceauthprofile <key>
API permission: PERMISSION_SERVICEAUTHPROFILE Avi MemoryBalancerRequest object api
- configure memorybalancerrequest <key>
- show memorybalancerrequest <key>
API permission: PERMISSION_CONTROLLER Avi UpgradeProfile object api
- configure upgrade profile
- show upgrade profile
API permission: PERMISSION_UPGRADEPROFILE Avi Report object api
- generate report application_security
- generate report waf_pov
- show report
- show report <key>
- show report <key> detail
- delete report <key>
- show report <key> export
API permission: PERMISSION_REPORT Avi ApplicationInsightsPolicy object api
- configure applicationinsightspolicy <key>
- show applicationinsightspolicy <key>
API permission: PERMISSION_APPLICATIONINSIGHTSPOLICY Avi TestSeDatastoreLevel1 object api
- configure testsedatastorelevel1 <key>
- show testsedatastorelevel1 <key>
API permission: PERMISSION_TESTSEDATASTORELEVEL1 Avi WafPolicyPSMGroupInventory object api
- show wafpolicypsmgroupinventory <key>
API permission: PERMISSION_WAFPOLICYPSMGROUP Avi JWTServerProfile object api
- configure jwtserverprofile <key>
- show jwtserverprofile <key>
API permission: PERMISSION_JWTSERVERPROFILE Avi BotConfigConsolidator object api
- configure botconfigconsolidator <key>
- show botconfigconsolidator <key>
API permission: PERMISSION_BOTDETECTIONPOLICY Avi ApplicationProfile object api
- configure applicationprofile <key>
- show applicationprofile <key>
API permission: PERMISSION_APPLICATIONPROFILE Avi NetworkSecurityPolicy object api
- configure networksecuritypolicy <key>
- show networksecuritypolicy <key>
API permission: PERMISSION_NETWORKSECURITYPOLICY Avi ServerAutoScalePolicy object api
- configure serverautoscalepolicy <key>
- show serverautoscalepolicy <key>
API permission: PERMISSION_AUTOSCALE Avi Pool object api
- configure pool <key>
- show pool <key>
- scaleout pool <key>
- scalein pool <key>
- clear pool <key>
Examples
- pool_example: To create a basic pool object that uses the least connections algorithm and has a couple of application servers in the backend
{'name': 'production_pool', 'default_server_port': 80, 'servers': [{'ip': {'addr': '10.10.90.120', 'type': 'V4'}}, {'ip': {'addr': '10.10.90.121', 'type': 'V4'}}], 'lb_algorithm': 'LB_ALGORITHM_LEAST_CONNECTIONS'}
API permission: PERMISSION_POOL Avi Application object api
- configure application <key>
- show application <key>
API permission: PERMISSION_INTERNAL Avi IPReputationDB object api
- configure ipreputationdb <key>
- show ipreputationdb <key>
- show ipreputationdb <key> data
API permission: PERMISSION_IPREPUTATIONDB Avi IpAddrGroup object api
- configure ipaddrgroup <key>
- show ipaddrgroup <key>
API permission: PERMISSION_IPADDRGROUP Avi SnmpTrapProfile object api
- configure snmptrapprofile <key>
- show snmptrapprofile <key>
- test alerttestsnmptrap <key>
API permission: PERMISSION_SNMPTRAPPROFILE Avi VsInventory object api
- show vsinventory <key>
API permission: PERMISSION_VIRTUALSERVICE Avi WafApplicationSignatureProvider object api
- show wafapplicationsignatureprovider <key>
- configure wafapplicationsignatureprovider <key>
API permission: PERMISSION_WAFPOLICY Avi SystemReport object api
- show systemreport <key>
- show systemreport <key> export
- delete systemreport <key>
API permission: PERMISSION_SYSTEMREPORT Avi PositiveSecurityPolicy object api
- configure positivesecuritypolicy <key>
- show positivesecuritypolicy <key>
API permission: PERMISSION_POSITIVESECURITYPOLICY Avi HealthMonitor object api
- configure healthmonitor <key>
- show healthmonitor <key>
Examples
- healthmonitor_example: To create a basic HTTP health monitor that uses GET / to determine if the service is alive
{'name': 'http-hmon', 'send_interval': 10, 'receive_timeout': 4, 'failed_checks': 3, 'type': 'HEALTH_MONITOR_HTTP', 'http_monitor': {'http_request': 'GET / HTTP/1.0'}}
API permission: PERMISSION_HEALTHMONITOR Avi NsxtSegmentRuntime object api
- show nsxt segment <key>
API permission: PERMISSION_CLOUD Avi LocalWorkerFdsVersion object api
- show localworkerfdsversion
API permission: PERMISSION_GSLB Avi GslbHSMRuntime object api
- show gslbhsm <key>
API permission: PERMISSION_GSLB Avi StatediffOperation object api
- show statediff
- delete statediff <key>
API permission: PERMISSION_CONTROLLER Avi Network object api
- configure network <key>
- show network <key>
API permission: PERMISSION_NETWORK
Contact Info: https://support.broadcom.com
Version: 31.2.2
BasePath: /api