Release Information


Getting Started

Delphix Engine System Administration

Virtual Database Management with the Delphix Engine

Data Backup and Recovery

Delphix Modernization Engine

Delphix Masking

Virtualizing Unstructured Files in the Delphix Engine

Virtualizing Oracle E-Business Suite in the Delphix Engine


Mission Control

Delphix Express User Guide


Documentation for Previous Versions of the Delphix Engine

Delphix Server 3.0 Documentation
Delphix Server 3.1 Documentation
Delphix Engine 3.2 Documentation
Delphix Engine 4.0 Documentation
Delphix Engine 4.1 Documentation
Delphix Engine 4.2 Documentation
Delphix Engine 4.3 Documentation

Skip to end of metadata
Go to start of metadata

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.


  • 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. 


  1. Switch to the replication spec context.

    delphix> cd replication/spec
    delphix replication spec> ls
  2. Create a new replication spec.

    delphix replication spec> create
    delphix replication spec create *> ls
        type: ReplicationSpec
        name: (unset)
        bandwidthLimit: (unset)
        enabled: (unset)
        encrypted: (unset)
        objects: (required)
        schedule: (unset)
            type: PasswordCredential
            password: (required)
        targetHost: (required)
        targetPrincipal: (required)
  3. Specify the target host name, user, and credentials.

    delphix replication spec create *> set
    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


  1. This page needs updating, the replication spec parameters are from an older release so more recent ones are missing.

    > ls


        type: ReplicationSpec

        name: (unset)

        bandwidthLimit: 0

        compressed: true

        description: (unset)

        enabled: false

        encrypted: false

        numberOfConnections: 1


            type: ReplicationList

            name: (unset)

            objects: (required)

        schedule: (unset)


            type: PasswordCredential

            password: (required)

        targetHost: (required)

        targetPort: 8415

        targetPrincipal: (required)

        useSystemSocksSetting: false

    We could also add a description of the useSystemSocksSetting parameter, if a proxy has been configured and should be used for this replication this needs to be set to true.


  2. SDD Secure replication

    To create a Selective Data Distribution (SDD) type spec set the objectSpecification.type once SDD is enabled. See (IKB102 how to enable SDD) for enable procedure.

    delphix replication spec create *> set objectSpecification.type=ReplicationSecureList

    This parameter defaults to ReplicationList which implies a regular replication spec.