NSX-T Data Center REST API

Get VMs by segment

Get VMs by segment.

Request:

Method:

POST

URI Path(s):

/api/v1/migration/overlay-adoption/vcenters/{vcenter-id}/inventory/segment/virtual-machines/search

Request Headers:

n/a

Query Parameters:

ListRequestParameters+

ListRequestParameters (schema)

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 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"
sort_ascending		boolean
sort_by	Field by which records are sorted	string

Request Body:

VmEntityListBySegmentRequestParameters+

VmEntityListBySegmentRequestParameters (schema)

Name	Description	Type	Notes
cluster_id	Cluster ID Cluster ID.	string
cluster_name	Cluster name Cluster name.	string
host_id	Host ID Host ID.	string
host_name	Host name Host name.	string
segment_path	Segment path Segment path.	string	Required
vm_name	VM name VM name.	string

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

VmEntityListResult+

VmEntityListResult (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	Paged collection of VMs Paged collection of VMs.	array of VmEntity	Required Readonly
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly

Required Permissions:

read

Feature:

utilities_upgrade

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