NSX-T Data Center REST API

Get realized entity uniquely identified by realized path

Get realized entity uniquely identified by realized path,
specified by query parameter
This API is available when using VMware Cloud (AWS, Dell-EMC, Outpost, Hyperscalers) or VMware NSX.

Request:

Method:

GET

URI Path(s):

/policy/api/v1/infra/realized-state/realized-entity

Request Headers:

n/a

Query Parameters:

RealizedPathRequestParameter+

Name	Description	Type	Notes
realized_path	String Path of the realized object Realized path of object, forward slashes must be escaped using %2F	string	Required

Request Body:

n/a

Example Request:

GET https://<policy-mgr>/policy/api/v1/infra/realized-state/realized-entity?realized_path=/infra/realized-state/enforcement-points/nsx-1/groups/nsgroups/DOMAIN-d1-g1

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

GenericPolicyRealizedResource+

GenericPolicyRealizedResource (schema)

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
enforcement_point_path	Enforcement Point Path The path of the enforcement point.	string	Readonly
entity_type	Type of realized entity	string	Readonly
extended_attributes	Collection of type specific properties	array of AttributeVal	Readonly
id	Unique identifier of this resource	string	Sortable
intent_paths	Collection of intent paths	array of string	Readonly
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 NSX+.	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 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
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
publish_time	Publish time of the intent This is the time when our system detects that data has been pushed to the transport nodes. This is based on a poll mechanism and hence this is not the accurate time when the intent was published at the data path. The value of -1 indicates that either the publishing is still in progress or the runtime status is UNKNOWN and hence not available. The Runtime status can be UNKNOWN if one or more hosts are down and the rules could not be sent to those hosts. When the host comes up, the runtime status will change to SUCCESS but the publish_time will show the value of the last realization time. Any new configuration change after this will start reflecting the proper value for publish_time	EpochMsTimestamp	Readonly Sortable
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 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
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 NSX+ service, and path of the object on NSX+ service when queried from the local managers.	string	Readonly
resource_type	Must be set to the value GenericPolicyRealizedResource	string
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
site_path	Site Path The site where this entity resides.	string	Readonly
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
time_taken_for_realization	Appoximate time taken in milliseconds for end to end realization. This is an approximate time taken for the realization of the intent to the data path. The actual time taken could be lesser than what is reported here. The value of -1 indicates that either the publishing is still in progress or the runtime status is UNKNOWN and hence not available. The Runtime status can be UNKNOWN if one or more hosts are down and the rules could not be sent to those hosts. When the host comes up, the runtime status will change to SUCCESS but the time taken for realization will show the value of the last realization time. Any new configuration change after this will start reflecting the proper value for time_taken_for_realization	integer
unique_id	A unique identifier assigned by the system 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.	string	Readonly

Example Response:

{ "resource_type": "GenericPolicyRealizedResource", "id": "DOMAIN-d1-g1", "display_name": "DOMAIN-d1-g1", "path": "/infra/realized-state/enforcement-points/nsx-1/groups/nsgroups/DOMAIN-d1-g1", "parent_path": "/infra/realized-state/enforcement-points/nsx-1", "relative_path": "DOMAIN-d1-g1", "intent_reference": [ "/infra/domains/d1/groups/g1" ], "realization_specific_identifier": "22db5ae1-f1d7-4fa0-aa98-6176a3b80d0d", "alarms": [], "state": "REALIZED", "runtime_status": "UNKNOWN", "publish_status": "UNKNOWN", "operational_status" : "UNKNOWN", "extended_attributes": [ { "values": [ "/infra/realized-state/enforcement-points/nsx-1/virtual-machines/564d1fb9-f50d-5533-d189-550394ba7252", "/infra/realized-state/enforcement-points/nsx-1/virtual-machines/564d2588-5ccf-7825-32f9-d5e1f344fe40", "/infra/realized-state/enforcement-points/nsx-1/virtual-machines/564d6341-5655-5cdb-2a90-fad1b762789b", "/infra/realized-state/enforcement-points/nsx-1/virtual-machines/564d922d-f3cb-ae5c-3e3d-d76a55990905" ], "data_type": "STRING", "key": "VIRTUAL_MACHINES", "multivalue": true } ], "entity_type": "RealizedGroup", "_create_user": "system", "_create_time": 1519051314478, "_last_modified_user": "admin", "_last_modified_time": 1519057587852, "_system_owned": false, "_protection": "NOT_PROTECTED", "_revision": 5 }

NSX-T Data Center REST API

Get realized entity uniquely identified by realized path

Request:

RealizedPathRequestParameter (schema)

Example Request:

Successful Response:

GenericPolicyRealizedResource (schema)

Example Response:

Required Permissions:

Feature:

Additional Errors: