Realized Network and Security Group
| Name | Description | Type | Notes |
|---|---|---|---|
| _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 |
| alarms | Alarm info detail | array of PolicyAlarmResource | |
| 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 |
| evaluations | Evaluated members of Security Group Reference to the evaluted members of the Security Group. |
array of RealizedSecurityGroupMemberEvaluation | Readonly Maximum items: 500 |
| id | Unique identifier of this resource | string | Sortable |
| intent_reference | Desire state paths of this object | array of string | |
| operational_status | String representation of operational status Possible values could be UP, DOWN, UNKNOWN, FAILURE This list is not exhaustive. |
string | |
| operational_status_error | String representation of operational status error It defines the root cause for operational status error. |
string | |
| 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 Pmaas |
string | Readonly |
| 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 whoes owns this object. This is used in Pmaas |
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 |
| publish_status | String representation of publish status Possible values could be UP, DOWN, UNKNOWN, SUCCESS This list is not exhaustive. |
string | |
| publish_status_error | String representation of publish status error It defines the root cause for publish status error. |
string | |
| publish_status_error_code | Represents error code for publish status. It defines error code for publish status error. |
int | |
| publish_status_error_details | Details for publich status error. Error details for publish status. |
array of ConfigurationStateElement | |
| realization_api | Realization API of this object on enforcement point | string | |
| 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 |
| realization_specific_identifier | Realization id of this object | string | |
| 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 PMaaS service, and path of the object on PMaaS service when queried from the local managers. |
string | Readonly |
| resource_type | Must be set to the value RealizedSecurityGroup | string | Required Enum: RealizedNSGroup, RealizedSecurityGroup |
| runtime_error | String representation of runtime error It define the root cause for runtime error. |
string | |
| runtime_status | String representation of runtime status Possible values could be UP, DOWN, UNKNOWN, DEGRADED This list is not exhaustive. |
string | Deprecated |
| state | Realization state of this object | string | Required Enum: UNAVAILABLE, UNREALIZED, REALIZED, ERROR |
| 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 |