Skip to main content

Modify the failover group​

API to modify failover group

Path Parameters
  • failoverGroupId int32 required

    Id of the failover group

Request Body
  • name string

    New name for failover group

  • isApprovalRequired boolean

    Modify whether user approval is required for DR operation or not

  • 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

    Modify the time interval between DR operations of different priorities in minutes

  • continueDROnFailure boolean

    Modify 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

  • sourceName string

    The name of the source 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

  • reset boolean

    On set to true, resets the script to empty

  • 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

  • reset boolean

    On set to true, resets the script to empty

  • arrayReplicationPairs object[]

    List of all array replication pairs for failover group

  • id int32

    The ID of the array replication pair

  • sourceName string

    The name of the source 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 host name to be applied for the destination VM.

  • hostname string

    The hostname specified for the destination machine

Responses

OK

Schema
  • errorMessage string
  • errorCode int32
PUT /v4/failovergroups/:failovergroupid

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL
https://localhost/webconsole/api
token
failoverGroupId — path required
Body
{

  "name": "string",

  "isApprovalRequired": true,

  "usersToNotify": [

    {

      "id": 0,

      "name": "string",

      "displayName": "string",

      "company": {

        "id": 0,

        "name": "string"

      }

    }

  ],

  "priorityIntervalInMinutes": 0,

  "continueDROnFailure": true,

  "recoveryTarget": {

    "id": 0,

    "name": "string"

  },

  "replicationPairs": [

    {

      "id": 0,

      "sourceName": "string",

      "destinationName": "string",

      "GUID": "string",

      "priority": 0,

      "copyPrecedence": 0,

      "preFailoverScript": {

        "path": "string",

        "type": "UNC",

        "scriptCredentials": {

          "savedCredentials": {

            "id": 0,

            "name": "string"

          },

          "credentials": {

            "name": "string",

            "password": "string"

          }

        },

        "guestCredentials": {

          "savedCredentials": {

            "id": 0,

            "name": "string"

          },

          "credentials": {

            "name": "string",

            "password": "string"

          }

        },

        "reset": true

      },

      "postFailoverScript": {

        "path": "string",

        "type": "UNC",

        "scriptCredentials": {

          "savedCredentials": {

            "id": 0,

            "name": "string"

          },

          "credentials": {

            "name": "string",

            "password": "string"

          }

        },

        "guestCredentials": {

          "savedCredentials": {

            "id": 0,

            "name": "string"

          },

          "credentials": {

            "name": "string",

            "password": "string"

          }

        },

        "reset": true

      }

    }

  ],

  "arrayReplicationPairs": [

    {

      "id": 0,

      "sourceName": "string",

      "destinationName": "string",

      "GUID": "string",

      "priority": 0,

      "ipSettings": [

        {

          "sourceIP": "string",

          "sourceSubnetMask": "string",

          "sourceDefaultGateway": "string",

          "useDhcp": false,

          "destinationIP": "string",

          "destinationSubnetMask": "string",

          "destinationdefaultGateway": "string",

          "destinationPreferredDNS": "string",

          "destinationAlternateDNS": "string",

          "destinationPreferredWINS": "string",

          "destinationAlternateWINS": "string",

          "hostname": "string"

        }

      ],

      "hostname": "string"

    }

  ]

}

curl -L -X PUT 'https://localhost/webconsole/api/V4/FailoverGroups/:failoverGroupId' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "name": "string",
  "isApprovalRequired": true,
  "usersToNotify": [
    {
      "id": 0,
      "name": "string",
      "displayName": "string",
      "company": {
        "id": 0,
        "name": "string"
      }
    }
  ],
  "priorityIntervalInMinutes": 0,
  "continueDROnFailure": true,
  "recoveryTarget": {
    "id": 0,
    "name": "string"
  },
  "replicationPairs": [
    {
      "id": 0,
      "sourceName": "string",
      "destinationName": "string",
      "GUID": "string",
      "priority": 0,
      "copyPrecedence": 0,
      "preFailoverScript": {
        "path": "string",
        "type": "UNC",
        "scriptCredentials": {
          "savedCredentials": {
            "id": 0,
            "name": "string"
          },
          "credentials": {
            "name": "string",
            "password": "string"
          }
        },
        "guestCredentials": {
          "savedCredentials": {
            "id": 0,
            "name": "string"
          },
          "credentials": {
            "name": "string",
            "password": "string"
          }
        },
        "reset": true
      },
      "postFailoverScript": {
        "path": "string",
        "type": "UNC",
        "scriptCredentials": {
          "savedCredentials": {
            "id": 0,
            "name": "string"
          },
          "credentials": {
            "name": "string",
            "password": "string"
          }
        },
        "guestCredentials": {
          "savedCredentials": {
            "id": 0,
            "name": "string"
          },
          "credentials": {
            "name": "string",
            "password": "string"
          }
        },
        "reset": true
      }
    }
  ],
  "arrayReplicationPairs": [
    {
      "id": 0,
      "sourceName": "string",
      "destinationName": "string",
      "GUID": "string",
      "priority": 0,
      "ipSettings": [
        {
          "sourceIP": "string",
          "sourceSubnetMask": "string",
          "sourceDefaultGateway": "string",
          "useDhcp": false,
          "destinationIP": "string",
          "destinationSubnetMask": "string",
          "destinationdefaultGateway": "string",
          "destinationPreferredDNS": "string",
          "destinationAlternateDNS": "string",
          "destinationPreferredWINS": "string",
          "destinationAlternateWINS": "string",
          "hostname": "string"
        }
      ],
      "hostname": "string"
    }
  ]
}'