Avi SystemLimits Object API

CLI ``` - configure systemlimits - show systemlimits ```

More information: https://avinetworks.com/contact-us

Contact Info: support@avinetworks.com

Version: 20.1.9

BasePath:/api

http://apache.org/licenses/LICENSE-2.0.html

Access

HTTP Basic Authentication

Methods

[ Jump to Models ]

get /systemlimits
post /systemlimits
delete /systemlimits/{uuid}
get /systemlimits/{uuid}
patch /systemlimits/{uuid}
put /systemlimits/{uuid}

get /systemlimits

(systemlimitsGet)

Consumes

This API call consumes the following media types via the Content-Type request header:

application/json

Query parameters

name (optional)

Query Parameter — object name

refers_to (optional)

Query Parameter — Filter to request all objects that refers to another Avi resource. Its syntax is refers_to=<obj_type>:<obj_uuid>. Eg. get all virtual services referring to pool p1 will be refers_to=pool:pool_p1_uuid

referred_by (optional)

Query Parameter — Filter to request all objects that are referred by another Avi resource. Its syntax is referred_by=<obj_type>:<obj_uuid>. Eg. get all pools referred_by virtual service vs1 - referred_by=virtualservice:vs_vs1_uuid

fields (optional)

Query Parameter — List of fields to be returned for the resource. Some fields like name, URL, uuid etc. are always returned.

include_name (optional)

Query Parameter — All the Avi REST reference URIs have a name suffix as URI#name. It is useful to get the referenced resource name without performing get on that object.

skip_default (optional)

Query Parameter — Default values are not set.

join_subresources (optional)

Query Parameter — It automatically returns additional dependent resources like runtime. Eg. join_subresources=runtime.

Return type

SystemLimitsApiResponse

Example data

Content-Type: application/json

{
  "next" : "aeiou",
  "count" : 123,
  "results" : [ {
    "controller_limits" : {
      "pools_per_virtualservice" : 123,
      "certificates_per_virtualservice" : 123,
      "default_routes_per_vrfcontext" : 123,
      "vs_l2_scaleout" : 123,
      "rules_per_httppolicy" : 123,
      "strings_per_stringgroup" : 123,
      "routes_per_vrfcontext" : 123,
      "ips_per_ipgroup" : 123,
      "poolgroups_per_virtualservice" : 123,
      "servers_per_pool" : 123,
      "controller_sizing_limits" : [ {
        "flavor" : "aeiou",
        "num_tenants" : 123,
        "num_virtualservices_rt_metrics" : 123,
        "num_serviceengines" : 123,
        "controller_sizing_cloud_limits" : [ {
          "num_clouds" : 123,
          "type" : "aeiou"
        } ],
        "num_east_west_virtualservices" : 123,
        "num_virtualservices" : 123,
        "num_servers" : 123,
        "num_clouds" : 123,
        "num_vrfs" : 123
      } ],
      "pools_per_poolgroup" : 123,
      "controller_cloud_limits" : [ {
        "num_clouds" : 123,
        "type" : "aeiou"
      } ],
      "sni_children_per_parent" : 123,
      "vs_bgp_scaleout" : 123,
      "rules_per_networksecuritypolicy" : 123
    },
    "controller_sizes" : [ {
      "flavor" : "aeiou",
      "min_cpus" : 123,
      "min_memory" : 123
    } ],
    "serviceengine_limits" : {
      "num_virtualservices_rt_metrics" : 123,
      "num_vlan_intf_per_se" : 123,
      "serviceengine_cloud_limits" : [ {
        "type" : "aeiou",
        "vrfs_per_serviceengine" : 123
      } ],
      "num_vlan_intf_per_phy_intf" : 123,
      "all_virtualservices_per_serviceengine" : 123,
      "ew_virtualservices_per_serviceengine" : 123,
      "num_logical_intf_per_se" : 123,
      "num_phy_intf_per_se" : 123,
      "ns_virtualservices_per_serviceengine" : 123
    },
    "uuid" : "aeiou",
    "url" : "aeiou",
    "_last_modified" : "aeiou"
  } ]
}

Produces

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

application/json

Responses

200

OK SystemLimitsApiResponse

401

post /systemlimits

(systemlimitsPost)

Consumes

This API call consumes the following media types via the Content-Type request header:

application/json

Request body

body (required)

Body Parameter — SystemLimits object creation

Return type

SystemLimits

Example data

Content-Type: application/json

{
  "controller_limits" : {
    "pools_per_virtualservice" : 123,
    "certificates_per_virtualservice" : 123,
    "default_routes_per_vrfcontext" : 123,
    "vs_l2_scaleout" : 123,
    "rules_per_httppolicy" : 123,
    "strings_per_stringgroup" : 123,
    "routes_per_vrfcontext" : 123,
    "ips_per_ipgroup" : 123,
    "poolgroups_per_virtualservice" : 123,
    "servers_per_pool" : 123,
    "controller_sizing_limits" : [ {
      "flavor" : "aeiou",
      "num_tenants" : 123,
      "num_virtualservices_rt_metrics" : 123,
      "num_serviceengines" : 123,
      "controller_sizing_cloud_limits" : [ {
        "num_clouds" : 123,
        "type" : "aeiou"
      } ],
      "num_east_west_virtualservices" : 123,
      "num_virtualservices" : 123,
      "num_servers" : 123,
      "num_clouds" : 123,
      "num_vrfs" : 123
    } ],
    "pools_per_poolgroup" : 123,
    "controller_cloud_limits" : [ {
      "num_clouds" : 123,
      "type" : "aeiou"
    } ],
    "sni_children_per_parent" : 123,
    "vs_bgp_scaleout" : 123,
    "rules_per_networksecuritypolicy" : 123
  },
  "controller_sizes" : [ {
    "flavor" : "aeiou",
    "min_cpus" : 123,
    "min_memory" : 123
  } ],
  "serviceengine_limits" : {
    "num_virtualservices_rt_metrics" : 123,
    "num_vlan_intf_per_se" : 123,
    "serviceengine_cloud_limits" : [ {
      "type" : "aeiou",
      "vrfs_per_serviceengine" : 123
    } ],
    "num_vlan_intf_per_phy_intf" : 123,
    "all_virtualservices_per_serviceengine" : 123,
    "ew_virtualservices_per_serviceengine" : 123,
    "num_logical_intf_per_se" : 123,
    "num_phy_intf_per_se" : 123,
    "ns_virtualservices_per_serviceengine" : 123
  },
  "uuid" : "aeiou",
  "url" : "aeiou",
  "_last_modified" : "aeiou"
}

Produces

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

application/json

Responses

200

OK SystemLimits

401

delete /systemlimits/{uuid}

(systemlimitsUuidDelete)

Path parameters

uuid (required)

Path Parameter — UUID of the object to fetch

Consumes

This API call consumes the following media types via the Content-Type request header:

application/json

Query parameters

name (optional)

Query Parameter — object name

Return type

String

Example data

Content-Type: application/json

"aeiou"

Produces

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

application/json

Responses

204

object deleted String

404

not found

get /systemlimits/{uuid}

(systemlimitsUuidGet)

Path parameters

uuid (required)

Path Parameter — UUID of the object to fetch

Consumes

This API call consumes the following media types via the Content-Type request header:

application/json

Query parameters

name (optional)

Query Parameter — object name

fields (optional)

Query Parameter — List of fields to be returned for the resource. Some fields like name, URL, uuid etc. are always returned.

include_name (optional)

Query Parameter — All the Avi REST reference URIs have a name suffix as URI#name. It is useful to get the referenced resource name without performing get on that object.

skip_default (optional)

Query Parameter — Default values are not set.

join_subresources (optional)

Query Parameter — It automatically returns additional dependent resources like runtime. Eg. join_subresources=runtime.

Return type

SystemLimits

Example data

Content-Type: application/json

{
  "controller_limits" : {
    "pools_per_virtualservice" : 123,
    "certificates_per_virtualservice" : 123,
    "default_routes_per_vrfcontext" : 123,
    "vs_l2_scaleout" : 123,
    "rules_per_httppolicy" : 123,
    "strings_per_stringgroup" : 123,
    "routes_per_vrfcontext" : 123,
    "ips_per_ipgroup" : 123,
    "poolgroups_per_virtualservice" : 123,
    "servers_per_pool" : 123,
    "controller_sizing_limits" : [ {
      "flavor" : "aeiou",
      "num_tenants" : 123,
      "num_virtualservices_rt_metrics" : 123,
      "num_serviceengines" : 123,
      "controller_sizing_cloud_limits" : [ {
        "num_clouds" : 123,
        "type" : "aeiou"
      } ],
      "num_east_west_virtualservices" : 123,
      "num_virtualservices" : 123,
      "num_servers" : 123,
      "num_clouds" : 123,
      "num_vrfs" : 123
    } ],
    "pools_per_poolgroup" : 123,
    "controller_cloud_limits" : [ {
      "num_clouds" : 123,
      "type" : "aeiou"
    } ],
    "sni_children_per_parent" : 123,
    "vs_bgp_scaleout" : 123,
    "rules_per_networksecuritypolicy" : 123
  },
  "controller_sizes" : [ {
    "flavor" : "aeiou",
    "min_cpus" : 123,
    "min_memory" : 123
  } ],
  "serviceengine_limits" : {
    "num_virtualservices_rt_metrics" : 123,
    "num_vlan_intf_per_se" : 123,
    "serviceengine_cloud_limits" : [ {
      "type" : "aeiou",
      "vrfs_per_serviceengine" : 123
    } ],
    "num_vlan_intf_per_phy_intf" : 123,
    "all_virtualservices_per_serviceengine" : 123,
    "ew_virtualservices_per_serviceengine" : 123,
    "num_logical_intf_per_se" : 123,
    "num_phy_intf_per_se" : 123,
    "ns_virtualservices_per_serviceengine" : 123
  },
  "uuid" : "aeiou",
  "url" : "aeiou",
  "_last_modified" : "aeiou"
}

Produces

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

application/json

Responses

200

OK SystemLimits

401

patch /systemlimits/{uuid}

(systemlimitsUuidPatch)

Path parameters

uuid (required)

Path Parameter — UUID of the object to fetch

Consumes

This API call consumes the following media types via the Content-Type request header:

application/json

Request body

body (required)

Body Parameter — SystemLimits object creation

Query parameters

name (optional)

Query Parameter — object name

Return type

SystemLimits

Example data

Content-Type: application/json

{
  "controller_limits" : {
    "pools_per_virtualservice" : 123,
    "certificates_per_virtualservice" : 123,
    "default_routes_per_vrfcontext" : 123,
    "vs_l2_scaleout" : 123,
    "rules_per_httppolicy" : 123,
    "strings_per_stringgroup" : 123,
    "routes_per_vrfcontext" : 123,
    "ips_per_ipgroup" : 123,
    "poolgroups_per_virtualservice" : 123,
    "servers_per_pool" : 123,
    "controller_sizing_limits" : [ {
      "flavor" : "aeiou",
      "num_tenants" : 123,
      "num_virtualservices_rt_metrics" : 123,
      "num_serviceengines" : 123,
      "controller_sizing_cloud_limits" : [ {
        "num_clouds" : 123,
        "type" : "aeiou"
      } ],
      "num_east_west_virtualservices" : 123,
      "num_virtualservices" : 123,
      "num_servers" : 123,
      "num_clouds" : 123,
      "num_vrfs" : 123
    } ],
    "pools_per_poolgroup" : 123,
    "controller_cloud_limits" : [ {
      "num_clouds" : 123,
      "type" : "aeiou"
    } ],
    "sni_children_per_parent" : 123,
    "vs_bgp_scaleout" : 123,
    "rules_per_networksecuritypolicy" : 123
  },
  "controller_sizes" : [ {
    "flavor" : "aeiou",
    "min_cpus" : 123,
    "min_memory" : 123
  } ],
  "serviceengine_limits" : {
    "num_virtualservices_rt_metrics" : 123,
    "num_vlan_intf_per_se" : 123,
    "serviceengine_cloud_limits" : [ {
      "type" : "aeiou",
      "vrfs_per_serviceengine" : 123
    } ],
    "num_vlan_intf_per_phy_intf" : 123,
    "all_virtualservices_per_serviceengine" : 123,
    "ew_virtualservices_per_serviceengine" : 123,
    "num_logical_intf_per_se" : 123,
    "num_phy_intf_per_se" : 123,
    "ns_virtualservices_per_serviceengine" : 123
  },
  "uuid" : "aeiou",
  "url" : "aeiou",
  "_last_modified" : "aeiou"
}

Produces

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

application/json

Responses

200

OK SystemLimits

401

put /systemlimits/{uuid}

(systemlimitsUuidPut)

Path parameters

uuid (required)

Path Parameter — UUID of the object to fetch

Consumes

This API call consumes the following media types via the Content-Type request header:

application/json

Request body

body (required)

Body Parameter — SystemLimits object creation

Query parameters

name (optional)

Query Parameter — object name

Return type

SystemLimits

Example data

Content-Type: application/json

{
  "controller_limits" : {
    "pools_per_virtualservice" : 123,
    "certificates_per_virtualservice" : 123,
    "default_routes_per_vrfcontext" : 123,
    "vs_l2_scaleout" : 123,
    "rules_per_httppolicy" : 123,
    "strings_per_stringgroup" : 123,
    "routes_per_vrfcontext" : 123,
    "ips_per_ipgroup" : 123,
    "poolgroups_per_virtualservice" : 123,
    "servers_per_pool" : 123,
    "controller_sizing_limits" : [ {
      "flavor" : "aeiou",
      "num_tenants" : 123,
      "num_virtualservices_rt_metrics" : 123,
      "num_serviceengines" : 123,
      "controller_sizing_cloud_limits" : [ {
        "num_clouds" : 123,
        "type" : "aeiou"
      } ],
      "num_east_west_virtualservices" : 123,
      "num_virtualservices" : 123,
      "num_servers" : 123,
      "num_clouds" : 123,
      "num_vrfs" : 123
    } ],
    "pools_per_poolgroup" : 123,
    "controller_cloud_limits" : [ {
      "num_clouds" : 123,
      "type" : "aeiou"
    } ],
    "sni_children_per_parent" : 123,
    "vs_bgp_scaleout" : 123,
    "rules_per_networksecuritypolicy" : 123
  },
  "controller_sizes" : [ {
    "flavor" : "aeiou",
    "min_cpus" : 123,
    "min_memory" : 123
  } ],
  "serviceengine_limits" : {
    "num_virtualservices_rt_metrics" : 123,
    "num_vlan_intf_per_se" : 123,
    "serviceengine_cloud_limits" : [ {
      "type" : "aeiou",
      "vrfs_per_serviceengine" : 123
    } ],
    "num_vlan_intf_per_phy_intf" : 123,
    "all_virtualservices_per_serviceengine" : 123,
    "ew_virtualservices_per_serviceengine" : 123,
    "num_logical_intf_per_se" : 123,
    "num_phy_intf_per_se" : 123,
    "ns_virtualservices_per_serviceengine" : 123
  },
  "uuid" : "aeiou",
  "url" : "aeiou",
  "_last_modified" : "aeiou"
}

Produces

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

application/json

Responses

200

OK SystemLimits

401

Models

[ Jump to Methods ]

ControllerCloudLimits
ControllerLimits
ControllerSize
ControllerSizingCloudLimits
ControllerSizingLimits
ServiceEngineCloudLimits
ServiceEngineLimits
SystemLimits
SystemLimitsApiResponse

ControllerCloudLimits Up

num_clouds (optional)

Integer Maximum number of clouds of a given type. Field introduced in 20.1.1. format: int32

type (optional)

String Cloud type for the limit. 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. Field introduced in 20.1.1.

ControllerLimits Up

certificates_per_virtualservice (optional)

Integer Maximum number of certificates per virtualservice. Field introduced in 20.1.1. format: int32

controller_cloud_limits (optional)

array[ControllerCloudLimits] Controller system limits specific to cloud type for all controller sizes. Field introduced in 20.1.1.

controller_sizing_limits (optional)

array[ControllerSizingLimits] Controller system limits specific to controller sizing. Field introduced in 20.1.1. Maximum of 4 items allowed.

default_routes_per_vrfcontext (optional)

Integer Maximum number of default routes per vrfcontext. Field introduced in 20.1.1. format: int32

ips_per_ipgroup (optional)

Integer Maximum number of IP's per ipaddrgroup. Field introduced in 20.1.1. format: int32

poolgroups_per_virtualservice (optional)

Integer Maximum number of poolgroups per virtualservice. Field introduced in 20.1.1. format: int32

pools_per_poolgroup (optional)

Integer Maximum number of pools per poolgroup. Field introduced in 20.1.1. format: int32

pools_per_virtualservice (optional)

Integer Maximum number of pools per virtualservice. Field introduced in 20.1.1. format: int32

routes_per_vrfcontext (optional)

Integer Maximum number of routes per vrfcontext. Field introduced in 20.1.1. format: int32

rules_per_httppolicy (optional)

Integer Maximum number of rules per httppolicy. Field introduced in 20.1.1. format: int32

rules_per_networksecuritypolicy (optional)

Integer Maximum number of rules per networksecuritypolicy. Field introduced in 20.1.1. format: int32

servers_per_pool (optional)

Integer Maximum number of servers per pool. Field introduced in 20.1.1. format: int32

sni_children_per_parent (optional)

Integer Maximum number of SNI children virtualservices per SNI parent virtualservice. Field introduced in 20.1.1. format: int32

strings_per_stringgroup (optional)

Integer Maximum number of strings per stringgroup. Field introduced in 20.1.1. format: int32

vs_bgp_scaleout (optional)

Integer Maximum number of serviceengine per virtualservice in bgp scaleout mode. Field introduced in 20.1.1. format: int32

vs_l2_scaleout (optional)

Integer Maximum number of serviceengine per virtualservice in layer 2 scaleout mode. Field introduced in 20.1.1. format: int32

ControllerSize Up

flavor (optional)

String Controller flavor (E/S/M/L) for this controller size. Enum options - CONTROLLER_ESSENTIALS, CONTROLLER_SMALL, CONTROLLER_MEDIUM, CONTROLLER_LARGE. Field introduced in 20.1.1.

min_cpus (optional)

Integer Minimum number of cpu cores required. Field introduced in 20.1.1. format: int32

min_memory (optional)

Integer Minimum memory required. Field introduced in 20.1.1. Unit is GB. format: int32

ControllerSizingCloudLimits Up

num_clouds (optional)

Integer Maximum number of clouds of a given type. Field introduced in 20.1.1. format: int32

type (optional)

ControllerSizingLimits Up

controller_sizing_cloud_limits (optional)

array[ControllerSizingCloudLimits] Controller system limits specific to cloud type for this controller sizing. Field introduced in 20.1.1.

flavor (optional)

String Controller flavor (S/M/L) for this sizing limit. Enum options - CONTROLLER_ESSENTIALS, CONTROLLER_SMALL, CONTROLLER_MEDIUM, CONTROLLER_LARGE. Field introduced in 20.1.1.

num_clouds (optional)

Integer Maximum number of clouds. Field introduced in 20.1.1. format: int32

num_east_west_virtualservices (optional)

Integer Maximum number of east-west virtualservices. Field introduced in 20.1.1. format: int32

num_servers (optional)

Integer Maximum number of servers. Field introduced in 20.1.1. format: int32

num_serviceengines (optional)

Integer Maximum number of serviceengines. Field introduced in 20.1.1. format: int32

num_tenants (optional)

Integer Maximum number of tenants. Field introduced in 20.1.1. format: int32

num_virtualservices (optional)

Integer Maximum number of virtualservices. Field introduced in 20.1.1. format: int32

num_virtualservices_rt_metrics (optional)

Integer Maximum number of virtualservices with realtime metrics enabled. Field introduced in 20.1.1. format: int32

num_vrfs (optional)

Integer Maximum number of vrfcontexts. Field introduced in 20.1.1. format: int32

ServiceEngineCloudLimits Up

type (optional)

String Cloud type for this cloud limit. 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. Field introduced in 20.1.1.

vrfs_per_serviceengine (optional)

Integer Maximum number of vrfcontexts per serviceengine. Field introduced in 20.1.1. format: int32

ServiceEngineLimits Up

all_virtualservices_per_serviceengine (optional)

Integer Maximum number of virtualservices per serviceengine, including east-west virtualservices. Field introduced in 20.1.1. format: int32

ew_virtualservices_per_serviceengine (optional)

Integer Maximum number of east-west virtualservices per serviceengine, excluding north-south virtualservices. Field introduced in 20.1.1. format: int32

ns_virtualservices_per_serviceengine (optional)

Integer Maximum number of north-south virtualservices per serviceengine, excluding east-west virtualservices. Field introduced in 20.1.1. format: int32

num_logical_intf_per_se (optional)

Integer Maximum number of logical interfaces (vlan, bond) per serviceengine. Field introduced in 20.1.1. format: int32

num_phy_intf_per_se (optional)

Integer Maximum number of physical interfaces per serviceengine. Field introduced in 20.1.1. format: int32

num_virtualservices_rt_metrics (optional)

Integer Maximum number of virtualservices with realtime metrics enabled. Field introduced in 20.1.1. format: int32

num_vlan_intf_per_phy_intf (optional)

Integer Maximum number of vlan interfaces per physical interface. Field introduced in 20.1.1. format: int32

num_vlan_intf_per_se (optional)

Integer Maximum number of vlan interfaces per serviceengine. Field introduced in 20.1.1. format: int32

serviceengine_cloud_limits (optional)

array[ServiceEngineCloudLimits] Serviceengine system limits specific to cloud type. Field introduced in 20.1.1.

SystemLimits Up

_last_modified (optional)

String UNIX time since epoch in microseconds. Units(MICROSECONDS).

controller_limits (optional)

ControllerLimits System limits for the entire controller cluster. Field introduced in 20.1.1.

controller_sizes (optional)

array[ControllerSize] Possible controller sizes. Field introduced in 20.1.1.

serviceengine_limits (optional)

ServiceEngineLimits System limits that apply to a serviceengine. Field introduced in 20.1.1.

url (optional)

String url

uuid (optional)

String UUID for the system limits object. Field introduced in 20.1.1.

SystemLimitsApiResponse Up

count

Integer format: int32

results

array[SystemLimits]

next (optional)

String

Avi SystemLimits Object API

Access

Table of Contents

Consumes

Query parameters

Return type

Example data

Produces

Responses

200

401

Consumes

Request body

Return type

Example data

Produces

Responses

200

401

Path parameters

Consumes

Query parameters

Return type

Example data

Produces

Responses

204

404

Path parameters

Consumes

Query parameters

Return type

Example data

Produces

Responses

200

401

Path parameters

Consumes

Request body

Query parameters

Return type

Example data

Produces

Responses

200

401

Path parameters

Consumes

Request body

Query parameters

Return type

Example data

Produces

Responses

200

401

Table of Contents