[{"label":"Latest (2.0.0)","version":"latest"},{"version":"1.0.0"}]
srm-rest-api
Update Plan Virtual Machine IP Customization
DescriptionUpdate the IP customization for a protected virtual machine.
Request
URLURL
https://{api_host}//pairings/{pairing_id}/recovery-management/plans/{plan_id}/vms/{vm_id}/recovery-settings/ip-customization/actions/update
Path Parameters
Path Parameters
string
pairing_id
Required
The ID of a pairing between this Site Recovery Manager server and remote one
string
plan_id
Required
The ID of a recovery plan defined within current pairing
string
vm_id
Required
The ID of a virtual machine
Request Body
Request Body
VmRecoveryIpCustomizationSettingsSpec
of mimetype */*
Required
A spec describing the VM IP customization settings.
{
"ip_customization_type": "AUTO"
}
string
ip_customization_type
Required
IP customization modes:
- Auto (AUTO)
- If the advanced setting ‘recovery.useIpMapperAutomatically’ is set to True - Site Recovery Manager evaluates the IP subnet mapping rules during recovery to customize the virtual machines.
- If the advanced setting ‘recovery.useIpMapperAutomatically’ is set to False - Site Recovery Manager does not evaluate the IP subnet mapping rules during recovery.
- Use IP customization rules if applicable (NETWORK_LEVEL)
- Site Recovery Manager will evaluate the IP subnet mapping rules during recovery of the concrete VM regardless of the advanced setting value of recovery.useIpMapperAutomatically.
- Manual IP customization (MANUAL)
- Manually set up explicit recovery IP settings per VM.
- No IP customization (NO_CUSTOMIZATION)
- Do not change VM IP settings during recovery.
Possible values are: AUTO , NETWORK_MAPPING_LEVEL , MANUAL , NO_CUSTOMIZATION
array of
NicSettings
nic_settings
Optional
Contains the IP settings for all the virtual ethernet cards on the VM
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
202 Accepted
Returns
TaskDrResponseEntity
of type application/json
A task to monitor the operation progress.
{
"_meta": {
"errors": [
{
"code": "string",
"field": "string",
"message": "string"
}
]
},
"complete_time": "string",
"description": "string",
"description_id": "string",
"entity": "string",
"entity_name": "string",
"error": {
"details": "string",
"message": "string"
},
"id": "string",
"progress": 0,
"queued_time": "string",
"result": {},
"start_time": "string",
"status": "QUEUED"
}
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
$GeneralIpV4Setting = Initialize-SrmGeneralIpV4Setting -IpAddress "MyIpAddress" -Type "DHCP" -DefaultGateway "MyDefaultGateway" -AlternateGateway "MyAlternateGateway" -SubnetMask "255.255.255.0"
$GeneralIpV6Setting = Initialize-SrmGeneralIpV6Setting -IpAddress "fdda:5cc1:23:4::1f" -Type "DHCP" -DefaultGateway "MyDefaultGateway" -AlternateGateway "MyAlternateGateway" -SubnetPrefixLength 0
$DnsSetting = Initialize-SrmDnsSetting -Type "DHCP" -PreferredServer "MyPreferredServer" -AlternateServer "MyAlternateServer" -Suffixes "MySuffixes"
$WinsSetting = Initialize-SrmWinsSetting -PrimaryServer "MyPrimaryServer" -AlternateServer "MyAlternateServer"
$IpSettings = Initialize-SrmIpSettings -IpV4 $GeneralIpV4Setting -IpV6 $GeneralIpV6Setting -Dns $DnsSetting -Wins $WinsSetting
$NicSettings = Initialize-SrmNicSettings -DeviceId 0 -PrimaryIpSettings $IpSettings -SecondaryIpSettings $IpSettings
$VmRecoveryIpCustomizationSettingsSpec = Initialize-SrmVmRecoveryIpCustomizationSettingsSpec -IpCustomizationType "AUTO" -NicSettings $NicSettings
Invoke-SrmUpdatePlanVirtualMachineIpCustomization -pairingId "MypairingId" -planId "MyplanId" -vmId "MyvmId" -vmRecoveryIpCustomizationSettingsSpec $vmRecoveryIpCustomizationSettingsSpec
cURL Command
curl -X POST -H "Content-Type: */*" -d '{"ip_customization_type":"AUTO","nic_settings":[{"device_id":0,"primary_ip_settings":{"dns":{"alternate_server":"string","preferred_server":"string","suffixes":["string"],"type":"DHCP"},"ip_v4":{"alternate_gateway":"string","default_gateway":"string","ip_address":"string","subnet_mask":"255.255.255.0","type":"DHCP"},"ip_v6":{"alternate_gateway":"string","default_gateway":"string","ip_address":"fdda:5cc1:23:4::1f","subnet_prefix_length":0,"type":"DHCP"},"wins":{"alternate_server":"string","primary_server":"string"}},"secondary_ip_settings":{"dns":{"alternate_server":"string","preferred_server":"string","suffixes":["string"],"type":"DHCP"},"ip_v4":{"alternate_gateway":"string","default_gateway":"string","ip_address":"string","subnet_mask":"255.255.255.0","type":"DHCP"},"ip_v6":{"alternate_gateway":"string","default_gateway":"string","ip_address":"fdda:5cc1:23:4::1f","subnet_prefix_length":0,"type":"DHCP"},"wins":{"alternate_server":"string","primary_server":"string"}}}]}' https://{api_host}/pairings/{pairing_id}/recovery-management/plans/{plan_id}/vms/{vm_id}/recovery-settings/ip-customization/actions/update
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-dr-permissions:
permissions:
- System.View
- System.Read
- VcDr.RecoveryProfile.com.vmware.vcDr.Edit
x-dr-remote-site-connectivity-contract:
not-authenticated: DEPENDS_ON_PROVIDED_PARAMS
server-down: DEPENDS_ON_PROVIDED_PARAMS
[{"label":"Latest (2.0.0)","version":"latest"},{"version":"1.0.0"}]
srm-rest-api
On This Page
Recovery Operations
post
post
delete
post
post
post
