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

Get Storage Adapter Connection Params

Description

Get connection parameters for a storage replication adapter of a Site Recovery Manager that is part of a given pairing.

Request

Request

URL

URL


get
https://{api_host}//pairings/{pairing_id}/srms/{srm_id}/replication-management/abr/storage-adapters/{storage_adapter_id}/connection-params
Copy

Path Parameters

Path Parameters

string
pairing_id Required

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


string
srm_id Required

ID of a Site Recovery Manager server.


string
storage_adapter_id Required

The ID of the storage replication adapter.


Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

200 OK

Returns ConnectionParamGroupDrResponseList of type application/json

Connection parameters for a storage replication adapter of a Site Recovery Manager.

{
	"_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": [
		{
			"connection_params": [
				{
					"hint": "string",
					"key": "string",
					"name": "string",
					"optional": false,
					"password_param": false,
					"type": "USER_NAME",
					"value": "string"
				}
			],
			"hint": "string",
			"key": "string",
			"name": "string"
		}
	]
}
_meta Optional

List metadata


list Optional

Connection parameters group used to connect to a storage replication adapter (SRA).

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-SrmGetStorageAdapterConnectionParams -pairingId "MypairingId" -srmId "MysrmId" -storageAdapterId "MystorageAdapterId"

cURL Command

curl https://{api_host}/pairings/{pairing_id}/srms/{srm_id}/replication-management/abr/storage-adapters/{storage_adapter_id}/connection-params
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: ERROR


[{"label":"Latest (2.0.0)","version":"latest"},{"version":"1.0.0"}]
srm-rest-api
What's changed in latest?
INTRODUCED
Feedback

Was this page helpful?