| _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 |
| bgp_peer_labels |
Bgp peer labels
Select BGP peers, using peer label, for VsVip
advertisement.
Maximum of 128 items allowed.
|
array of string |
|
| 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 |
|
| cloud_name |
Cloud name
It is a reference to an object of type Cloud. |
string |
|
| 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 |
| dns_info |
Dns info
Service discovery specific data including fully qualified
domain name, type and Time-To-Live of the DNS record.
Maximum of 1000 items allowed.
Allowed in Basic edition, Essentials edition, Enterprise
edition.
|
array of ALBDnsInfo |
|
| east_west_placement |
East west placement
Force placement on all Service Engines in the Service
Engine Group (Container clouds only).
Allowed in Basic(Allowed values- false) edition,
Essentials(Allowed values- false) edition, Enterprise
edition.
Default value when not specified in API or module is
interpreted by ALB Controller as false.
|
boolean |
Default: "False" |
| id |
Unique identifier of this resource |
string |
Sortable |
| 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 |
|
| 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 ALBVsVip |
string |
|
| tags |
Opaque identifiers meaningful to the API user |
array of Tag |
Maximum items: 30 |
| tier1_path |
Tier1 path
This sets the placement scope of virtualservice to given
tier1 logical router in Nsx-t.
|
string |
|
| 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_standard_alb |
Use standard alb
This overrides the cloud level default and needs to match
the SE Group value in which it will be used if the SE Group
use_standard_alb value is set.
This is only used when FIP is used for VS on Azure Cloud.
Allowed in Basic edition, Essentials edition, Enterprise
edition.
|
boolean |
|
| vip |
Vip
List of Virtual Service IPs and other shareable entities. |
array of ALBVip |
|
| vrf_context_name |
Vrf context name
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.
|
string |
|
| vsvip_cloud_config_cksum |
Vsvip cloud config cksum
Checksum of cloud configuration for VsVip.
Internally set by cloud connector.
|
string |
|