[{"label":"Latest (2.0.0)","version":"latest"},{"version":"1.0.0"}]
srm-rest-api
Get Network Mapping
DescriptionGet details about a configured network mapping for an SRM in a given pairing.
Request
URLURL
https://{api_host}//pairings/{pairing_id}/srms/{srm_id}/inventory-mappings/networks/{mapping_id}
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
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
200 OK
Returns
NetworkMappingDrResponseEntity
of type application/json
Details about a network mappings for this SRM.
{
"_meta": {
"errors": [
{
"code": "string",
"field": "string",
"message": "string"
}
]
},
"id": "string",
"ip_mapping": {
"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"
}
]
},
"primary_object": "string",
"primary_object_name": "string",
"reverse_mapping_type": "YES",
"reverse_recovery_object": "string",
"reverse_recovery_object_name": "string",
"secondary_object": "string",
"secondary_object_name": "string",
"test_network_mapping": {
"id": "string",
"target_network": "string",
"test_network": "string",
"test_network_name": "string"
}
}
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
PowerCLI Client SDK Example
Invoke-SrmGetNetworkMapping -pairingId "MypairingId" -srmId "MysrmId" -mappingId "MymappingId"
cURL Command
curl https://{api_host}/pairings/{pairing_id}/srms/{srm_id}/inventory-mappings/networks/{mapping_id}
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: ERROR
server-down: ERROR
[{"label":"Latest (2.0.0)","version":"latest"},{"version":"1.0.0"}]
srm-rest-api
On This Page
Inventory Mappings Operations
delete
delete
delete
delete
delete
