Return migration unit group information

Returns information about a specific migration unit group 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.

Request:

Method:

GET

URI Path(s):

/api/v1/migration/migration-unit-groups/<group-id>

Request Headers:

n/a

Query Parameters:

SummaryRequest+

Name	Description	Type	Notes
summary	Flag indicating whether to return the summary	boolean	Default: "False"

Request Body:

n/a

Example Request:

GET https://<nsx-mgr>/api/v1/migration/migration-unit-groups/d00d6a39-5ff2-4ddc-a63f-672b4e9ecc5

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

MigrationUnitGroup+

MigrationUnitGroup (schema)

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_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
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
enabled	Flag to indicate whether migration of this group is enabled or not	boolean	Default: "True"
extended_configuration	Extended configuration for the group	array of KeyValuePair	Maximum items: 100
id	Unique identifier of this resource	string	Sortable
migration_unit_count	Count of migration units in the group Number of migration units in the group	int	Readonly
migration_units	List of migration units in the group	array of MigrationUnit	Maximum items: 100
parallel	Migration method to specify whether the migration is to be performed in parallel or serially	boolean	Default: "True"
resource_type	Must be set to the value MigrationUnitGroup	string
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
type	Component type	string	Required

Example Response:

{ "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 migration unit group information

Request:

SummaryRequest (schema)

Example Request:

Successful Response:

MigrationUnitGroup (schema)

Example Response:

Required Permissions:

Feature:

Additional Errors: