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

Update Network IP Subnet Mapping

Description

Create or update the IP subnet mapping for a network mapping.

Request

Request

URL

URL


put
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.


Request Body

Request Body

IPMapping of mimetype application/json Required

A spec describing the IP subnet mappings settings.

{
	"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"
		}
	]
}
string
name Optional

Name of the IP mapping.


array of SubnetRule
rules Optional

A rule describing mapping between protection side IP parameters to recovery side ones for a single IP subnet. Currently IPv6 customization is not supported.

Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

204 No Content

IP subnet mapping is created or updated.

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

$SubnetRuleIpV4Setting = Initialize-SrmSubnetRuleIpV4Setting -DefaultGateway "MyDefaultGateway" -AlternateGateway "MyAlternateGateway"
$DnsSetting = Initialize-SrmDnsSetting -Type "DHCP" -PreferredServer "MyPreferredServer" -AlternateServer "MyAlternateServer" -Suffixes "MySuffixes"
$WinsSetting = Initialize-SrmWinsSetting -PrimaryServer "MyPrimaryServer" -AlternateServer "MyAlternateServer"
$RemoteIpSetting = Initialize-SrmRemoteIpSetting -IpV4 $SubnetRuleIpV4Setting -Dns $DnsSetting -Wins $WinsSetting
$SubnetRule = Initialize-SrmSubnetRule -Name "MyName" -RemoteSubnet "MyRemoteSubnet" -LocalSubnet "MyLocalSubnet" -RemoteIpSettings $RemoteIpSetting
$IPMapping = Initialize-SrmIPMapping -Name "MyName" -Rules $SubnetRule
Invoke-SrmUpdateNetworkIpSubnetMapping -pairingId "MypairingId" -srmId "MysrmId" -mappingId "MymappingId" -iPMapping $iPMapping

cURL Command

curl -X PUT -H "Content-Type: application/json" -d '{"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"}]}' 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
        - VcDr.InventoryMapper.com.vmware.vcDr.Edit
x-dr-remote-site-connectivity-contract:
    not-authenticated: ERROR
    server-down: ERROR


Feedback

Was this page helpful?