Table of Contents

Search

  1. Preface
  2. Overview of the Server Manager Command Line Interface
  3. Usage Scenario: Using Server Manager CLI Commands to Run Replications
  4. Command Reference

Command Line Interface for the Server Manager

Command Line Interface for the Server Manager

Deployment Properties File

Deployment Properties File

Use the deployment properties file to deploy a configuration or configuration changes to a remote Server Manager Main server or locally. To create a deploy.properties file, customize the default deploy.properties file that is located in the
DataReplication_installation
/doc/samples/deploy
directory, and then save your customized copy of this file.
The following sections describe the properties in the deploy.properties file.

Server Manager and Configuration Properties

Define deployment properties for connecting to the Server Manager Main server in the destination environment.
The following table describes these deployment properties:
Property
Description
prodSmAddress
The host name or IP address of the system with the Server Manager Main server instance in the destination environment.
prodSmPort
The port number of the Server Manager Main server instance in the destination environment. Valid values are integers from 1 through 65535.
prodSmUser
A user name that has the authority to connect to the specified Server Manager Main server instance in the destination environment.
prodSmSSL
Indicates whether the Server Manager Main server in the destination environment uses HTTPS connections. Valid values are:
  • true
    . The Main server in the destination environment uses HTTPS connections.
  • false
    . The Main server in the destination environment uses HTTP connections.
prodConfig
The name of the replication configuration to use on the destination system with the Server Manager Main server.

Source and Target Connection Properties

Define deployment properties for connecting to the source and target databases and naming the recovery tables in the destination environment.
The properties for connecting to targets and naming the recovery tables have names ending with an
N
value. Each group of these properties in the deploy.properties file must use the same
N
value.
N
is a number that reflects the sequence of the target connection definition in the deployment properties file. For the primary target that you specify on the
Target Database
tab in the Data Replication Console, the
N
value is 1. For each secondary target that you specify on the
Routing
tab, the number is incremented by 1. The maximum
N
value is 2147483647.
The following table describes these deployment properties:
Property
Description
prodSrcConnection
The name of the source database connection in the destination environment. Required for a deployment or redeployment.
prodSrcServer
The name of the source Server Manager instance in the destination environment.
prodTgtConnection
N
The name of the target database connection in the destination environment. Required for a deployment or redeployment.
If you are deploying a fanout configuration that has one source and multiple targets, this name can be the name of a secondary target database connection.
prodTgtServer
N
The name of the target Server Manager instance in the destination environment.
If you are deploying a fanout configuration that has one source and multiple targets, this name can be the name of the Server Manager instance on a secondary target.
prodIsPrimaryTarget
N
Indicates whether the target database associated with the prodTgtConnection
N
and prodTgtServer
N
properties is a primary target. Valid values are:
  • true
    . The target is the primary target.
  • false
    . The target is a secondary target. If you are deploying a fanout configuration that has one source and multiple target databases, you must use this setting for a secondary target specification.
prodRecoveryTable
N
The fully qualified name of the recovery table, including the schema or owner name, for the primary target or a secondary target that is associated with the prodTgtConnection
N
and prodTgtServer
N
properties. The format of the recovery table name depends on the target database type:
  • For Microsoft SQL Server targets, each element in the recovery table name is enclosed in square brackets:
    [
    database
    ].[
    owner
    ].[
    IDR_RECOVERY
    ]
  • For all other targets, each element in the recovery table name is enclosed in double quotation marks:
    "schema"."IDR_RECOVERY"
    Enclose the recovery table name in double quotation marks if the name is
    case-sensitive
    . The double quotation marks are optional if the recovery table name is not case-sensitive.
testTgtConnection
N
If you are deploying a fanout configuration that has one source and multiple target databases, the name of a secondary target database connection in the original environment. This property is not used for the primary target database.

Schema Replacement Rule Properties

Define deployment properties that create rules for replacing the source and target schema names in the original environment with different source and target schema names in the destination environment.
All of the properties for defining a schema replacement rule have names ending with an
N
value. Each group of these properties in the deploy.properties file must use the same
N
value.
N
is a number that reflects the sequence of the schema replacement rule in the deploy.properties file. For the first replacement rule, the
N
value is 1. For each additional replacement rule, the number is incremented by 1. The maximum
N
value is 2147483647.
The following table describes these deployment properties:
Property
Description
testSrcSchema
N
The source schema name in the original environment.
prodSrcSchema
N
The replacement source schema name to use in the destination environment.
testTgtSchema
N
The target schema name in the original environment.
prodTgtSchema
N
The replacement target schema name to use in the destination environment.
prodTgtPrimaryTarget
N
Indicates whether the schema replacement rule is for a primary target in the destination environment. Valid values are:
  • true
    . The schema replacement rule is for the primary target in the destination environment.
  • false
    . The schema replacement rule is for a secondary target in the destination environment.
testConnName
N
The name of the target database connection in the original environment.

Extract Range Properties

Define deployment properties for identifying the source database logs from which to extract data in the destination environment and the source system type.
The properties for identifying the log files have names that begin with "logFile" and end with an
N
value. Each set of logFile properties that define a log file specification in the deploy.properties file must use the same
N
value.
N
is a number that reflects the order of the log file specification in the deploy.properties file. The first log file specification has an
N
value of 1. For each additional log file specification, the
N
value is incremented by 1.
The following table describes these deployment properties:
Property
Description
logFilesBase
N
The directory that Data Replication searches for the source database log files.
logFilesRecursiveScan
N
Indicates whether to recursively search for database log files in the subfolders of the specified
N
base directory. Valid values are:
  • true
    . Search recursively for log files in the subfolders of the base directory.
  • false
    . Search for log files only in the base directory.
logFileName
N
_
M
The name of a database log file or a mask for the names of the database log files in the directory specified by the logFilesBase
N
property.
If you enter a specific log file name, you can repeat this property to specify another log file. In this case, the appended
M
value is incremented by 1 for each additional log file that you specify. The maximum
M
value is 2147483647.
To define a mask, you can use any of the following wildcard characters: an asterisk (*), question mark (?), or square brackets ([ ]). For example, to read all files with the .bak extension, enter *.bak. In this case, the property name has an
M
value of 1 and you cannot enter another mask.
platform
The source operating system type in the destination environment. Valid values are:
  • AIX
  • HPUX
  • Linux
  • SUN
  • Windows
You must specify the platform property if the Extractor processes logs from a remote source database in the destination environment. If the Extractor runs on the source database system, you can delete this property from the deployment properties file.
systemLittleEndian
Indicates whether the source database in the destination environment is a little-endian system. Use this property only if you specify the platform property. Valid values are:
  • true
    . The source database is a little-endian system.
  • false
    . The source database is a big-endian system.
Default value:
  • true
    for Linux and Windows
  • false
    for AIX, HP-UX, and Solaris
The default value for the platform property is used if you leave the property empty or delete it from the deployment properties file.
systemBlockSize
The block size of the source database system in the destination environment. Use this property only if you specify the platform property.
Default values:
  • 1024
    for HP-UX
  • 512
    for AIX, Linux, Solaris, and Windows
The default value for the platform property is used if you leave the property empty or delete it from the deployment properties file.
diskAlignSize
The disk align size of the source database system in the destination environment. Use this property only if you specify the platform property.
Default values:
  • 8
    for HP-UX
  • 4
    for AIX, Linux, Solaris, and Windows
The default value for the platform property is used if you leave the property empty or delete it from the deployment properties file.
isRealtime
Indicates whether to read online redo logs. Valid values are:
  • true
    . Capture change data from online redo logs.
  • false
    . Do not capture change data from online redo logs. Data Replication can still capture changes from archived redo logs at the location specified in the logFilesBase
    N
    property.

0 COMMENTS

We’d like to hear from you!