Skip to main content

Get replication group details

Select

SaaS
Customer Managed

Get details of a replication group based on replicationGroupId

Path Parameters
  • replicationGroupId string required
Query Parameters
  • viewReplicationOptions boolean

    Set to true if want to show replication options for a continuous replication group

  • overrideReplicationOptions boolean

    Set to true if you want to see override replication options for a periodic replication group

Responses

Success

Response Headers

    Schema
      oneOf

    • id int32

      Replication group id

    • name string

      Replication group name

    • summary object

      Summary of replication group

    • source string

      Source hypervisor

    • recoveryTarget string

      Can be used to identify destination for full VM restore

    • destinationVendor string

      Possible values: [Amazon, Azure, HyperV, VMware]

      Vendor used as destination for replication.

    • replicationType string

      Possible values: [Periodic, Continuous]

      Default value: Periodic

      The field specifies the type of replication that is to be performed

    • state string

      Possible values: [Enabled, Disabled, N/A]

      State of replication group. Values are case sensitive

    • rpo object

      Frequency of replication

    • replicationFrequency int32

      Default value: 240

      Max amount of time for which data can be lost during a service disruption. Determines frequency of backup jobs in minutes

    • storage object

      List of storage configured for a replication group

    • copies object[]

      List of all storages which are configured for that replication group

    • name string

      Storage name. Primary, secondary

    • storagePool object
    • id int32
    • name string
    • retention int32

      How long the data is retained. Mentioned in days

    • copyForReplication string

      Main storage which is used for replication

    • advancedOption object

      The advanced option for replication group

    • delayBetweenPriorityMachines int32

      Default value: 2

      The delay between machines in different priorities. Mention in minutes

    • continueOnFailure boolean

      Default value: false

      Set to true to continue to the next priority machines on failure.

    • 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

    • unconditionalOverwrite boolean

      This will replace the instance at the destination if the instance with the same name already exists.

    • replicationConfiguration object[]
    • sourceVM string

      Source VM instance name

    • sourceVMGuid string

      Source VM instance guid

    • destinationVM string

      Destination VM instance name

    • availabilityDomain string

      Destination VM instance availability domain

    • stagingBucket string

      Staged bucket name for restore operation

    • region string

      Instance region

    • createPublicIP boolean

      Public/External IP of the destination VM instance

    • shape string

      Destination VM instance shape

    • overrideReplicationOptions object

      Extended instance configuration options

    • network object

      Network interface for the destination instances

    • networkDisplayName string

      Network display name

    • networkName string

      Name of network

    • subnetId string

      subnet id of network

    • compartment object
    • name string
    • value string
    • vendor string

      Possible values: [OCI]

      Vendor type of this replication group. Values in enum are case sensitive

    Loading...