_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 (Abstract type: pass one of the following concrete types) ChildEnforcementPoint |
|
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 |
fail_if_rtep_misconfigured |
Fail onboarding if RTEPs misconfigured
Both the local site and the remote site must have edge clusters correctly
configured and remote tunnel endpoint (RTEP) interfaces must be defined,
or onboarding will fail.
|
boolean |
Default: "True" |
fail_if_rtt_exceeded |
Fail onboarding if maximum RTT exceeded
Fail onboarding if maximum RTT exceeded.
|
boolean |
Default: "True" |
federation_config |
Federation releated config
System managed federation config. |
GmFederationSiteConfig |
Readonly |
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" |
maximum_rtt |
Maximum acceptable packet round trip time (RTT)
If provided and fail_if_rtt_exceeded is true, onboarding of the site will
fail if measured RTT is greater than this value.
|
integer |
Minimum: 0 Maximum: 1000 Default: "250" |
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 |
relative_path |
Relative path of this object
Path relative from its parent |
string |
Readonly |
resource_type |
Must be set to the value Site |
string |
|
site_connection_info |
Connection information
To onboard a site, the connection information (username, password,
and API thumbprint) for at least one NSX manager node in the remote
site must be provided. Once the site has been successfully onboarded,
the site_connection_info is discarded and authentication to the
remote site occurs using an X.509 client certificate.
|
array of SiteNodeConnectionInfo |
Maximum items: 3 |
site_number |
12-bit system generated site number |
integer |
Readonly |
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 |