Return the list of physical servers

Returns information of all physical/bare metal servers registered as TN.

Request:

Method:

GET

URI Path(s):

/api/v1/fabric/physical-servers

Request Headers:

n/a

Query Parameters:

PhysicalServerListRequestParameters+

Name	Description	Type	Notes
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string
display_name	Display Name of the physical server Display Name of physical server.	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
os_type	OS type of the physical server OS type of the physical server.	string	Enum: RHELSERVER, UBUNTUSERVER, CENTOSSERVER, SLESSERVER, WINDOWSSERVER, OELSERVER
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:

n/a

Example Request:

GET https://<nsx-mgr>/api/v1/fabric/physical-servers

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

PhysicalServerListResult+

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 physical servers List of physical servers.	array of PhysicalServer	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:

{ "result_count" : 1, "results" : [ { "display_name": "rhelserver1", "os_type": "RHELSERVER", "id": "420e72c9-55e7-a4f7-81bf-673a2af1a6cf", "ip_addresses": [ "192.168.110.37", "192.168.110.38" ] } ] }

Required Permissions:

read

Feature:

nodes_transport_nodes

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