Skip to main content

Get list of eligible machines that can be added to failover groups​

API to get list of machines eligible to be added to failover group

Query Parameters
  • sourceEntityId int32 required

    The ID of the source entity. This is the ID for client or client group

  • failoverGroupSource string

    Possible values: [ARRAY_REPLICATION_TEST_FAILOVER, ARRAY_REPLICATION_FAILOVER, REPLICATION, BACKUP]

    The type of failover group source. Default value is 'REPLICATION'

  • sourceEntityType string

    Possible values: [CLIENT_GROUP, CLIENT]

    The type of source entity. It can be 'CLIENT' or 'CLIENT_ENTITY'. Default value is 'CLIENT'

  • destinationClientId int32

    The client ID of the destination

Responses

OK

Schema
  • virtualMachines object[]
  • replicationPairs object[]

    The list of all replication pairs eligible to be added to failover group with replication source

  • id int32

    The ID of the replication pair

  • sourceName string

    The name of the source 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

  • reset boolean

    On set to true, resets the script to empty

  • 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

  • reset boolean

    On set to true, resets the script to empty

  • arrayReplicationPairs object[]

    List of all array replication pairs for failover group that are eligible to be added

  • id int32

    The ID of the array replication pair

  • sourceName string

    The name of the source 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 host name to be applied for the destination VM.

  • hostname string

    The hostname specified for the destination machine

Loading...