Get Failover group details

Select

SaaS

Customer Managed

API to fetch failover group information

Path Parameters

failoverGroupId int32 required
Id of the failover group

Responses

application/json

Schema
Example (from schema)

Schema

id int32
Failover group Id
name string
Failover group name
sourceHypervisor object
The hypervisor client/client group information for failover groups
id int32
The Id of client/client group
name string
The name of the hypervisor client/client group
type string
Possible values: [CLIENT_GROUP, CLIENT]
The type of entity is used
vendor string
Possible values: [NONE, VMW, MICROSOFT, XEN_SERVER, AMAZON, AZURE, REDHAT, AZURE_V2, SCVMM, NUTANIX, ORACLE_VM, DOCKER, OPENSTACK, ORACLE_CLOUD, FUSIONCOMPUTE, VCLOUD, GOOGLE_CLOUD, AZURE_STACK, ALIBABA_CLOUD, ORACLE_CLOUD_INFRASTRUCTURE, KUBERNETES, REDHAT_OPENSHIFT, MONGODB_ATLAS, PROXMOX, KUBERNETES_AKS, AZURE_STACK_HCI]
destinationHypervisor object
The hypervisor client/client group information for failover groups
id int32
The Id of client/client group
name string
The name of the hypervisor client/client group
type string
Possible values: [CLIENT_GROUP, CLIENT]
The type of entity is used
vendor string
Possible values: [NONE, VMW, MICROSOFT, XEN_SERVER, AMAZON, AZURE, REDHAT, AZURE_V2, SCVMM, NUTANIX, ORACLE_VM, DOCKER, OPENSTACK, ORACLE_CLOUD, FUSIONCOMPUTE, VCLOUD, GOOGLE_CLOUD, AZURE_STACK, ALIBABA_CLOUD, ORACLE_CLOUD_INFRASTRUCTURE, KUBERNETES, REDHAT_OPENSHIFT, MONGODB_ATLAS, PROXMOX, KUBERNETES_AKS, AZURE_STACK_HCI]
source string
Possible values: [ARRAY_REPLICATION_TEST_FAILOVER, ARRAY_REPLICATION_FAILOVER, REPLICATION, BACKUP]
Failover group type
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
operationType string
Possible values: [LIVE_MOUNT, LIVE_SYNC, RESTORE, LIVE_RECOVERY, FAILOVER, VIRTUAL_LAB, ORACLE_EBS_APP, GENERIC_ENTERPRISE_APP, TEST_FAILOVER]
Failover group operation type
subclient object
id int32
name string
storagePolicy object
id int32
name string
copy object
id int32
name string
priorityIntervalInMinutes int32
Possible values: >= 1
The interval between DR operations of different priorities
continueDROnFailure boolean
Whether to continue to next priority on DR job failure
recoveryTarget object
id int32
name string
automaticFailover object
The failover group automatic failover information of access nodes and monitoring status
machines object[]
id int32
name string
monitoringStatus string
Possible values: [DISABLED, FAILED, ENABLED, PAUSED, STARTING, NOT_CONFIGURED]
Automatic failover monitoring status
outageDelayTimeInMinutes int32
Delay time before declaring outage (in minutes)
status string
Possible values: [OFFLINE, ONLINE]
Automatic failover configuration status
plannedFailoverSchedules object[]
The list of all planned failover schedules
scheduleId int32
Id of the schedule if available, required for modifying, deleting schedule
scheduleName string
Name of the schedule, for modify
policyId int32
Schedule policy Id to which the schedule belongs
scheduleOperation string
Possible values: [ADD, DELETE, MODIFY]
Default value: MODIFY
Operation being performed on schedule
vmOperationType string
Possible values: [PLANNED_FAILOVER, TEST_BOOT]
Type of DR operation (only applicable for Failover groups)
backupType string
Possible values: [FULL, INCREMENTAL, DIFFERENTIAL, SYNTHETICFULL, TRANSACTIONLOG]
Schedule Backup level
forDatabasesOnly boolean
Default value: false
Boolean to indicate if schedule is for database agents
isRetentionBasedSyntheticFull boolean
Default value: false
Boolean to indicate if synthetic full schedule is based on retention rules
isAuxCopySchedule boolean
Default value: false
Boolean to indicate if schedule is aux copy schedule.
schedulePattern object
Used to describe when the schedule runs
scheduleFrequencyType string
Possible values: [MINUTES, DAILY, WEEKLY, MONTHLY, YEARLY, AUTOMATIC]
schedule frequency type
frequency int32
Possible values: >= 1
Frequency of the schedule based on schedule frequency type eg. for Hours, value 2 is 2 hours, for Minutes, 30 is 30 minutes, for Daily, 2 is 2 days. for Monthly 2 is it repeats every 2 months
weeklyDays string[]
Possible values: [SUNDAY, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY]
Days of the week for weekly frequency
dayOfMonth int32
Possible values: >= 1 and <= 31
Day on which to run the schedule, applicable for monthly, yearly
weekOfMonth string
Possible values: [FIRST, SECOND, THIRD, FOURTH, LAST]
Specific week of a month
dayOfWeek string
Possible values: [SUNDAY, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, DAY, WEEKDAY, WEEKEND_DAYS]
monthOfYear string
Possible values: [JANUARY, FEBRUARY, MARCH, APRIL, MAY, JUNE, JULY, AUGUST, SEPTEMBER, OCTOBER, NOVEMBER, DECEMBER]
repeatIntervalInMinutes int32
Possible values: >= 1
How often in minutes in a day the schedule runs, applicable for daily, weekly, monthly and yearly frequency types.
repeatUntilTime int32
Until what time to repeat the schedule in a day, requires repeatIntervalInMinutes
timezone object
id int32
name string
startTime int32
Default value: 75600
start time of schedule in seconds
startDate int32
start date of schedule in epoch format
endDate int32
Schedule end date in epoch format
noOfTimes int32
The number of times you want the schedule to run.
exceptions object[]
Exceptions to when a schedule should not run, either in dates or week of month and days
onDates int32[]
Possible values: >= 1 and <= 31
list of dates in a month. For ex: 1, 20
onWeekOfTheMonth string[]
Possible values: [FIRST, SECOND, THIRD, FOURTH, LAST]
On which week of month, for ex: FIRST, LAST
onDayOfTheWeek string[]
Possible values: [SUNDAY, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, DAY, WEEKDAY, WEEKEND_DAYS]
On which days, for ex: MONDAY, FRIDAY
daysBetweenSyntheticFulls int32
Possible values: >= 6
No of days between two synthetic full jobs
maxBackupIntervalInMins int32
Default value: 240
The number of mins to force a backup on automatic schedule.
scheduleOption object
Specific options to be set on schedules
useDiskCacheForLogBackups boolean
Used to enable disk caching feature on databases for automatic schedules on server plan
commitFrequencyInHours int32
Commit frequency in hours for disk cache backups from automatic schedules
daysBetweenAutoConvert int32
Number of days between auto conversion of backup level applicable for databases on incremental and differential schedules of server plan
o365ItemSelectionOption string
Possible values: [SELECT_ALL, SELECT_NEVER_PROCESSED, SELECT_MEETING_SLA, SELECT_NOT_MEETING_SLA_PROCESSED_ATLEAST_ONCE, SELECT_FAILED_LAST_ATTEMPT, SELECT_PROCESSED_ATLEAST_ONCE, SELECT_NOT_MEETING_SLA, SELECT_MEETING_SLA_NOT_RECENTLY_BACKED_UP]
item backup option for O365 V2 backup jobs
jobRunningTimeInMins int32
total job running time in minutes
minBackupIntervalInMins int32
Default value: 15
The min number of mins to check for file activity on automatic schedule.
logFilesThreshold int32
Default value: 50
The min number of archived log files before a backup job should start
logsDiskUtilizationPercent int32
Default value: 80
The min log destination disk threshold percentage
additionalInfo string
testBootSchedules object[]
The list of all test boot schedules
scheduleId int32
Id of the schedule if available, required for modifying, deleting schedule
scheduleName string
Name of the schedule, for modify
policyId int32
Schedule policy Id to which the schedule belongs
scheduleOperation string
Possible values: [ADD, DELETE, MODIFY]
Default value: MODIFY
Operation being performed on schedule
vmOperationType string
Possible values: [PLANNED_FAILOVER, TEST_BOOT]
Type of DR operation (only applicable for Failover groups)
backupType string
Possible values: [FULL, INCREMENTAL, DIFFERENTIAL, SYNTHETICFULL, TRANSACTIONLOG]
Schedule Backup level
forDatabasesOnly boolean
Default value: false
Boolean to indicate if schedule is for database agents
isRetentionBasedSyntheticFull boolean
Default value: false
Boolean to indicate if synthetic full schedule is based on retention rules
isAuxCopySchedule boolean
Default value: false
Boolean to indicate if schedule is aux copy schedule.
schedulePattern object
Used to describe when the schedule runs
scheduleFrequencyType string
Possible values: [MINUTES, DAILY, WEEKLY, MONTHLY, YEARLY, AUTOMATIC]
schedule frequency type
frequency int32
Possible values: >= 1
Frequency of the schedule based on schedule frequency type eg. for Hours, value 2 is 2 hours, for Minutes, 30 is 30 minutes, for Daily, 2 is 2 days. for Monthly 2 is it repeats every 2 months
weeklyDays string[]
Possible values: [SUNDAY, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY]
Days of the week for weekly frequency
dayOfMonth int32
Possible values: >= 1 and <= 31
Day on which to run the schedule, applicable for monthly, yearly
weekOfMonth string
Possible values: [FIRST, SECOND, THIRD, FOURTH, LAST]
Specific week of a month
dayOfWeek string
Possible values: [SUNDAY, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, DAY, WEEKDAY, WEEKEND_DAYS]
monthOfYear string
Possible values: [JANUARY, FEBRUARY, MARCH, APRIL, MAY, JUNE, JULY, AUGUST, SEPTEMBER, OCTOBER, NOVEMBER, DECEMBER]
repeatIntervalInMinutes int32
Possible values: >= 1
How often in minutes in a day the schedule runs, applicable for daily, weekly, monthly and yearly frequency types.
repeatUntilTime int32
Until what time to repeat the schedule in a day, requires repeatIntervalInMinutes
timezone object
id int32
name string
startTime int32
Default value: 75600
start time of schedule in seconds
startDate int32
start date of schedule in epoch format
endDate int32
Schedule end date in epoch format
noOfTimes int32
The number of times you want the schedule to run.
exceptions object[]
Exceptions to when a schedule should not run, either in dates or week of month and days
onDates int32[]
Possible values: >= 1 and <= 31
list of dates in a month. For ex: 1, 20
onWeekOfTheMonth string[]
Possible values: [FIRST, SECOND, THIRD, FOURTH, LAST]
On which week of month, for ex: FIRST, LAST
onDayOfTheWeek string[]
Possible values: [SUNDAY, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, DAY, WEEKDAY, WEEKEND_DAYS]
On which days, for ex: MONDAY, FRIDAY
daysBetweenSyntheticFulls int32
Possible values: >= 6
No of days between two synthetic full jobs
maxBackupIntervalInMins int32
Default value: 240
The number of mins to force a backup on automatic schedule.
scheduleOption object
Specific options to be set on schedules
useDiskCacheForLogBackups boolean
Used to enable disk caching feature on databases for automatic schedules on server plan
commitFrequencyInHours int32
Commit frequency in hours for disk cache backups from automatic schedules
daysBetweenAutoConvert int32
Number of days between auto conversion of backup level applicable for databases on incremental and differential schedules of server plan
o365ItemSelectionOption string
Possible values: [SELECT_ALL, SELECT_NEVER_PROCESSED, SELECT_MEETING_SLA, SELECT_NOT_MEETING_SLA_PROCESSED_ATLEAST_ONCE, SELECT_FAILED_LAST_ATTEMPT, SELECT_PROCESSED_ATLEAST_ONCE, SELECT_NOT_MEETING_SLA, SELECT_MEETING_SLA_NOT_RECENTLY_BACKED_UP]
item backup option for O365 V2 backup jobs
jobRunningTimeInMins int32
total job running time in minutes
minBackupIntervalInMins int32
Default value: 15
The min number of mins to check for file activity on automatic schedule.
logFilesThreshold int32
Default value: 50
The min number of archived log files before a backup job should start
logsDiskUtilizationPercent int32
Default value: 80
The min log destination disk threshold percentage
additionalInfo string
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
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

{
  "id": 0,
  "name": "string",
  "sourceHypervisor": {
    "id": 0,
    "name": "string",
    "type": "CLIENT_GROUP",
    "vendor": "NONE"
  },
  "destinationHypervisor": {
    "id": 0,
    "name": "string",
    "type": "CLIENT_GROUP",
    "vendor": "NONE"
  },
  "source": "ARRAY_REPLICATION_TEST_FAILOVER",
  "isApprovalRequired": true,
  "usersToNotify": [
    {
      "id": 0,
      "name": "string",
      "displayName": "string",
      "company": {
        "id": 0,
        "name": "string"
      }
    }
  ],
  "operationType": "LIVE_MOUNT",
  "subclient": {
    "id": 0,
    "name": "string"
  },
  "storagePolicy": {
    "id": 0,
    "name": "string"
  },
  "copy": {
    "id": 0,
    "name": "string"
  },
  "priorityIntervalInMinutes": 0,
  "continueDROnFailure": true,
  "recoveryTarget": {
    "id": 0,
    "name": "string"
  },
  "automaticFailover": {
    "machines": [
      {
        "id": 0,
        "name": "string"
      }
    ],
    "monitoringStatus": "DISABLED",
    "outageDelayTimeInMinutes": 0,
    "status": "OFFLINE"
  },
  "plannedFailoverSchedules": [
    {
      "scheduleId": 0,
      "scheduleName": "string",
      "policyId": 0,
      "scheduleOperation": "MODIFY",
      "vmOperationType": "PLANNED_FAILOVER",
      "backupType": "FULL",
      "forDatabasesOnly": false,
      "isRetentionBasedSyntheticFull": false,
      "isAuxCopySchedule": false,
      "schedulePattern": {
        "scheduleFrequencyType": "MINUTES",
        "frequency": 0,
        "weeklyDays": [
          "SUNDAY"
        ],
        "dayOfMonth": 0,
        "weekOfMonth": "FIRST",
        "dayOfWeek": "SUNDAY",
        "monthOfYear": "JANUARY",
        "repeatIntervalInMinutes": 0,
        "repeatUntilTime": 0,
        "timezone": {
          "id": 0,
          "name": "string"
        },
        "startTime": 75600,
        "startDate": 0,
        "endDate": 0,
        "noOfTimes": 0,
        "exceptions": [
          {
            "onDates": [
              0
            ],
            "onWeekOfTheMonth": [
              "FIRST"
            ],
            "onDayOfTheWeek": [
              "SUNDAY"
            ]
          }
        ],
        "daysBetweenSyntheticFulls": 0,
        "maxBackupIntervalInMins": 240
      },
      "scheduleOption": {
        "useDiskCacheForLogBackups": true,
        "commitFrequencyInHours": 0,
        "daysBetweenAutoConvert": 0,
        "o365ItemSelectionOption": "SELECT_ALL",
        "jobRunningTimeInMins": 0,
        "minBackupIntervalInMins": 15,
        "logFilesThreshold": 50,
        "logsDiskUtilizationPercent": 80
      },
      "additionalInfo": "string"
    }
  ],
  "testBootSchedules": [
    {
      "scheduleId": 0,
      "scheduleName": "string",
      "policyId": 0,
      "scheduleOperation": "MODIFY",
      "vmOperationType": "PLANNED_FAILOVER",
      "backupType": "FULL",
      "forDatabasesOnly": false,
      "isRetentionBasedSyntheticFull": false,
      "isAuxCopySchedule": false,
      "schedulePattern": {
        "scheduleFrequencyType": "MINUTES",
        "frequency": 0,
        "weeklyDays": [
          "SUNDAY"
        ],
        "dayOfMonth": 0,
        "weekOfMonth": "FIRST",
        "dayOfWeek": "SUNDAY",
        "monthOfYear": "JANUARY",
        "repeatIntervalInMinutes": 0,
        "repeatUntilTime": 0,
        "timezone": {
          "id": 0,
          "name": "string"
        },
        "startTime": 75600,
        "startDate": 0,
        "endDate": 0,
        "noOfTimes": 0,
        "exceptions": [
          {
            "onDates": [
              0
            ],
            "onWeekOfTheMonth": [
              "FIRST"
            ],
            "onDayOfTheWeek": [
              "SUNDAY"
            ]
          }
        ],
        "daysBetweenSyntheticFulls": 0,
        "maxBackupIntervalInMins": 240
      },
      "scheduleOption": {
        "useDiskCacheForLogBackups": true,
        "commitFrequencyInHours": 0,
        "daysBetweenAutoConvert": 0,
        "o365ItemSelectionOption": "SELECT_ALL",
        "jobRunningTimeInMins": 0,
        "minBackupIntervalInMins": 15,
        "logFilesThreshold": 50,
        "logsDiskUtilizationPercent": 80
      },
      "additionalInfo": "string"
    }
  ],
  "esxServerMappings": [
    {
      "sourceServer": "string",
      "destinationServer": "string",
      "networkSettings": [
        {
          "source": "string",
          "sourceId": "string",
          "destination": "string"
        }
      ]
    }
  ],
  "replicationPairs": [
    {
      "id": 0,
      "sourceId": 0,
      "sourceName": "string",
      "destinationId": 0,
      "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"
          }
        },
        "guid": "string",
        "scriptContent": "string",
        "scriptName": "string",
        "reset": true,
        "osType": "WINDOWS"
      },
      "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"
          }
        },
        "guid": "string",
        "scriptContent": "string",
        "scriptName": "string",
        "reset": true,
        "osType": "WINDOWS"
      },
      "preFailbackScript": {
        "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"
          }
        },
        "guid": "string",
        "scriptContent": "string",
        "scriptName": "string",
        "reset": true,
        "osType": "WINDOWS"
      },
      "postFailbackScript": {
        "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"
          }
        },
        "guid": "string",
        "scriptContent": "string",
        "scriptName": "string",
        "reset": true,
        "osType": "WINDOWS"
      }
    }
  ],
  "arrayReplicationPairs": [
    {
      "id": 0,
      "sourceId": 0,
      "sourceName": "string",
      "destinationId": 0,
      "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"
    }
  ],
  "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"
        }
      },
      "guid": "string",
      "scriptContent": "string",
      "scriptName": "string",
      "reset": true,
      "osType": "WINDOWS"
    },
    "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"
        }
      },
      "guid": "string",
      "scriptContent": "string",
      "scriptName": "string",
      "reset": true,
      "osType": "WINDOWS"
    },
    "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"
        }
      },
      "guid": "string",
      "scriptContent": "string",
      "scriptName": "string",
      "reset": true,
      "osType": "WINDOWS"
    },
    "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"
        }
      },
      "guid": "string",
      "scriptContent": "string",
      "scriptName": "string",
      "reset": true,
      "osType": "WINDOWS"
    }
  }
}

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
}

GET /v4/failovergroups/:failovergroupid

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL

https://CommandCenterHostName/commandcenter/api

Security Scheme

token

failoverGroupId — path required

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/V4/FailoverGroups/:failoverGroupId' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/V4/FailoverGroups/:failoverGroupId' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/V4/FailoverGroups/:failoverGroupId' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/V4/FailoverGroups/:failoverGroupId' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/V4/FailoverGroups/:failoverGroupId' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/V4/FailoverGroups/:failoverGroupId' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/V4/FailoverGroups/:failoverGroupId' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

Get Failover group details​

Authorization

Request

Get Failover group details