Return the List of Compute managers

Returns information about all compute managers.

Request:

Method:

GET

URI Path(s):

/api/v1/fabric/compute-managers

Request Headers:

n/a

Query Parameters:

ComputeManagerListRequestParameters+

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
origin_type	Compute manager type like vCenter	string
page_size	Maximum number of results to return in this page (server may return fewer)	integer	Minimum: 0 Maximum: 1000 Default: "1000"
server	IP address or hostname of compute manager	string	Format: hostname-or-ip
sort_ascending		boolean
sort_by	Field by which records are sorted	string

Request Body:

n/a

Example Request:

GET https://<nsx-mgr>/api/v1/fabric/compute-managers

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

ComputeManagerListResult+

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 compute managers	array of ComputeManager	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": "00364a60d899-7b2b-4983-8254-41be3aba6472cm1", "result_count": 2, "results": [ { "id": "cf1f01db-e5b3-4688-9c1e-5f47d335fb01", "server": "192.168.210.54", "origin_type": "vCenter", "credential" : { "credential_type" : "UsernamePasswordLoginCredential", "thumbprint": "3A:21:22:A6:72:28:DA:EC:9D:05:AF:0B:B5:C6:44:CC:52:8D:54:AC" } "origin_properties": [] }, { "id": "a95be8d6-4a76-46fe-9c9c-341e89973da7", "server": "10.112.3.45", "origin_type": "vCenter", "credential" : { "credential_type" : "UsernamePasswordLoginCredential", "thumbprint": "4B:67:22:A6:72:28:DA:EC:9D:05:AF:0B:B5:C6:44:CC:52:8D:54:AC" } "origin_properties": [] } }

Return the List of Compute managers

Request:

ComputeManagerListRequestParameters (schema)

Example Request:

Successful Response:

ComputeManagerListResult (schema)

Example Response:

Required Permissions:

Feature:

Additional Errors: