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

Get Network IP Subnet Mapping

Description

Get details about a configured IP subnet mapping for a network mapping.

Request

Request

URL

URL


get
https://{api_host}//pairings/{pairing_id}/srms/{srm_id}/inventory-mappings/networks/{mapping_id}/ip-subnet-mapping
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
mapping_id Required

The ID of the mapping.


Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

200 OK

Returns IPMappingDrResponseEntity of type application/json

Details about the IP subnet mapping.

{
	"_meta": {
		"errors": [
			{
				"code": "string",
				"field": "string",
				"message": "string"
			}
		]
	},
	"name": "string",
	"rules": [
		{
			"local_subnet": "string",
			"name": "string",
			"remote_ip_settings": {
				"dns": {
					"alternate_server": "string",
					"preferred_server": "string",
					"suffixes": [
						"string"
					],
					"type": "DHCP"
				},
				"ip_v4": {
					"alternate_gateway": "string",
					"default_gateway": "string"
				},
				"wins": {
					"alternate_server": "string",
					"primary_server": "string"
				}
			},
			"remote_subnet": "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-SrmGetNetworkIpSubnetMapping -pairingId "MypairingId" -srmId "MysrmId" -mappingId "MymappingId"

cURL Command

curl https://{api_host}/pairings/{pairing_id}/srms/{srm_id}/inventory-mappings/networks/{mapping_id}/ip-subnet-mapping
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: ERROR
    server-down: ERROR


Feedback

Was this page helpful?