_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 |
|
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 |
errors |
Errors occurred during full sync
Errors occurred during full sync.
|
array of string |
Readonly |
full_sync_id |
Full sync id
Full sync id generated by Async Replicator (AR) service.
|
string |
Readonly |
id |
Unique identifier of this resource |
string |
Sortable |
last_completed_stage |
Full sync stage that is last completed for this request.
The current stage of full sync completion for ongoing sync.
When Local Manager (LM) receives full sync data from AR, LM starts
with workflow to prserve the state and restore the full sync from
where it has left off in case of change of leadership of the service
to different NSX node or LM is restarted.
LM starts the full sync workflow with state INITIAL capturing the
AR full sync id and data location details. The stage/state transition
follows the order given below
INITIAL - Full sync started
PROCESSED_FULLSYNC_DATA - Compelted processing the full state data
provided by AR
PRCESSED_DELTAS - Completed processing pending delta changes provided
by AR.
DELETED_STALE_ENTITIES - Completed deletion of all global entities on
LM that are not in GM anymore
COMPLETED - Full sync handling is completed on LM
ERROR - Full sync failed with errors on LM, in which case AR will
re-attempt full sync later point in time for the LM
ABORTED - Indicates that the full sync cancelled as per user request
|
string |
Readonly Enum: INITIAL, PAUSE_DCNS, DELETED_STALE_ENTITIES, PROCESSED_FULLSYNC_DATA, PROCESSED_DELTAS, UNPAUSE_DCNS, COMPLETED, ERROR, ABORTED |
last_upate_time |
Timestamp of last update, could be progress or success or error. |
EpochMsTimestamp |
Readonly 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" |
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 FullSyncState |
string |
|
start_time |
Timestamp of Full Sync start. |
EpochMsTimestamp |
Readonly Sortable |
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 |