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

Get vCenter

Description

Get information about a vCenter Server that is part of a given pairing.

Request

Request

URL

URL


get
https://{api_host}//pairings/{pairing_id}/vcenters/{vcenter_id}
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.


Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

200 OK

Returns ServerInfoDrResponseEntity of type application/json

Information about a vCenter Server.

{
	"_meta": {
		"errors": [
			{
				"code": "string",
				"field": "string",
				"message": "string"
			}
		]
	},
	"certificate_warnings": [
		{
			"certificate": {
				"certificate": "string",
				"extended_key_usage": [
					"string"
				],
				"issuer_alternative_names": [
					"string"
				],
				"issuer_dn": "C=US, OU=DR Division, O=\"VMware, Inc.\", CN=\"VMware, Inc.\"",
				"issuer_unique_id": [
					false
				],
				"key_usage": [
					false
				],
				"not_after": 0,
				"not_before": 0,
				"public_key": "string",
				"public_key_algorithm": "RSA",
				"public_key_format": "X.509",
				"serial_number": "string",
				"sig_alg_name": "SHA256withRSA",
				"sig_alg_oid": "1.2.840.10040.4.3",
				"signature": "string",
				"subject_alternative_names": [
					"string"
				],
				"subject_dn": "C=US, OU=DR Division, O=\"VMware, Inc.\", CN=\"VMware, Inc.\"",
				"subject_unique_id": [
					false
				],
				"thumbprint": "string",
				"version": 3
			},
			"server_guid": "string",
			"server_url": "string"
		}
	],
	"certificates": [
		{
			"certificate": "string",
			"extended_key_usage": [
				"string"
			],
			"issuer_alternative_names": [
				"string"
			],
			"issuer_dn": "C=US, OU=DR Division, O=\"VMware, Inc.\", CN=\"VMware, Inc.\"",
			"issuer_unique_id": [
				false
			],
			"key_usage": [
				false
			],
			"not_after": 0,
			"not_before": 0,
			"public_key": "string",
			"public_key_algorithm": "RSA",
			"public_key_format": "X.509",
			"serial_number": "string",
			"sig_alg_name": "SHA256withRSA",
			"sig_alg_oid": "1.2.840.10040.4.3",
			"signature": "string",
			"subject_alternative_names": [
				"string"
			],
			"subject_dn": "C=US, OU=DR Division, O=\"VMware, Inc.\", CN=\"VMware, Inc.\"",
			"subject_unique_id": [
				false
			],
			"thumbprint": "string",
			"version": 3
		}
	],
	"id": "string",
	"name": "string",
	"server_status": "OK",
	"url": "string",
	"version": "string"
}
_meta Optional

Response meta data. Contains data about the response payload data.

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-SrmGetVcenter -pairingId "MypairingId" -vcenterId "MyvcenterId"

cURL Command

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

Vendor Extensions

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


Feedback

Was this page helpful?