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
  • Common Content for Data Engineering 10.5.3
  • All Products

Table of Contents

Search

  1. Preface
  2. Command Line Programs and Utilities
  3. Installing and Configuring Command Line Utilities
  4. Using the Command Line Programs
  5. Environment Variables for Command Line Programs
  6. Using infacmd
  7. infacmd as Command Reference
  8. infacmd aud Command Reference
  9. infacmd autotune Command Reference
  10. Infacmd bg Command Reference
  11. infacmd ccps Command Reference
  12. infacmd cluster Command Reference
  13. infacmd cms Command Reference
  14. infacmd dis Command Reference
  15. Infacmd dis Queries
  16. infacmd dp Command Reference
  17. infacmd idp Command Reference
  18. infacmd edp Command Reference
  19. Infacmd es Command Reference
  20. infacmd ics Command Reference
  21. infacmd ipc Command Reference
  22. infacmd isp Command Reference
  23. infacmd ldm Command Reference
  24. infacmd mas Command Reference
  25. infacmd mi Command Reference
  26. infacmd mrs Command Reference
  27. infacmd ms Command Reference
  28. infacmd oie Command Reference
  29. infacmd ps Command Reference
  30. infacmd pwx Command Reference
  31. infacmd roh Command Reference
  32. infacmd rms Command Reference
  33. infacmd rtm Command Reference
  34. infacmd sch Command Reference
  35. infacmd search Command Reference
  36. infacmd sql Command Reference
  37. infacmd tdm Command Reference
  38. infacmd tools Command Reference
  39. infacmd wfs Command Reference
  40. infacmd ws Command Reference
  41. infacmd xrf Command Reference
  42. infacmd Control Files
  43. infasetup Command Reference
  44. pmcmd Command Reference
  45. pmrep Command Reference
  46. Working with filemanager
  47. Working with pmrep Files

Command Reference

Command Reference

Back Next

DefineGatewayNode

DefineGatewayNode

Defines a gateway node on the current machine. This command overwrites the nodemeta.xml file that stores the configuration metadata for the node. After you define the node, run the infacmd isp AddDomainNode command to add it to the domain.
The DefineGatewayNode command uses the following syntax: 
DefineGatewayNode
<-DatabaseAddress|-da> database_hostname:database_port|<-DatabaseConnectionString|-cs> database_connection_string>
[<-DatabaseUserName|-du> database_user_name]
[<-DatabasePassword|-dp> database_password]
<-DatabaseType|-dt> database_type ORACLE|DB2|MSSQLSERVER|SYBASE|POSTGRESQL
[<-DatabaseServiceName|-ds> database_service_name]
<-DomainName|-dn> domain_name
<-NodeName|-nn> node_name
<-NodeAddress|-na> node_host:port
[<-ServiceManagerPort|-sp> service_manager_port]
[<-EnableTLS|-tls> enable_tls]
[<-NodeKeystore|-nk> node_keystore_directory]
[<-NodeKeystorePass|-nkp> node_keystore_password]
[<-NodeTruststore|-nt> node_truststore_directory]
[<-NodeTruststorePass|-ntp> node_truststore_password]
[<-CipherWhiteList|-cwl> comma_separated_white_list_jsse_cipher_names]
[<-CipherBlackList|-cbl> comma_separated_black_list_jsse_cipher_names]
[<-CipherWhiteListFile|-cwlf> absolute_filename_containing_comma_separated_white_list_jsse_cipher_names]
[<-CipherBlackListFile|-cblf> absolute_filename_containing_comma_separated_black_list_jsse_cipher_names]
[<-EnableKerberos|-krb> enable_kerberos]
[<-ServiceRealmName|-srn> realm_name_of_node_spn]
[<-UserRealmName|-urn> realm_name_of_user_spn]
[<-KeysDirectory|-kd> Infa_keys_directory_location]
[<-EnableSaml|-saml> enable_saml]
[<-SamlTrustStoreDir|-std> saml_truststore_directory]
[<-SamlTrustStorePassword|-stp> saml_truststore_password]
[<-SamlKeyStoreDir|-skd> saml_keystore_directory]
[<-SamlKeyStorePassword|-skp> saml_keystore_password]
[<-AdminconsolePort|-ap> admin_tool_port]
[<-HttpsPort|-hs> admin_tool_https_port]
[<-KeystoreFile|-kf> admin_tool_keystore_file_location]
[<-KeystorePass|-kp> admin_tool_keystore_password]
[<-MinProcessPort|-mi> minimum_port]
[<-MaxProcessPort|-ma> maximum_port]
<-LogServiceDirectory|-ld> log_service_directory
[<-SystemLogDirectory|-sld> system_log_directory]
[<-ServerPort|-sv> server_shutdown_port]
[<-AdminconsoleShutdownPort|-asp> admin_tool_shutdown_port]
[<-BackupDirectory|-bd> backup_directory]
[<-ErrorLogLevel|-el> FATAL_ERROR_WARNING_INFO_TRACE_DEBUG]
<-ResourceFile|-rf> resource_file
[<-Tablespace|-ts> tablespace_name]
[<-SchemaName|-sc> schema_name (used for MSSQLServer and PostgreSQL only)]
[<-DatabaseTlsEnabled|-dbtls> database_tls_enabled]
[<-DatabaseTruststorePassword|-dbtp> database_truststore_password]
[<-TrustedConnection|-tc> trusted_connection (used for MSSQLServer only)]
[<-DatabaseTruststoreLocation|-dbtl> database_truststore_location]
The following table describes
infasetup
 DefineGatewayNode options and arguments:
Option
Description
-DatabaseAddress
-da
Required if you do not use -DatabaseConnectionString (-cs) option. Name and port number of the machine hosting the domain configuration database.
-DatabaseConnectionString
-cs
Connection string used to connect to the domain configuration database.
Required if you do not use -DatabaseAddress (-da) and -DatabaseServiceName (-ds) options.
Specify the database host, database port, and the database service name as part of the connection string.
Enclose the connection string in double quotes.
-DatabaseUserName
-du
Required if you do not use -TrustedConnection (-tc) option. Account for the database containing the domain configuration information.
-DatabasePassword
-dp
Domain configuration database password corresponding to the database user. If you omit this option,
infasetup
 uses the password specified in the INFA_DEFAULT_DATABASE_PASSWORD environment variable. If no value is specified in the environment variable, you must enter a password using this option.
-DatabaseType
-dt
Required. Type of database that stores the domain configuration metadata. Database types include:
  • db2
  • oracle
  • mssqlserver
  • sybase
  • postgresql
-DatabaseServiceName
-ds
Required if you do not use -DatabaseConnectionString (-cs) option. The database service name. Required for Oracle, IBM DB2, and Microsoft SQL Server databases. Enter the SID for Oracle, the service name for IBM DB2, or the database name for Microsoft SQL Server.
-DomainName
-dn
Required. Name of the domain.
-NodeName
-nn
Optional. Name of the node. Node names must be between 1 and 79 characters and cannot contain spaces or the following characters: \ / * ? < > " |
-NodeAddress
-na
Optional. Host name and port number for the machine hosting the node. Choose an available port number.
-ServiceManagerPort
-sp
Optional. Port number used by the Service Manager to listen for incoming connection requests.
-EnableTLS
-tls
Optional. Configures secure communication among the services in the Informatica domain.
If you use the default SSL certificates provided by Informatica, you do not need to specify the keystore and truststore options. If you do not use the default SSL certificate, you must specify the keystore and truststore options. Valid values are true or false. Default is false. If you specify the -tls option without a value, the Informatica domain uses secure communication among the services.
To enable secure communication for the associated services or web applications, such as Administrator tool, Analyst tool, or Web Services Hub, configure the secure communication separately within the applications.
-NodeKeystore
-nk
Optional if you use the default SSL certificates from Informatica. Required if you use your SSL certificates. Directory that contains the keystore files. The Informatica domain requires the SSL certificates in PEM format and in Java Keystore (JKS) files. The directory must contain keystore files in PEM and JKS formats.
The keystore files must be named infa_keystore.jks and infa_keystore.pem. If the keystore file that you receive from the certificate authority (CA) has a different name, you must rename it to infa_keystore.jks and infa_keystore.pem.
You must use the same keystore file for all the nodes in the domain.
-NodeKeystorePass
-nkp
Optional if you use the default SSL certificates from Informatica. Required if you use your SSL certificates. Password for the keystore infa_keystore.jks file.
-NodeTruststore
-nt
Optional if you use the default SSL certificates from Informatica. Required if you use your SSL certificates. Directory that contains the truststore files. The Informatica domain requires the SSL certificates in PEM format and in Java Keystore (JKS) files. The directory must contain truststore files in PEM and JKS formats.
The truststore files must be named infa_truststore.jks and infa_truststore.pem. If the truststore file that you receive from the certificate authority (CA) has a different name, you must rename it to infa_truststore.jks and infa_truststore.pem.
-NodeTruststorePass
-ntp
Optional if you use the default SSL certificates from Informatica. Required if you use your SSL certificates. Password for the infa_truststore.jks file.
-CipherWhiteList
-cwl
Optional. Comma-separated list of JSSE cipher suites that you want to add to the effective list.
The list must contain at least one valid JRE or OpenSSL cipher suite.
-CipherBlackList
-cbl
Optional. Comma-separated list of JSSE cipher suites that you want to remove from the effective list.
The effective list must contain at least one valid JRE or OpenSSL cipher suite.
-CipherWhiteListFile
-cwlf
Optional. Absolute file name of the plain text file that contains a comma-separated list of cipher suites that you want to add to the effective list.
The list must contain at least one valid JRE or OpenSSL cipher suite.
-CipherBlackListFile
-cblf
Optional. Absolute file name of the plain text file that contains a comma-separated list of cipher suites that you want to remove from the effective list.
The effective list must contain at least one valid JRE or OpenSSL cipher suite.
-EnableKerberos
-krb
Optional. Configures the Informatica domain to use Kerberos authentication. Valid values are true or false. If true, the domain uses Kerberos authentication, and you cannot later change the authentication mode. After you enable Kerberos authentication, you cannot disable it. Default is false. If you specify the -krb option without a value, the Informatica domain uses Kerberos authentication.
-ServiceRealmName
-srn
Optional. Name of the Kerberos realm that the domain uses to authenticate users. The realm name must be in uppercase and is case-sensitive.
To configure Kerberos cross realm authentication, specify the name of each Kerberos realm that the domain uses to authenticate users, separated by a comma. For example:
COMPANY.COM,EAST.COMPANY.COM,WEST.COMPANY.COM
Use an asterisk as a wildcard character before a realm name to include all realms that include the name. For example, specify the following value to include all realms that include the EAST.COMPANY.COM name:
*EAST.COMPANY.COM
-UserRealmName
-urn
Optional. Name of the Kerberos realm that the domain uses to authenticate users. The realm name must be in uppercase and is case-sensitive.
To configure Kerberos cross realm authentication, specify the name of each Kerberos realm that the domain uses to authenticate users, separated by a comma. For example:
COMPANY.COM,EAST.COMPANY.COM,WEST.COMPANY.COM
Use an asterisk as a wildcard character before a realm name to include all realms that include the name. For example, specify the following value to include all realms that include the EAST.COMPANY.COM name:
*EAST.COMPANY.COM
-KeysDirectory
-kd
Optional. Directory where all keytab files and the encryption key for the Informatica domain are stored. Default is
<InformaticaInstallationDir>/isp/config/keys
.
-EnableSaml
-saml
Optional. Enables or disables SAML authentication in the Informatica domain.
Set this value to true to enable SAML authentication in the Informatica domain. Default is false.
-SamlTrustStoreDir
-std
Optional. The directory containing the custom truststore file required to use SAML authentication on the gateway node. Specify the directory only, not the full path to the file.
The default Informatica truststore is used if no truststore is specified.
-SamlTrustStorePassword
-stp
Required if you use a custom truststore for SAML authentication. The password for the custom truststore.
-SamlKeyStoreDir
-skd
Optional. The directory containing the custom keystore file required to use SAML authentication on the gateway node. Specify the directory only, not the full path to the file.
-SamlKeyStorePassword
-skp
Required if you use a custom keystore for SAML authentication. Password to the SAML keystore. *
-AdminconsolePort
-ap
Optional. Port to access Informatica Administrator.
-HttpsPort
-hs
Optional. Port number that the node uses for communication between the Administrator tool and the Service Manager. Set this port number if you want to configure HTTPS for a node.
To disable HTTPS support for a node, set this port number to zero.
-KeystoreFile
-kf
Optional. Keystore file that contains the keys and certificates required if you use the SSL security protocol.
-KeystorePass
-kp
Optional. A plain-text password for the keystore file. You can set a password with the -kp option or the environment variable INFA_PASSWORD. If you set a password with both methods, the password set with the -kp option takes precedence.
-MinProcessPort
-mi
Optional. Minimum port number for application service processes that run on the node. Default is 11000.
-MaxProcessPort
-ma
Optional. Maximum port number for application service processes that run on the node. Default is 11999.
-LogServiceDirectory
-ld
Required. Shared directory path used by the Log Manager to store log event files. Verify that -ld does not match or contain the specified -sld value.
-SystemLogDirectory
-sld
Optional. Directory path to store system log files. Verify that -ld does not match or contain the specified -sld value. Default is <INFA_home>/logs.
-ServerPort
-sv
Optional. TCP/IP port number used by the Service Manager. The Service Manager listens for shutdown commands from PowerCenter components on this port. Set this port number if you have multiple nodes on one machine or if the default port number is in use. Default is 8005.
-AdminconsoleShutdownPort
-asp
Optional. Port number that controls shutdown for Informatica Administrator.
-BackupDirectory
-bd
Optional. Directory to store repository backup files. The directory must be accessible by the node.
-ErrorLogLevel
-el
Optional. Severity level for log events in the domain log. Default is info.
-ResourceFile
-rf
Required. File that contains the list of available resources for the node. Use the file nodeoptions.xml, located in the following directory:
<INFA_HOME>\isp\bin
.
-Tablespace
-ts
Required for an IBM DB2 database. Name of the tablespace where the domain configuration database tables reside.
-SchemaName
-sc
Optional. Name of the Microsoft SQL Server schema. Enter a schema name if you are not using the default schema.
-DatabaseTlsEnabled
-dbtls
Optional. Indicates whether the Informatica domain database is secure with TLS or SSL. Set this option to True for the secure database. Default is false. If you specify the -dbtls option without a value, the Informatica domain uses secure communication to the Informatica domain database.
-DatabaseTruststorePassword
-dbtp
Optional. Password for the database truststore file for the secure database.
-TrustedConnection
-tc
Optional. Connect to the Microsoft SQL Server database through a trusted connection. Trusted authentication uses the Windows security credentials of the current user to connect to Microsoft SQL Server.
-DatabaseTruststoreLocation
-dbtl
Path and file name of the truststore file for the secure domain repository database. Required if you configure a secure domain repository database for the domain.
* Note: If you currently run scripts that use this command to enable a custom keystore for SAML authentication, you must update them to include this option.
0 COMMENTS
We’d like to hear from you!