If a community list with the community-list-id is not already present,
create a new community list. If it already exists, replace the community
list instance with the new object.
This API is available when using VMware Cloud (AWS, Dell-EMC, Outpost, Hyperscalers) or VMware NSX.
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.
List of BGP community entries. Both standard and large communities
are supported. Standard community format: aa:nn where aa and nn must
be within the range [1 - 65536]. Large BGP Community format: aa:bb:nn
where aa (Global Administrator), bb (Local Data Part 1) and nn (Local
Data Part 2) must be within the range [1 - 4294967295]. In additon to
numbered communites (e.g. 3356:2040), predefined communities (NO_EXPORT,
NO_ADVERTISE, NO_EXPORT_SUBCONFED) are supported.
array of string
Required Minimum items: 1
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
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"
origin_site_id
A unique identifier assigned by the system for knowing which site owns an object
This is a UUID generated by the system for knowing which site owns an object.
This is used in NSX+.
string
Readonly
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"
owner_id
A unique identifier assigned by the system for the ownership of an object
This is a UUID generated by the system for knowing who owns this object.
This is used in NSX+.
string
Readonly
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 their
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
remote_path
Path of the object on the remote end.
This is the path of the object on the local managers when queried on the NSX+ service,
and path of the object on NSX+ service when queried from the local managers.
This is a UUID generated by the GM/LM to uniquely identify
entities in a federated environment. For entities that are
stretched across multiple sites, the same ID will be used
on all the stretched sites.
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.
List of BGP community entries. Both standard and large communities
are supported. Standard community format: aa:nn where aa and nn must
be within the range [1 - 65536]. Large BGP Community format: aa:bb:nn
where aa (Global Administrator), bb (Local Data Part 1) and nn (Local
Data Part 2) must be within the range [1 - 4294967295]. In additon to
numbered communites (e.g. 3356:2040), predefined communities (NO_EXPORT,
NO_ADVERTISE, NO_EXPORT_SUBCONFED) are supported.
array of string
Required Minimum items: 1
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
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"
origin_site_id
A unique identifier assigned by the system for knowing which site owns an object
This is a UUID generated by the system for knowing which site owns an object.
This is used in NSX+.
string
Readonly
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"
owner_id
A unique identifier assigned by the system for the ownership of an object
This is a UUID generated by the system for knowing who owns this object.
This is used in NSX+.
string
Readonly
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 their
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
remote_path
Path of the object on the remote end.
This is the path of the object on the local managers when queried on the NSX+ service,
and path of the object on NSX+ service when queried from the local managers.
This is a UUID generated by the GM/LM to uniquely identify
entities in a federated environment. For entities that are
stretched across multiple sites, the same ID will be used
on all the stretched sites.