Modify the failover group

Select

SaaS

Customer Managed

API to modify failover group

Path Parameters

• failoverGroupId int32 required

  Id of the failover group

application/json

Request Body

• name string

  Failover Group name

• isApprovalRequired boolean

  Whether a user approval is required for DR operations

• usersToNotify object[]

  Users to notify/for approval of DR operations

  id int32

  name string

  displayName string

  company object

  id int32

  name string
• priorityIntervalInMinutes int32

  Possible values: >= 1

  The interval between DR operations of different priorities

• esxServerMappings object[]

  The list of all ESX server mappings

  sourceServer string

  The name of source ESX server

  destinationServer string

  The name of destination ESX server

  networkSettings object[]

  The list of all source network interface to destination network interface mapping

  source string

  Source network name

  sourceId string

  Source network ID

  destination string

  Destination network name

• continueDROnFailure boolean

  Whether to continue to next priority on DR job failure

• recoveryTarget object

  id int32

  name string
• replicationPairs object[]

  List of all replication pairs that are part of the failover group

  id int32

  The ID of the replication pair

  sourceId int32

  The id of the source machine

  sourceName string

  The name of the source machine

  destinationId int32

  The id of the destination machine

  destinationName string

  The name of the destination machine

  GUID string

  The GUID of the source of replication pair

  priority int32

  The priority of the replication pair for DR operation in failover group. The lower values signify higher priority

  copyPrecedence int32

  The copy precedence of replication pair

  preFailoverScript object

  DR operation scripting information

  path string

  The path of the script to be executed. Can be local path on VM or UNC path accessible by access node

  type string

  Possible values: [UNC, LOCAL]

  The type of path being used for DR operation script

  scriptCredentials object

  savedCredentials object

  id int32

  name string

  credentials object

  name string

  username to access the network path

  password string

  password to access the network path

  guestCredentials object

  savedCredentials object

  id int32

  name string

  credentials object

  name string

  username to access the network path

  password string

  password to access the network path

  guid string

  Unique script identifier string

  scriptContent string

  Content of the script to be executed

  scriptName string

  Name of the script

  reset boolean

  On set to true, resets the script to empty

  osType string

  Possible values: [WINDOWS, UNIX]

  OS types

  postFailoverScript object

  DR operation scripting information

  path string

  The path of the script to be executed. Can be local path on VM or UNC path accessible by access node

  type string

  Possible values: [UNC, LOCAL]

  The type of path being used for DR operation script

  scriptCredentials object

  savedCredentials object

  id int32

  name string

  credentials object

  name string

  username to access the network path

  password string

  password to access the network path

  guestCredentials object

  savedCredentials object

  id int32

  name string

  credentials object

  name string

  username to access the network path

  password string

  password to access the network path

  guid string

  Unique script identifier string

  scriptContent string

  Content of the script to be executed

  scriptName string

  Name of the script

  reset boolean

  On set to true, resets the script to empty

  osType string

  Possible values: [WINDOWS, UNIX]

  OS types

  preFailbackScript object

  DR operation scripting information

  path string

  The path of the script to be executed. Can be local path on VM or UNC path accessible by access node

  type string

  Possible values: [UNC, LOCAL]

  The type of path being used for DR operation script

  scriptCredentials object

  savedCredentials object

  id int32

  name string

  credentials object

  name string

  username to access the network path

  password string

  password to access the network path

  guestCredentials object

  savedCredentials object

  id int32

  name string

  credentials object

  name string

  username to access the network path

  password string

  password to access the network path

  guid string

  Unique script identifier string

  scriptContent string

  Content of the script to be executed

  scriptName string

  Name of the script

  reset boolean

  On set to true, resets the script to empty

  osType string

  Possible values: [WINDOWS, UNIX]

  OS types

  postFailbackScript object

  DR operation scripting information

  path string

  The path of the script to be executed. Can be local path on VM or UNC path accessible by access node

  type string

  Possible values: [UNC, LOCAL]

  The type of path being used for DR operation script

  scriptCredentials object

  savedCredentials object

  id int32

  name string

  credentials object

  name string

  username to access the network path

  password string

  password to access the network path

  guestCredentials object

  savedCredentials object

  id int32

  name string

  credentials object

  name string

  username to access the network path

  password string

  password to access the network path

  guid string

  Unique script identifier string

  scriptContent string

  Content of the script to be executed

  scriptName string

  Name of the script

  reset boolean

  On set to true, resets the script to empty

  osType string

  Possible values: [WINDOWS, UNIX]

  OS types

• arrayReplicationPairs object[]

  List of all array replication pairs for failover group

  id int32

  The ID of the array replication pair

  sourceId int32

  The id of the source machine

  sourceName string

  The name of the source machine

  destinationId int32

  The id of the destination machine

  destinationName string

  The name of the destination machine

  GUID string

  The GUID of the source of array replication pair

  priority int32

  The priority of the array replication pair for DR operation in failover group. The lower values signify higher priority

  ipSettings object[]

  The settings for IP address mapping

  sourceIP string

  The full IP address or an IP address pattern of the source VM.

  sourceSubnetMask string

  The subnet mask of the source VM.

  sourceDefaultGateway string

  The default gateway of the source VM.

  useDhcp boolean

  Default value: false

  Automatically assigns available IP addresses to be used with the specified destination network.

  destinationIP string

  The full IP address or an IP address pattern for the destination VM. Provide only if DHCP is not enabled.

  destinationSubnetMask string

  The subnet mask for the destination VM. Provide only if DHCP is not enabled.

  destinationDefaultGateway string

  The default gateway for the destination VM. Provide only if DHCP is not enabled.

  destinationPreferredDNS string

  The preferred DNS server for the destination VM. Provide only if DHCP is not enabled

  destinationAlternateDNS string

  The alternate DNS server for the destination VM. Provide only if DHCP is not enabled

  destinationPreferredWINS string

  The preferred WINS server for the destination VM. Provide only if DHCP is not enabled

  destinationAlternateWINS string

  The alternate WINS server for the destination VM. Provide only if DHCP is not enabled

  hostname string

  The hostname specified for the destination machine

• script object

  Pre/post failover and failback scripts at group level

  preFailover object

  DR operation scripting information

  path string

  The path of the script to be executed. Can be local path on VM or UNC path accessible by access node

  type string

  Possible values: [UNC, LOCAL]

  The type of path being used for DR operation script

  scriptCredentials object

  savedCredentials object

  id int32

  name string

  credentials object

  name string

  username to access the network path

  password string

  password to access the network path

  guestCredentials object

  savedCredentials object

  id int32

  name string

  credentials object

  name string

  username to access the network path

  password string

  password to access the network path

  guid string

  Unique script identifier string

  scriptContent string

  Content of the script to be executed

  scriptName string

  Name of the script

  reset boolean

  On set to true, resets the script to empty

  osType string

  Possible values: [WINDOWS, UNIX]

  OS types

  postFailover object

  DR operation scripting information

  path string

  The path of the script to be executed. Can be local path on VM or UNC path accessible by access node

  type string

  Possible values: [UNC, LOCAL]

  The type of path being used for DR operation script

  scriptCredentials object

  savedCredentials object

  id int32

  name string

  credentials object

  name string

  username to access the network path

  password string

  password to access the network path

  guestCredentials object

  savedCredentials object

  id int32

  name string

  credentials object

  name string

  username to access the network path

  password string

  password to access the network path

  guid string

  Unique script identifier string

  scriptContent string

  Content of the script to be executed

  scriptName string

  Name of the script

  reset boolean

  On set to true, resets the script to empty

  osType string

  Possible values: [WINDOWS, UNIX]

  OS types

  preFailback object

  DR operation scripting information

  path string

  The path of the script to be executed. Can be local path on VM or UNC path accessible by access node

  type string

  Possible values: [UNC, LOCAL]

  The type of path being used for DR operation script

  scriptCredentials object

  savedCredentials object

  id int32

  name string

  credentials object

  name string

  username to access the network path

  password string

  password to access the network path

  guestCredentials object

  savedCredentials object

  id int32

  name string

  credentials object

  name string

  username to access the network path

  password string

  password to access the network path

  guid string

  Unique script identifier string

  scriptContent string

  Content of the script to be executed

  scriptName string

  Name of the script

  reset boolean

  On set to true, resets the script to empty

  osType string

  Possible values: [WINDOWS, UNIX]

  OS types

  postFailback object

  DR operation scripting information

  path string

  The path of the script to be executed. Can be local path on VM or UNC path accessible by access node

  type string

  Possible values: [UNC, LOCAL]

  The type of path being used for DR operation script

  scriptCredentials object

  savedCredentials object

  id int32

  name string

  credentials object

  name string

  username to access the network path

  password string

  password to access the network path

  guestCredentials object

  savedCredentials object

  id int32

  name string

  credentials object

  name string

  username to access the network path

  password string

  password to access the network path

  guid string

  Unique script identifier string

  scriptContent string

  Content of the script to be executed

  scriptName string

  Name of the script

  reset boolean

  On set to true, resets the script to empty

  osType string

  Possible values: [WINDOWS, UNIX]

  OS types

Responses

• 200
• 404
• 503

---

OK

application/json

• Schema
• Example (from schema)

---

Schema

• errorMessage string
• errorCode int32

{
  "errorMessage": "string",
  "errorCode": 0
}

Not Found

application/json

• Schema
• Example (from schema)

---

Schema

• errorMessage string
• errorCode int32

{
  "errorMessage": "string",
  "errorCode": 0
}

Service Unavailable

application/json

• Schema
• Example (from schema)

---

Schema

• errorMessage string
• errorCode int32

{
  "errorMessage": "string",
  "errorCode": 0
}

Loading...