CLI Cookbook: Adding a Replication Spec

This topic describes how to use the command line interface to add a replication specification to the Delphix Engine.

Unlike the GUI, the CLI supports the ability to manage multiple replication specifications within a single system. This allows updates to be sent to multiple systems from a single point.

Prerequisites

• You should review the topic Replication Overview to understand which objects are copied as part of a backup or restore operation, as well as the dependencies between objects. 

Procedure

1. Switch to the replication spec context.

   delphix> cd replication/spec
   delphix replication spec> ls
   Operations
   create

2. Create a new replication spec.

   delphix replication spec> create
   delphix replication spec create *> ls
   Properties
       type: ReplicationSpec
       name: (unset)
       bandwidthLimit: (unset)
       enabled: (unset)
       encrypted: (unset)
       objects: (required)
       schedule: (unset)
       targetCredential:
           type: PasswordCredential
           password: (required)
       targetHost: (required)
       targetPrincipal: (required)

3. Specify the target host name, user, and credentials.

   delphix replication spec create *> set targetHost=exampleHost.mycompany.com
   delphix replication spec create *> set targetPrincipal=delphix_admin
   delphix replication spec create *> set targetCredential.password=password

   Target Principal

   The target principal must be a Delphix user on the target host who has domain privileges.

4. Specify the set of objects to replicate.

   1. To replicate all dSources and VDBs on the system, specify `DOMAINas the list of objects.

      delphix replication spec create *> set objects=`DOMAIN

   2. To replicate a subset of Groups, VDBs and dSources, specify their names as a comma-separated list.

      delphix replication spec create *> set objects=dExample1,dExample2

      Name Completion

      The CLI will provide possible completions for all objects in the system, but only groups, dSources and VDBs can be specified. Attempts to replicate other types of objects will generate an error when the operation is committed.

5. Commit the operation.

   delphix replication spec create *> commit
       `REPLICATION_SPEC-1