| _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)
ChildInfra |
|
| 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 |
| is_auto_draft |
Auto draft flag
Flag to indicate whether draft is auto created.
True indicates that the draft is an auto draft.
False indicates that the draft is a manual draft.
|
boolean |
Readonly
Default: "False" |
| lock_comments |
Policy draft lock/unlock comments
Comments for a policy draft lock/unlock. |
string |
|
| lock_modified_by |
User who locked a policy draft
ID of the user who last modified the lock for a policy draft.
|
string |
Readonly |
| lock_modified_time |
Policy draft locked/unlocked time
Policy draft locked/unlocked time in epoch milliseconds. |
EpochMsTimestamp |
Readonly |
| locked |
Lock a policy draft
Indicates whether a draft should be locked. If the draft is locked by
an user, then no other user would be able to modify or publish this
draft. Once the user releases the lock, other users can then modify
or publish this draft.
|
boolean |
Default: "False" |
| 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 |
| 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 |
| ref_draft_path |
Path of an existing draft for reference
When specified, a manual draft will be created w.r.t. the specified
draft. If not specified, manual draft will be created w.r.t. the
current published configuration.
For an auto draft, this will always be null.
|
string |
|
| relative_path |
Relative path of this object
Path relative from its parent |
string |
Readonly |
| resource_type |
Must be set to the value PolicyDraft |
string |
|
| system_area |
Configuration changes tracked by the system
Configuration changes against the current configuration,
tracked by the system.
The value is stored in a hierarchical body format.
|
Infra |
Readonly |
| system_area_store_id |
ID of the data store where system_area has stored
In case of a large draft, wherein the size of system_area is so big
that it can not be stored into one draft object, the data is then gets
stored into multiple chunks in a draft data store.
This value represents the ID of that data store.
|
string |
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 |
| user_area |
User defined configuration changes
These are user defined configuration changes, which are applicable only
in case of manual drafts. During the publish of a draft, system_area
changes gets applied first, and then these changes.
The value must be in a hierarchical body format.
|
Infra |
|
| user_area_store_id |
ID of the data store where user_area has stored
In case of a large draft, wherein the size of user_area is so big
that it can not be stored into one draft object, the data is then gets
stored into multiple chunks in a draft data store.
This value represents the ID of that data store.
|
string |
Readonly |