Communities
A collaborative platform to connect and grow with like-minded Informaticans across the globe
Product Communities
Connect and collaborate with Informatica experts and champions
Discussions
Have a question? Start a Discussion and get immediate answers you are looking for
User Groups
Customer-organized groups that meet online and in-person. Join today to network, share ideas, and get tips on how to get the most out of Informatica
Get Started
Community Guidelines
Knowledge Center
Troubleshooting documents, product guides, how to videos, best practices, and more
Knowledge Base
One-stop self-service portal for solutions, FAQs, Whitepapers, How Tos, Videos, and more
Support TV
Video channel for step-by-step instructions to use our products, best practices, troubleshooting tips, and much more
Documentation
Information library of the latest product documents
Velocity (Best Practices)
Best practices and use cases from the Implementation team
Learn
Rich resources to help you leverage full capabilities of our products
Trainings
Role-based training programs for the best ROI
Certifications
Get certified on Informatica products. Free, Foundation, or Professional
Product Learning Paths
Free and unlimited modules based on your expertise level and journey
Resources
Library of content to help you leverage the best of Informatica products
Tech Tuesdays Webinars
Most popular webinars on product architecture, best practices, and more
Product Availability Matrix
Product Availability Matrix statements of Informatica products
SupportFlash
Monthly support newsletter
Support Documents
Informatica Support Guide and Statements, Quick Start Guides, and Cloud Product Description Schedule
Product Lifecycle
End of Life statements of Informatica products
Ideas
Events
Change Request Tracking
Marketplace
English
  • Data Replication 9.7.0 HotFix 2
  • All Products

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

Back Next

add connection

add connection

Creates a connection to a source or target.

Syntax

To enter the command and its parameters, use the following syntax: 
add connection name=
connection_name
 type=
database_type
 host=
host
 port=
port
 login=
login
 passwd=
password
  [owner=
owner
] [instance=
instance/database
] [ccs=
custom_connection_string
] [jdbc=
jdbc_custom_url
] 
[path=
flat_file_path
]
[https=true|false]
 [asm_host=
asm_host
] [asm_port=
asm_port
] [asm_user=
asm_user
] [asm_passwd=
asm_password
] [asm_instance=
asm_instance
] [asm_ccs=
asm_custom_connection_string
] [asm_jdbc=
asm_jdbc_custom_url
] 
[kafka_path=
kafka_path
] [kafka_topic=
kafka_topic
] [kafka_format=avro] [kafka_structure=avroFlatSchemaFormatV1|avroNestedSchemaFormatV2] [kafka_encoding=binary|json]
 [version=
version
][-c] [-d] [-r] 
[-s]
[-a]
The following short form is acceptable: 
ac name=
connection_name
 type=
database_type
 host=
host
 port=
port
 login=
login
 passwd=
password
  [owner=
owner
] [instance=
instance/database
] [ccs=
custom_connection_string
] [jdbc=
jdbc_connection_string
] 
[path=
flat_file_path
]
 [https=true|false] [asm_host=
asm_host
] [asm_port=
asm_port
] [asm_user=
asm_user
] [asm_passwd=
asm_password
] [asm_instance=
asm_instance
] [asm_ccs=
asm_custom_connection_string
] [asm_jdbc=
asm_jdbc_connection_string
] 
[kafka_path=
kafka_path
] [kafka_topic=
kafka_topic
] [kafka_format=avro] [kafka_structure=avroFlatSchemaFormatV1|avroNestedSchemaFormatV2] [kafka_encoding=binary|json]
 [version=
version
] [-c] [-d] [-r] [-s] 
[-a]

Parameters

The following table describes the command parameters:
Parameter
Description
name
A name for the source or target connection that you are adding.
Connection names must be unique. The names can contain the digits 0-9, Latin letters A-Z and a-z, and the underscore (_) character. The Data Replication Console truncates connection names that are longer than 120 characters.
type
A source or target type. Valid values are:
  • amazon redshift
     for Amazon Redshift targets.
  • db2
     for DB2 for Linux, UNIX, and Windows databases.
  • flat file
     for Flat File targets.
  • greenplum
     for Greenplum appliances.
  • kafka
     for Apache Kafka targets.
  • ms sql server
     for Microsoft SQL Server databases.
  • mysql
     for MySQL databases.
  • netezza
     for Netezza appliances.
  • oracle
     for Oracle databases.
  • postgresql
     for PostgreSQL databases.
  • teradata
     for Teradata appliances.
  • vertica
     for Vertica appliances.
host
Host name or IP address of the machine where the source or target runs.
port
Port number that Data Replication uses to connect to the source or target. Valid values are integers from 1 through 65535.
login
A user name that has the authority to connect to the specified source or target.
passwd
A valid password for the specified user.
owner
The Server Manager user to be used as the connection owner.
instance
Depending on the source or target type, enter one of the following types of values:
  • An Amazon Redshift, DB2, Greenplum, Netezza, PostgreSQL, or Vertica database name.
  • An Oracle instance name that is defined in an ORACLE_SID environment variable.
css
A custom connection string for the ODBC driver that the Extractor uses to access the source or target.
If you use an ODBC Data Source Name (DSN) to connect to the source database, provide the DSN connection string.
On Windows, if you installed multiple ODBC driver versions on one system, use this setting to specify a name for the driver that you want to use.
jdbc
A custom URL for the JDBC driver that the Server Manager CLI uses to access the source or target.
path
For flat file targets, a directory in the distributed file system to which the Applier loads flat files.
https
For Amazon Redshift and Greenplum targets, specifies whether to use the HTTPS protocol to connect to the target. Valid values are:
  • true
  • false
Default value: false
asm_host
The host name or IP address of the system with the Oracle ASM instance.
asm_port
The port number that is used to connect to the Oracle ASM instance. Valid values are integers from 1 through 65535. Default value: 1521.
asm_user
The user name of the default Oracle user that was created at Oracle installation, or another user that you define. This user must have SYSDBA privileges.
asm_passwd
A clear text password for the Oracle ASM user that is specified in the asm-user parameter.
asm_instance
An Oracle ASM instance name that is defined in the ORACLE_SID environment variable.
asm_ccs
A custom connection string for the ODBC driver that the Extractor uses to access the Oracle ASM database.
asm_jdbc
A custom URL for the JDBC driver that the Server Manager uses to access the specified Oracle ASM database.
kafka_path
For Apache Kafka targets, the path to the directory that contains the Kafka producer properties file.
kafka_topic
For Apache Kafka targets, the Kafka topic or topics to which Data Replication publishes messages that contain change data by using this connection. Enter one of the following values:
  • The name of the topic for all of the mapped tables in all of the configurations that use this connection.
  • The value USE_TABLE_NAME, which causes Data Replication to publish messages to a separate topic for each mapped table in each configuration that uses this connection.
By default, Kafka automatically creates a topic when Data Replication publishes a message to the topic but the topic does not yet exist. If you do not want Kafka to automatically create topics, set the
auto.create.topics.enable
 property to false in the Kafka server.properties file. With this setting, you must first create the topic or topics to which Data Replication publishes messages, before issuing this command. Otherwise, Data Replication issues an error.
kafka_format
For Apache Kafka targets, the message format. The only valid value is avro.
kafka_structure
For Apache Kafka targets, a message structure for the avro format. Valid values are avroFlatSchemaFormatV1 and avroNestedSchemaFormatV2.
kafka_encoding
For Apache Kafka targets, the message encoding type for the avro format. Valid values are binary and json.
version
For Cloudera and Hortonworks targets, the version number.
-c
Indicates whether to use an ODBC custom connection string or JDBC custom URL to connect to the source or target. If you specify this parameter, you must also specify the css parameter, jdbc parameter, or both.
-d
For Oracle sources and targets, indicates that you connect to the database without using the Oracle instance. The connection string takes the form of /.
-r
For Oracle sources and targets, indicates that you capture data only from Oracle archived redo logs in a RAC environment.
-s
For Oracle sources and targets, indicates whether to use the Oracle SID instead of the SERVICE_NAME to build the connection string.
-a
For Oracle ASM sources and targets, indicates whether to use the Oracle SID instead of the SERVICE_NAME to build the connection string.

Examples

The following command creates the ora_src connection: 
ac name=ora_src type=oracle host=10.51.40.78 port=1521 login=DATAREP_USER passwd=DATAREP_USER_PASS owner=idradmin instance=orcl
The following command creates the asm_connection connection: 
add connection name=asm_connection type=oracle host=10.51.40.26 port=1521 login='sys as sysdba' passwd=84218421 instance=orcl asmHost=10.51.40.26 asmPort=1521 asmUser=sys asmPasswd=84218421 asmInstance=+asm
0 COMMENTS
We’d like to hear from you!