Skip to main content

Modify ReplicationGroup​

Modify the properties of an existing replication group

Path Parameters
  • replicationGroupId string required
Request Body
  • newName string

    Used to change the name of a replication group

  • enable boolean

    Used to enable a replication group

  • disable boolean

    Used to disable a replication group

  • advancedOptions object

    The advanced option for replication group

  • delayBetweenPriorityMachines int32

    Default value: 2

    The delay between machines in different priorities. Mention in minutes

  • continueOnFailure boolean

    Default value: false

    Set to true to continue to the next priority machines on failure.

  • script object

    All the scripts of replication group

  • 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

  • reset boolean

    On set to true, resets the script to empty

  • 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

  • reset boolean

    On set to true, resets the script to empty

  • 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

  • reset boolean

    On set to true, resets the script to empty

  • 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

  • reset boolean

    On set to true, resets the script to empty

Responses

Success

Schema
  • errorMessage string
  • errorCode int32
PUT /v4/replicationgroup/:replicationgroupid

Authorization

type: apiKeyname: Authtokenin: header

Request

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

  "newName": "string",

  "enable": true,

  "disable": true,

  "advancedOptions": {

    "delayBetweenPriorityMachines": 2,

    "continueOnFailure": false,

    "script": {

      "preFailover": {

        "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

      },

      "postFailover": {

        "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

      },

      "preFailback": {

        "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

      },

      "postFailback": {

        "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

      }

    }

  }

}

curl -L -X PUT 'https://localhost/webconsole/api/V4/ReplicationGroup/:replicationGroupId' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "newName": "string",
  "enable": true,
  "disable": true,
  "advancedOptions": {
    "delayBetweenPriorityMachines": 2,
    "continueOnFailure": false,
    "script": {
      "preFailover": {
        "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
      },
      "postFailover": {
        "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
      },
      "preFailback": {
        "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
      },
      "postFailback": {
        "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
      }
    }
  }
}'