[{"label":"Latest (2.0.0)","version":"latest"},{"version":"1.0.0"}]
srm-rest-api

Get vCenter Compute Inventory

Description

Get information about the vCenter Server’s compute inventory.

Request

Request

URL

URL


get
https://{api_host}//pairings/{pairing_id}/vcenters/{vcenter_id}/inventory/compute
Copy

Path Parameters

Path Parameters

string
pairing_id Required

The ID of a pairing between this Site Recovery Manager server and remote one.


string
vcenter_id Required

The ID of a vCenter server.


Query Parameters

Query Parameters

string
path Optional

A path to the compute resource or the folder object.


Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

200 OK

Returns VcenterServerInventoryItemDrResponseList of type application/json

Information about the vCenter Server’s compute inventory.

{
	"_meta": {
		"errors": [
			{
				"code": "string",
				"field": "string",
				"message": "string"
			}
		],
		"limit": 0,
		"links": {
			"next": {
				"href": "string"
			},
			"previous": {
				"href": "string"
			},
			"self": {
				"href": "string"
			}
		},
		"offset": 0,
		"total": 0
	},
	"list": [
		{
			"id": "string",
			"name": "string",
			"parent": "string",
			"path": "string"
		}
	]
}
_meta Optional

List metadata


list Optional

Details about a vCenter Server inventory object

Errors

Errors

ResponseError
400

Bad request - the server could not understand the request due to invalid syntax or invalid request body content


401

Unauthorized - the client must authenticate itself to get the requested response


ResponseError
403

Forbidden - not sufficient access rights to fulfill the request


404

Not Found - server cannot find the requested in URL resource


ResponseError
500

Internal server error - unexpected condition prevents fulfilling the request

Code Samples

Code Samples

PowerCLI Client SDK Example

Invoke-SrmGetVcenterComputeInventory -pairingId "MypairingId" -vcenterId "MyvcenterId" -path "Mypath"

cURL Command

curl https://{api_host}/pairings/{pairing_id}/vcenters/{vcenter_id}/inventory/compute
Vendor Extensions

Vendor Extensions

This operation contains the following vendor extensions defined in the spec:
x-dr-permissions:
    permissions: System.View
x-dr-remote-site-connectivity-contract:
    not-authenticated: DEPENDS_ON_PROVIDED_PARAMS
    server-down: DEPENDS_ON_PROVIDED_PARAMS


Feedback

Was this page helpful?