Devices - List Failover Targets

Given a list of volume containers to be failed over from a source device, this method returns the eligibility result, as a failover target, for all devices under that resource.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{sourceDeviceName}/listFailoverTargets?api-version=2017-06-01

URI Parameters

Name In Required Type Description
managerName
path True
  • string

The manager name

resourceGroupName
path True
  • string

The resource group name

sourceDeviceName
path True
  • string

The source device name on which failover is performed.

subscriptionId
path True
  • string

The subscription id

api-version
query True
  • string

The api version

Request Body

Name Type Description
volumeContainers
  • string[]

The list of path IDs of the volume containers that needs to be failed-over, for which we want to fetch the eligible targets.

Responses

Name Type Description
200 OK

The list of target devices and their eligibility for failover.

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation impersonate your user account

Examples

DevicesListFailoverTargets

Sample Request

POST https://management.azure.com/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/ResourceGroupForSDKTest/providers/Microsoft.StorSimple/managers/ManagerForSDKTest1/devices/Device05ForSDKTest/listFailoverTargets?api-version=2017-06-01
{
  "volumeContainers": [
    "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/ResourceGroupForSDKTest/providers/Microsoft.StorSimple/managers/ManagerForSDKTest1/devices/Device05ForSDKTest/volumeContainers/vcforsdktest"
  ]
}

Sample Response

{
  "value": [
    {
      "deviceId": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/ResourceGroupForSDKTest/providers/Microsoft.StorSimple/managers/ManagerForSDKTest1/devices/sugattdeviceforSDK",
      "deviceStatus": "Offline",
      "deviceSoftwareVersion": "6.3.9600.17802",
      "dataContainersCount": 0,
      "volumesCount": 0,
      "availableLocalStorageInBytes": 43980464128,
      "availableTieredStorageInBytes": 1099511627776,
      "friendlyDeviceSoftwareVersion": "StorSimple 8000 Series Update 4.0",
      "eligibilityResult": {
        "eligibilityStatus": "NotEligible",
        "messages": [
          {
            "message": "The selected target device is in 'Offline' state. The device configuration status is 'True'. Only online devices with the configuration status as complete can be failed over.",
            "resolution": "Ensure that the specified target device is online and the device configuration is complete before you try the device failover.",
            "resultCode": "TargetIsNotOnlineError"
          }
        ]
      }
    },
    {
      "deviceId": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/ResourceGroupForSDKTest/providers/Microsoft.StorSimple/managers/ManagerForSDKTest1/devices/jemdeviceforsdk",
      "deviceStatus": "Online",
      "deviceSoftwareVersion": "6.3.9600.17802",
      "dataContainersCount": 0,
      "volumesCount": 0,
      "availableLocalStorageInBytes": 43980464128,
      "availableTieredStorageInBytes": 1099511627776,
      "friendlyDeviceSoftwareVersion": "StorSimple 8000 Series Update 4.0",
      "eligibilityResult": {
        "eligibilityStatus": "Eligible"
      }
    },
    {
      "deviceId": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/ResourceGroupForSDKTest/providers/Microsoft.StorSimple/managers/ManagerForSDKTest1/devices/Device05ForSDKTest",
      "deviceStatus": "Online",
      "deviceSoftwareVersion": "6.3.9600.17802",
      "dataContainersCount": 2,
      "volumesCount": 7,
      "availableLocalStorageInBytes": 40458590976,
      "availableTieredStorageInBytes": 1011464798208,
      "friendlyDeviceSoftwareVersion": "StorSimple 8000 Series Update 4.0",
      "eligibilityResult": {
        "eligibilityStatus": "NotEligible",
        "messages": [
          {
            "message": "The specified target device is the same as the source device. This is not supported. ",
            "resolution": "Select a different target device and then retry the failover. ",
            "resultCode": "TargetAndSourceCannotBeSameError"
          }
        ]
      }
    }
  ]
}

Definitions

DeviceStatus

The current status of the device.

FailoverTarget

Represents the eligibility of a device as a failover target device.

FailoverTargetsList

The list of all devices in a resource and their eligibility status as a failover target device.

ListFailoverTargetsRequest

The request object for fetching the list of failover targets (eligible devices for failover).

TargetEligibilityErrorMessage

The error/warning message due to which the device is ineligible as a failover target device.

TargetEligibilityResult

The eligibility result of device, as a failover target device.

TargetEligibilityResultCode

The result code for the error, due to which the device does not qualify as a failover target device.

TargetEligibilityStatus

The eligibility status of device, as a failover target device.

DeviceStatus

The current status of the device.

Name Type Description
Creating
  • string
Deactivated
  • string
Deactivating
  • string
Deleted
  • string
MaintenanceMode
  • string
Offline
  • string
Online
  • string
Provisioning
  • string
ReadyToSetup
  • string
RequiresAttention
  • string
Unknown
  • string

FailoverTarget

Represents the eligibility of a device as a failover target device.

Name Type Description
availableLocalStorageInBytes
  • integer

The amount of free local storage available on the device in bytes.

availableTieredStorageInBytes
  • integer

The amount of free tiered storage available for the device in bytes.

dataContainersCount
  • integer

The count of data containers on the device.

deviceId
  • string

The path ID of the device.

deviceLocation
  • string

The geo location (applicable only for cloud appliances) of the device.

deviceSoftwareVersion
  • string

The software version of the device.

deviceStatus

The status of the device.

eligibilityResult

The eligibility result of the device, as a failover target device.

friendlyDeviceSoftwareVersion
  • string

The friendly name for the current version of software on the device.

modelDescription
  • string

The model number of the device.

volumesCount
  • integer

The count of volumes on the device.

FailoverTargetsList

The list of all devices in a resource and their eligibility status as a failover target device.

Name Type Description
value

The list of all the failover targets.

ListFailoverTargetsRequest

The request object for fetching the list of failover targets (eligible devices for failover).

Name Type Description
volumeContainers
  • string[]

The list of path IDs of the volume containers that needs to be failed-over, for which we want to fetch the eligible targets.

TargetEligibilityErrorMessage

The error/warning message due to which the device is ineligible as a failover target device.

Name Type Description
message
  • string

The localized error message stating the reason why the device is not eligible as a target device.

resolution
  • string

The localized resolution message for the error.

resultCode

The result code for the error, due to which the device does not qualify as a failover target device.

TargetEligibilityResult

The eligibility result of device, as a failover target device.

Name Type Description
eligibilityStatus

The eligibility status of device, as a failover target device.

messages

The list of error messages, if a device does not qualify as a failover target device.

TargetEligibilityResultCode

The result code for the error, due to which the device does not qualify as a failover target device.

Name Type Description
LocalToTieredVolumesConversionWarning
  • string
TargetAndSourceCannotBeSameError
  • string
TargetInsufficientCapacityError
  • string
TargetInsufficientLocalVolumeMemoryError
  • string
TargetInsufficientTieredVolumeMemoryError
  • string
TargetIsNotOnlineError
  • string
TargetSourceIncompatibleVersionError
  • string

TargetEligibilityStatus

The eligibility status of device, as a failover target device.

Name Type Description
Eligible
  • string
NotEligible
  • string