| _create_time |
Timestamp of resource creation |
EpochMsTimestamp |
Readonly
Sortable |
| _create_user |
ID of the user who created this resource |
string |
Readonly |
| _last_modified_time |
Timestamp of last modification |
EpochMsTimestamp |
Readonly
Sortable |
| _last_modified_user |
ID of the user who last modified this resource |
string |
Readonly |
| _links |
References related to this resource
The server will populate this field when returing the resource. Ignored on PUT and POST. |
array of ResourceLink |
Readonly |
| _protection |
Indicates protection status of this resource
Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
|
string |
Readonly |
| _revision |
Generation of this resource config
The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. |
int |
|
| _schema |
Schema for this resource |
string |
Readonly |
| _self |
Link to this resource |
SelfResourceLink |
Readonly |
| _system_owned |
Indicates system owned resource |
boolean |
Readonly |
| children |
subtree for this type within policy tree
subtree for this type within policy tree containing nested elements.
|
array of ChildPolicyConfigResource
Children are not allowed for this type |
|
| delay_for_server_garbage_collection |
Delay for server garbage collection
Delay in minutes after which a down server will be removed
from Pool.
Value 0 disables this functionality.
Default value when not specified in API or module is
interpreted by ALB Controller as 0.
|
integer |
Default: "0" |
| description |
Description of this resource |
string |
Maximum length: 1024
Sortable |
| display_name |
Identifier to use when displaying entity in logs or GUI
Defaults to ID if not set |
string |
Maximum length: 255
Sortable |
| id |
Unique identifier of this resource |
string |
Sortable |
| intelligent_autoscale |
Intelligent autoscale
Use Avi intelligent autoscale algorithm where autoscale is
performed by comparing load on the pool against estimated
capacity of all the servers.
Default value when not specified in API or module is
interpreted by ALB Controller as false.
|
boolean |
Default: "False" |
| intelligent_scalein_margin |
Intelligent scalein margin
Maximum extra capacity as percentage of load used by the
intelligent scheme.
Scalein is triggered when available capacity is more than
this margin.
Allowed values are 1-99.
Default value when not specified in API or module is
interpreted by ALB Controller as 40.
|
integer |
Minimum: 1
Maximum: 99
Default: "40" |
| intelligent_scaleout_margin |
Intelligent scaleout margin
Minimum extra capacity as percentage of load used by the
intelligent scheme.
Scaleout is triggered when available capacity is less than
this margin.
Allowed values are 1-99.
Default value when not specified in API or module is
interpreted by ALB Controller as 20.
|
integer |
Minimum: 1
Maximum: 99
Default: "20" |
| marked_for_delete |
Indicates whether the intent object is marked for deletion
Intent objects are not directly deleted from the system when a delete
is invoked on them. They are marked for deletion and only when all the
realized entities for that intent object gets deleted, the intent object
is deleted. Objects that are marked for deletion are not returned in
GET call. One can use the search API to get these objects.
|
boolean |
Readonly
Default: "False" |
| markers |
Markers
List of labels to be used for granular RBAC.
Allowed in Basic edition, Essentials edition, Enterprise
edition.
|
array of ALBRoleFilterMatchLabel |
|
| max_scalein_adjustment_step |
Max scalein adjustment step
Maximum number of servers to scalein simultaneously.
The actual number of servers to scalein is chosen such that
target number of servers is always more than or equal to the
min_size.
Default value when not specified in API or module is
interpreted by ALB Controller as 1.
|
integer |
Default: "1" |
| max_scaleout_adjustment_step |
Max scaleout adjustment step
Maximum number of servers to scaleout simultaneously.
The actual number of servers to scaleout is chosen such
that target number of servers is always less than or equal
to the max_size.
Default value when not specified in API or module is
interpreted by ALB Controller as 1.
|
integer |
Default: "1" |
| max_size |
Max size
Maximum number of servers after scaleout.
Allowed values are 0-400.
|
integer |
Minimum: 0
Maximum: 400 |
| min_size |
Min size
No scale-in happens once number of operationally up servers
reach min_servers.
Allowed values are 0-400.
|
integer |
Minimum: 0
Maximum: 400 |
| overridden |
Indicates whether this object is the overridden intent object
Global intent objects cannot be modified by the user.
However, certain global intent objects can be overridden locally by use
of this property. In such cases, the overridden local values take
precedence over the globally defined values for the properties.
|
boolean |
Readonly
Default: "False" |
| parent_path |
Path of its parent
Path of its parent |
string |
Readonly |
| path |
Absolute path of this object
Absolute path of this object |
string |
Readonly |
| realization_id |
A unique identifier assigned by the system for realizing intent
This is a UUID generated by the system for realizing the entity object.
In most cases this should be same as 'unique_id' of the entity. However,
in some cases this can be different because of entities have migrated thier
unique identifier to NSX Policy intent objects later in the timeline and did
not use unique_id for realization. Realization id is helpful for users to
debug data path to correlate the configuration with corresponding intent.
|
string |
Readonly |
| relative_path |
Relative path of this object
Path relative from its parent |
string |
Readonly |
| resource_type |
Must be set to the value ALBServerAutoScalePolicy |
string |
|
| scalein_cooldown |
Scalein cooldown
Cooldown period during which no new scalein is triggered to
allow previous scalein to successfully complete.
Unit is SEC.
Default value when not specified in API or module is
interpreted by ALB Controller as 300.
|
integer |
Default: "300" |
| scaleout_cooldown |
Scaleout cooldown
Cooldown period during which no new scaleout is triggered
to allow previous scaleout to successfully complete.
Unit is SEC.
Default value when not specified in API or module is
interpreted by ALB Controller as 300.
|
integer |
Default: "300" |
| tags |
Opaque identifiers meaningful to the API user |
array of Tag |
Maximum items: 30 |
| unique_id |
A unique identifier assigned by the system
This is a UUID generated by the GM/LM to uniquely identify
entites in a federated environment. For entities that are
stretched across multiple sites, the same ID will be used
on all the stretched sites.
|
string |
Readonly |
| use_predicted_load |
Use predicted load
Use predicted load rather than current load.
Default value when not specified in API or module is
interpreted by ALB Controller as false.
|
boolean |
Default: "False" |