NSX-T Data Center REST API

List all non-migrated NSX Manager ids

List all non-migrated NSX Manager ids.

Request:

Method:

GET

URI Path(s):

/api/v1/mppolicy/migration/object-ids

Request Headers:

n/a

Query Parameters:

MpDataSearchValue+

MpDataSearchValue (schema)

Name	Description	Type	Notes
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string
filter_value	Search filter value Search filter value for some specific resource type like for Logical router it should be TIER0/TIER1.	string
included_fields	Comma separated list of fields that should be included in query result Note - this parameter currently only works when used with the search APIs /policy/api/v1/search/query and /policy/api/v1/search/dsl. It is ignored for other list APIs.	string
page_size	Maximum number of results to return in this page (server may return fewer)	integer	Minimum: 0 Maximum: 1000 Default: "1000"
resource_type	resource_type filter value Search filter value resource type of the manager data.	string	Required
sort_ascending		boolean
sort_by	Field by which records are sorted	string

Request Body:

n/a

Example Request:

GET https://<nsx-mgr>/api/v1/mppolicy/migration/object-ids?resource_type=LogicalPort

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

MpDataListResult+

MpDataListResult (schema)

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	List of Non-promoted manager ids. Array of Non promoted manager Ids..	array of MpDataByPrincipleIdenity	Required
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly

Example Response:

{ "results": [ { "manager_id": "eb1a51df-f8be-4334-8c23-a44517c531b7" }, { "manager_id": "4ea5a157-46c1-4248-854c-ebd32842930c" }, { "manager_id": "2856d652-4c18-41ee-9bd7-6cc4d9d226de" } ] }

Required Permissions:

read

Feature:

policy_migration

Additional Errors:

• 301 Moved Permanently
• 307 Temporary Redirect
• 400 Bad Request
• 403 Forbidden
• 409 Conflict
• 412 Precondition Failed
• 500 Internal Server Error
• 503 Service Unavailable