List all mirror sessions

Request:

Method:

GET

URI Path(s):

/api/v1/mirror-sessions

Request Headers:

n/a

Query Parameters:

ListRequestParameters+

Name	Description	Type	Notes
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string
included_fields	Comma separated list of fields that should be included in query result	string
page_size	Maximum number of results to return in this page (server may return fewer)	integer	Minimum: 0 Maximum: 1000 Default: "1000"
sort_ascending		boolean
sort_by	Field by which records are sorted	string

Request Body:

n/a

Example Request:

GET https://<nsx-mgr>/api/v1/mirror-sessions

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

PortMirroringSessionListResult+

Name	Description	Type	Notes
_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
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string	Readonly
result_count	Count of results found (across all pages), set only on first page	integer	Readonly
results	Port mirroring session results	array of PortMirroringSession	Readonly
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly

Example Response:

{ "cursor": "00369467676a-aeae-46f7-90f1-c771e02d16699467676a-aeae-46f7-90f1-c771e02d1669", "result_count": 1, "results": [ { "id": "e57e8b2d-3047-4550-b230-dd1ee0e10b49", "display_name": "port-mirror-session-1", "description": "Test pnic port mirror session 1", "resource_type": "PortMirroringSession", "direction": "BIDIRECTIONAL", "mirror_sources": [ { "resource_type": "PnicMirrorSource", "source_pnics": ["eth1"], "node_id": "6a361832-43e4-430d-a48a-b84a6cba73c3", "encapsulated": "true" } ], "mirror_destination": { "resource_type": "LogicalPortMirrorDestination", "port_ids": ["3e4e8b2d-3047-4550-b230-dd1ee0e10b34"] }, "port_mirroring_filters": [ { "src_ips": { "ip_addresses": [ "192.168.1.2/31", "192.168.1.8/29", "192.168.1.4/30", "192.168.1.16/30", "192.168.1.20/32", "192.168.1.1/32" ] }, "src_ports": "80", "filter_action": "MIRROR", "dst_ports": "80-100", "dst_ips": { "ip_addresses": [ "192.168.2.1/24" ] }, "ip_protocol": "TCP" } ], "_last_modified_user": "system", "_last_modified_time": 1435282426932, "_create_time": 1435282426867, "_system_owned": false, "_create_user": "system", "_revision": 0 } ] }

List all mirror sessions

Request:

ListRequestParameters (schema)

Example Request:

Successful Response:

PortMirroringSessionListResult (schema)

Example Response:

Required Permissions:

Feature:

Additional Errors: