Policy > Operations

Associated URIs:

API Description API Path

Returns the compliance status


Returns the compliance status and details of non compliant configuration
GET /policy/api/v1/compliance/status

For each type of entity what are the attributes owned by policy.


This API provides field names of attributes in NSX types that are owned by
Policy, as opposed to those owned by the enforcement point. For any type on NSX,
some of the attributes of that type may be owned and set by Policy when realizing
the intent, while some others may be owned and set by the enforcement point itself.
This information can be used to disable updates to Policy owned attributes by the
advanced networking UI, while allowing tweaking to the attributes owned by the
management plane.
GET /policy/api/v1/fine-tuning/resources

List IPFIX Collector profiles.


API will provide list of all IPFIX dfw collector profiles and
their details.
GET /policy/api/v1/infra/ipfix-dfw-collector-profiles
GET /policy/api/v1/global-infra/ipfix-dfw-collector-profiles

Delete IPFIX dfw Collector profile


API deletes IPFIX dfw collector profile. Flow forwarding to
collector will be stopped.
DELETE /policy/api/v1/infra/ipfix-dfw-collector-profiles/<ipfix-dfw-collector-profile-id>
DELETE /policy/api/v1/global-infra/ipfix-dfw-collector-profiles/<ipfix-dfw-collector-profile-id>

Get IPFIX dfw Collector profile


API will return details of IPFIX dfw collector profile. If profile
does not exist, it will return 404.
GET /policy/api/v1/infra/ipfix-dfw-collector-profiles/<ipfix-dfw-collector-profile-id>
GET /policy/api/v1/global-infra/ipfix-dfw-collector-profiles/<ipfix-dfw-collector-profile-id>

IPFIX dfw collector profile id


Create a new IPFIX dfw collector profile if the IPFIX dfw collector profile with
given id does not already exist. If the IPFIX dfw collector profile with the
given id already exists, patch with the existing IPFIX dfw collector profile.
PATCH /policy/api/v1/infra/ipfix-dfw-collector-profiles/<ipfix-dfw-collector-profile-id>
PATCH /policy/api/v1/global-infra/ipfix-dfw-collector-profiles/<ipfix-dfw-collector-profile-id>

Create or Replace IPFIX dfw collector profile


Create or Replace IPFIX dfw collector profile. IPFIX data will be sent to IPFIX
collector port.
PUT /policy/api/v1/infra/ipfix-dfw-collector-profiles/<ipfix-dfw-collector-profile-id>
PUT /policy/api/v1/global-infra/ipfix-dfw-collector-profiles/<ipfix-dfw-collector-profile-id>

List IPFIX DFW Profile


API provides list IPFIX DFW profiles available on
selected logical DFW.
GET /policy/api/v1/infra/ipfix-dfw-profiles
GET /policy/api/v1/global-infra/ipfix-dfw-profiles

Delete IPFIX DFW Profile


API deletes IPFIX DFW Profile. Selected IPFIX Collectors will stop
receiving flows.
DELETE /policy/api/v1/infra/ipfix-dfw-profiles/<ipfix-dfw-profile-id>
DELETE /policy/api/v1/global-infra/ipfix-dfw-profiles/<ipfix-dfw-profile-id>

Get IPFIX DFW Profile


API will return details of IPFIX DFW profile.
GET /policy/api/v1/infra/ipfix-dfw-profiles/<ipfix-dfw-profile-id>
GET /policy/api/v1/global-infra/ipfix-dfw-profiles/<ipfix-dfw-profile-id>

Patch IPFIX DFW profile


Create a new IPFIX DFW profile if the IPFIX DFW profile
with given id does not already exist. If the IPFIX DFW
profile with the given id already exists, patch with
the existing IPFIX DFW profile.
PATCH /policy/api/v1/infra/ipfix-dfw-profiles/<ipfix-dfw-profile-id>
PATCH /policy/api/v1/global-infra/ipfix-dfw-profiles/<ipfix-dfw-profile-id>

Create or Replace IPFIX DFW collection Config.


Create or replace IPFIX DFW profile. Config will start
forwarding data to provided IPFIX DFW collector.
PUT /policy/api/v1/infra/ipfix-dfw-profiles/<ipfix-dfw-profile-id>
PUT /policy/api/v1/global-infra/ipfix-dfw-profiles/<ipfix-dfw-profile-id>

List IPFIX Collector profiles.


API will provide list of all IPFIX collector profiles and their details.
GET /policy/api/v1/infra/ipfix-l2-collector-profiles
GET /policy/api/v1/global-infra/ipfix-l2-collector-profiles

Delete IPFIX Collector profile


API deletes IPFIX collector profile. Flow forwarding to
collector will be stopped.
DELETE /policy/api/v1/infra/ipfix-l2-collector-profiles/<ipfix-l2-collector-profile-id>
DELETE /policy/api/v1/global-infra/ipfix-l2-collector-profiles/<ipfix-l2-collector-profile-id>

Get IPFIX Collector profile


API will return details of IPFIX collector profile.
GET /policy/api/v1/infra/ipfix-l2-collector-profiles/<ipfix-l2-collector-profile-id>
GET /policy/api/v1/global-infra/ipfix-l2-collector-profiles/<ipfix-l2-collector-profile-id>

Patch IPFIX collector profile


Create a new IPFIX collector profile if the IPFIX collector profile with
given id does not already exist. If the IPFIX collector profile with the
given id already exists, patch with the existing IPFIX collector profile.
PATCH /policy/api/v1/infra/ipfix-l2-collector-profiles/<ipfix-l2-collector-profile-id>
PATCH /policy/api/v1/global-infra/ipfix-l2-collector-profiles/<ipfix-l2-collector-profile-id>

Create or Replace IPFIX collector profile


Create or Replace IPFIX collector profile. IPFIX data will be sent to IPFIX
collector.
PUT /policy/api/v1/infra/ipfix-l2-collector-profiles/<ipfix-l2-collector-profile-id>
PUT /policy/api/v1/global-infra/ipfix-l2-collector-profiles/<ipfix-l2-collector-profile-id>

List IPFIX L2 Profiles


API provides list IPFIX L2 Profiles available on
selected logical l2.
GET /policy/api/v1/infra/ipfix-l2-profiles
GET /policy/api/v1/global-infra/ipfix-l2-profiles

Delete IPFIX L2 Profile


API deletes IPFIX L2 Profile. Flow forwarding to
selected collector will be stopped.
DELETE /policy/api/v1/infra/ipfix-l2-profiles/<ipfix-l2-profile-id>
DELETE /policy/api/v1/global-infra/ipfix-l2-profiles/<ipfix-l2-profile-id>

Get IPFIX L2 Profile


API will return details of IPFIX L2 profile.
GET /policy/api/v1/infra/ipfix-l2-profiles/<ipfix-l2-profile-id>
GET /policy/api/v1/global-infra/ipfix-l2-profiles/<ipfix-l2-profile-id>

Patch IPFIX L2profile


Create a new IPFIX L2 profile if the IPFIX L2 profile
with given id does not already exist. If the IPFIX L2 profile
with the given id already exists, patch with the existing IPFIX L2
profile.
PATCH /policy/api/v1/infra/ipfix-l2-profiles/<ipfix-l2-profile-id>
PATCH /policy/api/v1/global-infra/ipfix-l2-profiles/<ipfix-l2-profile-id>

Create or Replace IPFIX L2 profile


Create or replace IPFIX L2 Profile. Profile is reusable entity. Single
profile can attached multiple bindings e.g group, segment and port.
PUT /policy/api/v1/infra/ipfix-l2-profiles/<ipfix-l2-profile-id>
PUT /policy/api/v1/global-infra/ipfix-l2-profiles/<ipfix-l2-profile-id>

List livetrace config entities


Get a paginated list of all livetrace config entities.
GET /policy/api/v1/infra/livetraces

Delete a livetrace config


Delete livetrace config with the specified identifier.
DELETE /policy/api/v1/infra/livetraces/<livetrace-id>

Read a livetrace config


Read livetrace config with the specified identifier.
GET /policy/api/v1/infra/livetraces/<livetrace-id>

Create or update a livetrace config


If a livetrace config with the specified identifier is not present, then
create a new livetrace config. If it already exists, update the livetrace
config with a full replacement.
PATCH /policy/api/v1/infra/livetraces/<livetrace-id>

Restart a livetrace session


Restart a livetrace session with the same set of parameters used in creating or updating of a livetrace config.
POST /policy/api/v1/infra/livetraces/<livetrace-id>

Create or update a livetrace config


If a livetrace config with the specified identifier is not present, then
create a new livetrace config. If it already exists, update the livetrace
config with a full replacement.
PUT /policy/api/v1/infra/livetraces/<livetrace-id>

Read livetrace result


Read result for a livetrace config with the specified identifier.
GET /policy/api/v1/infra/livetraces/<livetrace-id>/result

Read livetrace status


Read status for a livetrace config with the specified identifier.
GET /policy/api/v1/infra/livetraces/<livetrace-id>/status

List Port Mirroring Profiles


API will list all port mirroring profiles group.
GET /policy/api/v1/infra/port-mirroring-profiles
GET /policy/api/v1/global-infra/port-mirroring-profiles

Delete Port Mirroring Profile


API will delete port mirroring profile. Mirroring from source to destination
ports will be stopped.
DELETE /policy/api/v1/infra/port-mirroring-profiles/<port-mirroring-profile-id>
DELETE /policy/api/v1/global-infra/port-mirroring-profiles/<port-mirroring-profile-id>

Details of Port Mirroring Profile


API will return details of port mirroring profile.
GET /policy/api/v1/infra/port-mirroring-profiles/<port-mirroring-profile-id>
GET /policy/api/v1/global-infra/port-mirroring-profiles/<port-mirroring-profile-id>

Patch Port Mirroring Profile.


Create a new Port Mirroring Profile if the Port Mirroring Profile with
given id does not already exist. If the Port Mirroring Profile with the
given id already exists, patch with the existing Port Mirroring Profile.
Realized entities of this API can be found using the path of monitoring
profile binding map that is used to apply this profile.
PATCH /policy/api/v1/infra/port-mirroring-profiles/<port-mirroring-profile-id>
PATCH /policy/api/v1/global-infra/port-mirroring-profiles/<port-mirroring-profile-id>

Create or Replace Port Mirroring Profile.


Create or Replace port mirroring profile. Packets will be mirrored from
source group, segment, port to destination group.
Realized entities of this API can be found using the path of monitoring
profile binding map that is used to apply this profile.
PUT /policy/api/v1/infra/port-mirroring-profiles/<port-mirroring-profile-id>
PUT /policy/api/v1/global-infra/port-mirroring-profiles/<port-mirroring-profile-id>

List TraceflowConfig for infra


Paginated list of all TraceflowConfig for infra.
GET /policy/api/v1/infra/traceflows

Delete traceflow config


Delete traceflow config with id traceflow-id
DELETE /policy/api/v1/infra/traceflows/<traceflow-id>

Read traceflow config


Read traceflow config with id traceflow-id. This configuration
will be cleaned up by the system after two hours of inactivity.
GET /policy/api/v1/infra/traceflows/<traceflow-id>

Create or update a traceflow config


If a traceflow config with the traceflow-id is not
already present, create a new traceflow config. If it already exists,
update the traceflow config. This is a full replace. This configuration
will be cleaned up by the system after two hours of inactivity.
PATCH /policy/api/v1/infra/traceflows/<traceflow-id>

Restart traceflow with same set of parameters used during create/update traceflow


This will retrace even if current traceflow has observations. Current
observations will be lost. Traceflow configuration will be cleaned up
by the system after two hours of inactivity.
POST /policy/api/v1/infra/traceflows/<traceflow-id>

Create or update a traceflow config


If a traceflow config with the traceflow-id is not
already present, create a new traceflow config. If it already exists,
update the traceflow config. This is a full replace. This
configuration will be cleaned up by the system after two hours of inactivity.
PUT /policy/api/v1/infra/traceflows/<traceflow-id>

Read traceflow observations


Read traceflow observations for id traceflow-id. Traceflow configuration will be cleaned up by the system after two hours of inactivity.
GET /policy/api/v1/infra/traceflows/<traceflow-id>/observations

Read traceflow status


Read traceflow status with id traceflow-id.
Traceflow configuration will be cleaned up by the system after
two hours of inactivity.
GET /policy/api/v1/infra/traceflows/<traceflow-id>/status