Return information of all migration unit groups

Return information of all migration unit groups in the
migration plan. If request parameter summary is set to true, then
only count of migration units will be returned, migration units list
will be empty. If request parameter component type is specified,
then all migration unit groups for that component will be returned.

Request:

Method:

GET

URI Path(s):

/api/v1/migration/migration-unit-groups

Request Headers:

n/a

Query Parameters:

MigrationUnitGroupListRequestParameters+

Name	Description	Type	Notes
component_type	Component type based on which migration unit groups to be filtered	string
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
summary	Flag indicating whether to return summary	boolean	Default: "False"
sync	Synchronize before returning migration unit groups If true, synchronize with the management plane before returning migration unit groups	boolean	Default: "False"

Request Body:

n/a

Example Request:

GET https://<nsx-mgr>/api/v1/migration/migration-unit-groups?component_type=HOST

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

MigrationUnitGroupListResult+

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	Paged Collection of Migration unit groups	array of MigrationUnitGroup	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:

{ "cursor" : "0036cd429462-4716-4ada-a66b-e4c78504a399nnuullll", "result_count" : 1, "results": [ { "id": "d00d6a39-5ff2-4ddc-a63f-672b4e9ecc5", "display_name": "esx55Hosts", "type": "HOST", "parallel": "false", "enabled": "true", "migration_unit_count": 2, "migration_units": [ { "id": "a95be8d6-4a76-46fe-9c9c-341e89973da7", "display_name": "esx551", "type": "HOST", "current_version": "1.0.0.1444456", "group": { "id": "d00d6a39-5ff2-4ddc-a63f-672b4e9ecc5", "display_name": "esx55Hosts" }, "warnings": [], "metadata": [] }, { "id": "1f64e9f4-eeb3-4ebd-af78-e08757e593cf", "display_name": "esx552", "type": "HOST", "current_version": "1.0.0.1444456", "group": { "id": "d00d6a39-5ff2-4ddc-a63f-672b4e9ecc5", "display_name": "esx55Hosts" }, "warnings": [], "metadata": [] } ], "extended_configuration": [ { "key": "disable_vm_migration", "value": "true" } ] } ] }

Return information of all migration unit groups

Request:

MigrationUnitGroupListRequestParameters (schema)

Example Request:

Successful Response:

MigrationUnitGroupListResult (schema)

Example Response:

Required Permissions:

Feature:

Additional Errors: