Failover Tasks

Select

SaaS

Customer Managed

Operations related to Failover groups

application/json

Request Body

• taskInfo object

  task object

  taskFlags object

  disabled integer

  taskType integer

  ownerId integer

  initiatedFrom integer

  sequenceNumber integer

  ownerName string

  subTasks object

  subTask object

  subTaskType integer

  operationType integer

  options object

  adminOpts object

  drOrchestrationOption object

  vApp object

  vAppId integer

  vAppName string

  advancedOptions object

  skipDisableNetworkAdapter integer

  operationType integer

  initiatedfromMonitor integer

  subTaskOperation integer

Responses

• 200

---

OK

application/json

• Schema
• Example (from schema)
• Example 1

---

Schema

• taskId integer
• jobIds string[]

{
  "taskId": 0,
  "jobIds": [
    "string"
  ]
}

{
  "taskId": 386,
  "jobIds": [
    "5870"
  ]
}

POST /createtask    

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL

https://CommandCenterHostName/commandcenter/api

Security Scheme

tokenbearerToken

token

Body

• Default
• Testboot
• Planned Failover
• UnPlanned Failover
• Failback on a Failover group
• Undo Failover
• Test Failover

---

{
  "taskInfo": {
    "task": {
      "taskFlags": {
        "disabled": 0
      },
      "taskType": 0,
      "ownerId": 0,
      "initiatedFrom": 0,
      "sequenceNumber": 0,
      "ownerName": "string"
    },
    "subTasks": {
      "subTask": {
        "subTaskType": 0,
        "operationType": 0
      },
      "options": {
        "adminOpts": {
          "drOrchestrationOption": {
            "vApp": {
              "vAppId": 0,
              "vAppName": "string"
            },
            "advancedOptions": {
              "skipDisableNetworkAdapter": 0
            },
            "operationType": 0,
            "initiatedfromMonitor": 0
          }
        }
      },
      "subTaskOperation": 0
    }
  }
}

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/CreateTask' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "taskInfo": {
    "task": {
      "taskFlags": {
        "disabled": 0
      },
      "taskType": 0,
      "ownerId": 0,
      "initiatedFrom": 0,
      "sequenceNumber": 0,
      "ownerName": "string"
    },
    "subTasks": {
      "subTask": {
        "subTaskType": 0,
        "operationType": 0
      },
      "options": {
        "adminOpts": {
          "drOrchestrationOption": {
            "vApp": {
              "vAppId": 0,
              "vAppName": "string"
            },
            "advancedOptions": {
              "skipDisableNetworkAdapter": 0
            },
            "operationType": 0,
            "initiatedfromMonitor": 0
          }
        }
      },
      "subTaskOperation": 0
    }
  }
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/CreateTask' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "taskInfo": {
    "task": {
      "taskFlags": {
        "disabled": 0
      },
      "taskType": 0,
      "ownerId": 0,
      "initiatedFrom": 0,
      "sequenceNumber": 0,
      "ownerName": "string"
    },
    "subTasks": {
      "subTask": {
        "subTaskType": 0,
        "operationType": 0
      },
      "options": {
        "adminOpts": {
          "drOrchestrationOption": {
            "vApp": {
              "vAppId": 0,
              "vAppName": "string"
            },
            "advancedOptions": {
              "skipDisableNetworkAdapter": 0
            },
            "operationType": 0,
            "initiatedfromMonitor": 0
          }
        }
      },
      "subTaskOperation": 0
    }
  }
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/CreateTask' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "taskInfo": {
    "task": {
      "taskFlags": {
        "disabled": 0
      },
      "taskType": 0,
      "ownerId": 0,
      "initiatedFrom": 0,
      "sequenceNumber": 0,
      "ownerName": "string"
    },
    "subTasks": {
      "subTask": {
        "subTaskType": 0,
        "operationType": 0
      },
      "options": {
        "adminOpts": {
          "drOrchestrationOption": {
            "vApp": {
              "vAppId": 0,
              "vAppName": "string"
            },
            "advancedOptions": {
              "skipDisableNetworkAdapter": 0
            },
            "operationType": 0,
            "initiatedfromMonitor": 0
          }
        }
      },
      "subTaskOperation": 0
    }
  }
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/CreateTask' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "taskInfo": {
    "task": {
      "taskFlags": {
        "disabled": 0
      },
      "taskType": 0,
      "ownerId": 0,
      "initiatedFrom": 0,
      "sequenceNumber": 0,
      "ownerName": "string"
    },
    "subTasks": {
      "subTask": {
        "subTaskType": 0,
        "operationType": 0
      },
      "options": {
        "adminOpts": {
          "drOrchestrationOption": {
            "vApp": {
              "vAppId": 0,
              "vAppName": "string"
            },
            "advancedOptions": {
              "skipDisableNetworkAdapter": 0
            },
            "operationType": 0,
            "initiatedfromMonitor": 0
          }
        }
      },
      "subTaskOperation": 0
    }
  }
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/CreateTask' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "taskInfo": {
    "task": {
      "taskFlags": {
        "disabled": 0
      },
      "taskType": 0,
      "ownerId": 0,
      "initiatedFrom": 0,
      "sequenceNumber": 0,
      "ownerName": "string"
    },
    "subTasks": {
      "subTask": {
        "subTaskType": 0,
        "operationType": 0
      },
      "options": {
        "adminOpts": {
          "drOrchestrationOption": {
            "vApp": {
              "vAppId": 0,
              "vAppName": "string"
            },
            "advancedOptions": {
              "skipDisableNetworkAdapter": 0
            },
            "operationType": 0,
            "initiatedfromMonitor": 0
          }
        }
      },
      "subTaskOperation": 0
    }
  }
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/CreateTask' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "taskInfo": {
    "task": {
      "taskFlags": {
        "disabled": 0
      },
      "taskType": 0,
      "ownerId": 0,
      "initiatedFrom": 0,
      "sequenceNumber": 0,
      "ownerName": "string"
    },
    "subTasks": {
      "subTask": {
        "subTaskType": 0,
        "operationType": 0
      },
      "options": {
        "adminOpts": {
          "drOrchestrationOption": {
            "vApp": {
              "vAppId": 0,
              "vAppName": "string"
            },
            "advancedOptions": {
              "skipDisableNetworkAdapter": 0
            },
            "operationType": 0,
            "initiatedfromMonitor": 0
          }
        }
      },
      "subTaskOperation": 0
    }
  }
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/CreateTask' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "taskInfo": {
    "task": {
      "taskFlags": {
        "disabled": 0
      },
      "taskType": 0,
      "ownerId": 0,
      "initiatedFrom": 0,
      "sequenceNumber": 0,
      "ownerName": "string"
    },
    "subTasks": {
      "subTask": {
        "subTaskType": 0,
        "operationType": 0
      },
      "options": {
        "adminOpts": {
          "drOrchestrationOption": {
            "vApp": {
              "vAppId": 0,
              "vAppName": "string"
            },
            "advancedOptions": {
              "skipDisableNetworkAdapter": 0
            },
            "operationType": 0,
            "initiatedfromMonitor": 0
          }
        }
      },
      "subTaskOperation": 0
    }
  }
}'