Update Failover Group

Select

SaaS

Customer Managed

This operation updates the properties associated with a Failover group.

More Details

Path Parameters

FailoverGroupId string required

application/json

Request Body

action integer
vApp object
description string
source integer
isClientGroup boolean
operationType integer
selectedEntities object[]
clientId integer
entityName string
entityId integer
instanceId integer
workflow object[]
type integer
entity object
workflowId integer
autofailover object
timeThresholdBeforeFailover integer
status integer
vAppEntity object
vAppId integer
vAppName string
clientList object[]
clientId integer
GUID string
entityId integer
clientName string
backupsetId integer
backupsetName string
config object
vmGroups object[]
delay integer
groupId integer
continueOnFailure boolean
vmSequence object[]
copyPrecedence integer
replicationId integer
vmInfo object
vmName string
vmGUID string

Responses

application/json

Schema
Example (from schema)
Update Failover Groups

Schema

resp object
errorMessage string
errorCode integer
entity object
vAppId integer
vAppName string

{
  "resp": {
    "errorMessage": "string",
    "errorCode": 0
  },
  "entity": {
    "vAppId": 0,
    "vAppName": "string"
  }
}

{
  "resp": {
    "errorMessage": "",
    "errorCode": 0
  },
  "entity": {
    "vAppId": 14,
    "vAppName": "TestNotAfterBackup"
  }
}

PUT /failovergroups/:failovergroupid

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL

https://CommandCenterHostName/commandcenter/api

Security Scheme

token

FailoverGroupId — path required

Body

Default
Update Failover Groups

{
  "action": 0,
  "vApp": {
    "description": "string",
    "source": 0,
    "isClientGroup": true,
    "operationType": 0,
    "selectedEntities": [
      {
        "clientId": 0,
        "entityName": "string",
        "entityId": 0,
        "instanceId": 0
      }
    ],
    "workflow": [
      {
        "type": 0,
        "entity": {
          "workflowId": 0
        }
      }
    ],
    "autofailover": {
      "timeThresholdBeforeFailover": 0,
      "status": 0
    },
    "vAppEntity": {
      "vAppId": 0,
      "vAppName": "string"
    },
    "clientList": [
      {
        "clientId": 0,
        "GUID": "string",
        "entityId": 0,
        "clientName": "string",
        "backupsetId": 0,
        "backupsetName": "string"
      }
    ],
    "config": {
      "vmGroups": [
        {
          "delay": 0,
          "groupId": 0,
          "continueOnFailure": true,
          "vmSequence": [
            {
              "copyPrecedence": 0,
              "replicationId": 0,
              "vmInfo": {
                "vmName": "string",
                "vmGUID": "string"
              }
            }
          ]
        }
      ]
    }
  }
}

curl -L -X PUT 'https://CommandCenterHostName/commandcenter/api/FailoverGroups/:FailoverGroupId' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "action": 0,
  "vApp": {
    "description": "string",
    "source": 0,
    "isClientGroup": true,
    "operationType": 0,
    "selectedEntities": [
      {
        "clientId": 0,
        "entityName": "string",
        "entityId": 0,
        "instanceId": 0
      }
    ],
    "workflow": [
      {
        "type": 0,
        "entity": {
          "workflowId": 0
        }
      }
    ],
    "autofailover": {
      "timeThresholdBeforeFailover": 0,
      "status": 0
    },
    "vAppEntity": {
      "vAppId": 0,
      "vAppName": "string"
    },
    "clientList": [
      {
        "clientId": 0,
        "GUID": "string",
        "entityId": 0,
        "clientName": "string",
        "backupsetId": 0,
        "backupsetName": "string"
      }
    ],
    "config": {
      "vmGroups": [
        {
          "delay": 0,
          "groupId": 0,
          "continueOnFailure": true,
          "vmSequence": [
            {
              "copyPrecedence": 0,
              "replicationId": 0,
              "vmInfo": {
                "vmName": "string",
                "vmGUID": "string"
              }
            }
          ]
        }
      ]
    }
  }
}'

curl -L -X PUT 'https://CommandCenterHostName/commandcenter/api/FailoverGroups/:FailoverGroupId' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "action": 0,
  "vApp": {
    "description": "string",
    "source": 0,
    "isClientGroup": true,
    "operationType": 0,
    "selectedEntities": [
      {
        "clientId": 0,
        "entityName": "string",
        "entityId": 0,
        "instanceId": 0
      }
    ],
    "workflow": [
      {
        "type": 0,
        "entity": {
          "workflowId": 0
        }
      }
    ],
    "autofailover": {
      "timeThresholdBeforeFailover": 0,
      "status": 0
    },
    "vAppEntity": {
      "vAppId": 0,
      "vAppName": "string"
    },
    "clientList": [
      {
        "clientId": 0,
        "GUID": "string",
        "entityId": 0,
        "clientName": "string",
        "backupsetId": 0,
        "backupsetName": "string"
      }
    ],
    "config": {
      "vmGroups": [
        {
          "delay": 0,
          "groupId": 0,
          "continueOnFailure": true,
          "vmSequence": [
            {
              "copyPrecedence": 0,
              "replicationId": 0,
              "vmInfo": {
                "vmName": "string",
                "vmGUID": "string"
              }
            }
          ]
        }
      ]
    }
  }
}'

curl -L -X PUT 'https://CommandCenterHostName/commandcenter/api/FailoverGroups/:FailoverGroupId' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "action": 0,
  "vApp": {
    "description": "string",
    "source": 0,
    "isClientGroup": true,
    "operationType": 0,
    "selectedEntities": [
      {
        "clientId": 0,
        "entityName": "string",
        "entityId": 0,
        "instanceId": 0
      }
    ],
    "workflow": [
      {
        "type": 0,
        "entity": {
          "workflowId": 0
        }
      }
    ],
    "autofailover": {
      "timeThresholdBeforeFailover": 0,
      "status": 0
    },
    "vAppEntity": {
      "vAppId": 0,
      "vAppName": "string"
    },
    "clientList": [
      {
        "clientId": 0,
        "GUID": "string",
        "entityId": 0,
        "clientName": "string",
        "backupsetId": 0,
        "backupsetName": "string"
      }
    ],
    "config": {
      "vmGroups": [
        {
          "delay": 0,
          "groupId": 0,
          "continueOnFailure": true,
          "vmSequence": [
            {
              "copyPrecedence": 0,
              "replicationId": 0,
              "vmInfo": {
                "vmName": "string",
                "vmGUID": "string"
              }
            }
          ]
        }
      ]
    }
  }
}'

curl -L -X PUT 'https://CommandCenterHostName/commandcenter/api/FailoverGroups/:FailoverGroupId' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "action": 0,
  "vApp": {
    "description": "string",
    "source": 0,
    "isClientGroup": true,
    "operationType": 0,
    "selectedEntities": [
      {
        "clientId": 0,
        "entityName": "string",
        "entityId": 0,
        "instanceId": 0
      }
    ],
    "workflow": [
      {
        "type": 0,
        "entity": {
          "workflowId": 0
        }
      }
    ],
    "autofailover": {
      "timeThresholdBeforeFailover": 0,
      "status": 0
    },
    "vAppEntity": {
      "vAppId": 0,
      "vAppName": "string"
    },
    "clientList": [
      {
        "clientId": 0,
        "GUID": "string",
        "entityId": 0,
        "clientName": "string",
        "backupsetId": 0,
        "backupsetName": "string"
      }
    ],
    "config": {
      "vmGroups": [
        {
          "delay": 0,
          "groupId": 0,
          "continueOnFailure": true,
          "vmSequence": [
            {
              "copyPrecedence": 0,
              "replicationId": 0,
              "vmInfo": {
                "vmName": "string",
                "vmGUID": "string"
              }
            }
          ]
        }
      ]
    }
  }
}'

curl -L -X PUT 'https://CommandCenterHostName/commandcenter/api/FailoverGroups/:FailoverGroupId' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "action": 0,
  "vApp": {
    "description": "string",
    "source": 0,
    "isClientGroup": true,
    "operationType": 0,
    "selectedEntities": [
      {
        "clientId": 0,
        "entityName": "string",
        "entityId": 0,
        "instanceId": 0
      }
    ],
    "workflow": [
      {
        "type": 0,
        "entity": {
          "workflowId": 0
        }
      }
    ],
    "autofailover": {
      "timeThresholdBeforeFailover": 0,
      "status": 0
    },
    "vAppEntity": {
      "vAppId": 0,
      "vAppName": "string"
    },
    "clientList": [
      {
        "clientId": 0,
        "GUID": "string",
        "entityId": 0,
        "clientName": "string",
        "backupsetId": 0,
        "backupsetName": "string"
      }
    ],
    "config": {
      "vmGroups": [
        {
          "delay": 0,
          "groupId": 0,
          "continueOnFailure": true,
          "vmSequence": [
            {
              "copyPrecedence": 0,
              "replicationId": 0,
              "vmInfo": {
                "vmName": "string",
                "vmGUID": "string"
              }
            }
          ]
        }
      ]
    }
  }
}'

curl -L -X PUT 'https://CommandCenterHostName/commandcenter/api/FailoverGroups/:FailoverGroupId' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "action": 0,
  "vApp": {
    "description": "string",
    "source": 0,
    "isClientGroup": true,
    "operationType": 0,
    "selectedEntities": [
      {
        "clientId": 0,
        "entityName": "string",
        "entityId": 0,
        "instanceId": 0
      }
    ],
    "workflow": [
      {
        "type": 0,
        "entity": {
          "workflowId": 0
        }
      }
    ],
    "autofailover": {
      "timeThresholdBeforeFailover": 0,
      "status": 0
    },
    "vAppEntity": {
      "vAppId": 0,
      "vAppName": "string"
    },
    "clientList": [
      {
        "clientId": 0,
        "GUID": "string",
        "entityId": 0,
        "clientName": "string",
        "backupsetId": 0,
        "backupsetName": "string"
      }
    ],
    "config": {
      "vmGroups": [
        {
          "delay": 0,
          "groupId": 0,
          "continueOnFailure": true,
          "vmSequence": [
            {
              "copyPrecedence": 0,
              "replicationId": 0,
              "vmInfo": {
                "vmName": "string",
                "vmGUID": "string"
              }
            }
          ]
        }
      ]
    }
  }
}'

curl -L -X PUT 'https://CommandCenterHostName/commandcenter/api/FailoverGroups/:FailoverGroupId' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "action": 0,
  "vApp": {
    "description": "string",
    "source": 0,
    "isClientGroup": true,
    "operationType": 0,
    "selectedEntities": [
      {
        "clientId": 0,
        "entityName": "string",
        "entityId": 0,
        "instanceId": 0
      }
    ],
    "workflow": [
      {
        "type": 0,
        "entity": {
          "workflowId": 0
        }
      }
    ],
    "autofailover": {
      "timeThresholdBeforeFailover": 0,
      "status": 0
    },
    "vAppEntity": {
      "vAppId": 0,
      "vAppName": "string"
    },
    "clientList": [
      {
        "clientId": 0,
        "GUID": "string",
        "entityId": 0,
        "clientName": "string",
        "backupsetId": 0,
        "backupsetName": "string"
      }
    ],
    "config": {
      "vmGroups": [
        {
          "delay": 0,
          "groupId": 0,
          "continueOnFailure": true,
          "vmSequence": [
            {
              "copyPrecedence": 0,
              "replicationId": 0,
              "vmInfo": {
                "vmName": "string",
                "vmGUID": "string"
              }
            }
          ]
        }
      ]
    }
  }
}'

Update Failover Group​

Authorization

Request

Update Failover Group