Policy > Infra > Realized State

Associated URIs:

API Description API Path

List All alarms in the system


Paginated list of all alarms.
GET /policy/api/v1/infra/realized-state/alarms

List Enforcement Points


Paginated list of all enforcement points. Returns the populated enforcement points.
GET /policy/api/v1/infra/realized-state/enforcement-points (Experimental)

Read Enforcement Point


Read a Enforcement Point and the complete tree underneath. Returns the populated enforcement point object.
GET /policy/api/v1/infra/realized-state/enforcement-points/<enforcement-point-name> (Experimental)

List Firewall Sections


Paginated list of all Firewalls. Returns populated Firewalls.
GET /policy/api/v1/infra/realized-state/enforcement-points/<enforcement-point-name>/firewalls/firewall-sections (Experimental) (Deprecated)

Read Firewall


Read a Firewall and the complete tree underneath. Returns the
populated Firewall object.
GET /policy/api/v1/infra/realized-state/enforcement-points/<enforcement-point-name>/firewalls/firewall-sections/<firewall-section-id> (Experimental) (Deprecated)

List NS Groups


Paginated list of all NSGroups. Returns populated NSGroups.
GET /policy/api/v1/infra/realized-state/enforcement-points/<enforcement-point-name>/groups/nsgroups (Experimental) (Deprecated)

Read Group


Read a NSGroup and the complete tree underneath. Returns the
populated NSgroup object.
GET /policy/api/v1/infra/realized-state/enforcement-points/<enforcement-point-name>/groups/nsgroups/<nsgroup-name> (Experimental) (Deprecated)

List Security Groups


Paginated list of all Security Groups. Returns populated Security Groups.
GET /policy/api/v1/infra/realized-state/enforcement-points/<enforcement-point-name>/groups/securitygroups (Experimental) (Deprecated)

Read Group


Read a Security Group and the complete tree underneath. Returns the
populated Security Group object.
GET /policy/api/v1/infra/realized-state/enforcement-points/<enforcement-point-name>/groups/securitygroups/<securitygroup-name> (Experimental) (Deprecated)

List IPSets


Paginated list of all Realized IPSets
GET /policy/api/v1/infra/realized-state/enforcement-points/<enforcement-point-name>/ip-sets/ip-sets-nsxt (Experimental) (Deprecated)

Read IPSet Realized state


Read an IPSet
GET /policy/api/v1/infra/realized-state/enforcement-points/<enforcement-point-name>/ip-sets/ip-sets-nsxt/<ip-set-name> (Experimental) (Deprecated)

List MACSets


Paginated list of all Realized MACSets
GET /policy/api/v1/infra/realized-state/enforcement-points/<enforcement-point-name>/mac-sets/mac-sets-nsxt (Experimental) (Deprecated)

Read MACSet Realized state


Read an MACSet
GET /policy/api/v1/infra/realized-state/enforcement-points/<enforcement-point-name>/mac-sets/mac-sets-nsxt/<mac-set-name> (Experimental) (Deprecated)

List Realized NSServices


Paginated list of all Realized NSService.
GET /policy/api/v1/infra/realized-state/enforcement-points/<enforcement-point-name>/services/nsservices (Experimental) (Deprecated)

Read NSService


Read a NSService.
GET /policy/api/v1/infra/realized-state/enforcement-points/<enforcement-point-name>/services/nsservices/<nsservice-name> (Experimental) (Deprecated)

Listing of VIFs on the NSX Manager


This API lists VIFs from the specified NSX Manager.
GET /policy/api/v1/infra/realized-state/enforcement-points/<enforcement-point-name>/vifs

Listing of Virtual machines on the NSX Manager


This API filters objects of type virtual machines from the specified NSX Manager.
This API has been deprecated. Please use the new API
GET /infra/realized-state/virtual-machines
GET /policy/api/v1/infra/realized-state/enforcement-points/<enforcement-point-name>/virtual-machines (Deprecated)

Apply tags on virtual machine


Allows an admin to apply multiple tags to a virtual machine. This operation
does not store the intent on the policy side. It applies the tag directly
on the specified enforcement point. This operation will replace the existing
tags on the virtual machine with the ones that have been passed. If the
application of tag fails on the enforcement point, then an error is
reported. The admin will have to retry the operation again. Policy
framework does not perform a retry. Failure could occur due to multiple
reasons. For e.g enforcement point is down, Enforcement point could not
apply the tag due to constraints like max tags limit exceeded, etc.
POST /policy/api/v1/infra/realized-state/enforcement-points/<enforcement-point-name>/virtual-machines?action=update_tags

Read the details of a virtual machine on the NSX Manager


This API return optional details about a virtual machines (e.g. user login session) from the
specified enforcement point.
In case of NSXT, virtual-machine-id would be the value of the external_id of the virtual machine.
GET /policy/api/v1/infra/realized-state/enforcement-points/<enforcement-point-name>/virtual-machines/<virtual-machine-id>/details

Get list of realized objects associated with intent object


Get list of realized entities associated with intent object,
specified by path in query parameter
GET /policy/api/v1/infra/realized-state/realized-entities

Get realized entity uniquely identified by realized path


Get realized entity uniquely identified by realized path,
specified by query parameter
GET /policy/api/v1/infra/realized-state/realized-entity

Refresh all realized entities associated with the intent-path


Refresh the status and statistics of all realized entities associated
with given intent path synchronously. The vmw-async: True HTTP header
cannot be used with this API.
POST /policy/api/v1/infra/realized-state/realized-entity?action=refresh

Get consolidated status of an intent object


Get Consolidated Status of an intent object (with or without enforcement specific status details).
The request is evaluated as follows:
- : the request is evaluated on all enforcement points for the given intent without
enforcement point specific details.
- : the request is evaluated on all enforcement points for
the given intent with enforcement point specific details.
GET /policy/api/v1/infra/realized-state/status

List all virtual machines which are not part of any group


This API filters objects of type virtual machine which are not part of any group. This API also gives some VM
details such as VM name, IDs and the current state of the VMs.
GET /policy/api/v1/infra/realized-state/unassociated-virtual-machines

List all virtual machines


This API filters objects of type virtual machine. This API also gives some VM
details such as VM name, IDs and the current state of the VMs.
GET /policy/api/v1/infra/realized-state/virtual-machines