In 1040 CommandReference en
In 1040 CommandReference en
10.4.0
Command Reference
Informatica Command Reference
10.4.0
December 2019
© Copyright Informatica LLC 1998, 2020
This software and documentation are provided only under a separate license agreement containing restrictions on use and disclosure. No part of this document may be
reproduced or transmitted in any form, by any means (electronic, photocopying, recording or otherwise) without prior consent of Informatica LLC.
Informatica, the Informatica logo, PowerCenter, PowerExchange, Big Data Management and Enterprise Data Catalog are trademarks or registered trademarks of
Informatica LLC in the United States and many jurisdictions throughout the world. A current list of Informatica trademarks is available on the web at https://
www.informatica.com/trademarks.html. Other company and product names may be trade names or trademarks of their respective owners.
U.S. GOVERNMENT RIGHTS Programs, software, databases, and related documentation and technical data delivered to U.S. Government customers are "commercial
computer software" or "commercial technical data" pursuant to the applicable Federal Acquisition Regulation and agency-specific supplemental regulations. As such,
the use, duplication, disclosure, modification, and adaptation is subject to the restrictions and license terms set forth in the applicable Government contract, and, to the
extent applicable by the terms of the Government contract, the additional rights set forth in FAR 52.227-19, Commercial Computer Software License.
Portions of this software and/or documentation are subject to copyright held by third parties. Required third party notices are included with the product.
The information in this documentation is subject to change without notice. If you find any problems in this documentation, report them to us at
[email protected].
Informatica products are warranted according to the terms and conditions of the agreements under which they are provided. INFORMATICA PROVIDES THE
INFORMATION IN THIS DOCUMENT "AS IS" WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING WITHOUT ANY WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND ANY WARRANTY OR CONDITION OF NON-INFRINGEMENT.
Table of Contents 3
Configuring INFA_CLIENT_RESILIENCE_TIMEOUT on UNIX. . . . . . . . . . . . . . . . . . . . . . . . 44
Configuring INFA_CLIENT_RESILIENCE_TIMEOUT on Windows. . . . . . . . . . . . . . . . . . . . . 44
INFA_CODEPAGENAME. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
Configuring INFA_CODEPAGENAME on UNIX. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
Configuring INFA_CODEPAGENAME on Windows. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
INFA_DEFAULT_DATABASE_PASSWORD. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
Configuring INFA_DEFAULT_DATABASE_PASSWORD on UNIX. . . . . . . . . . . . . . . . . . . . . . 46
Configuring INFA_DEFAULT_DATABASE_PASSWORD on Windows. . . . . . . . . . . . . . . . . . . 46
INFA_DEFAULT_DB_TRUSTSTORE_PASSWORD. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
Configuring INFA_DEFAULT_DB_TRUSTSTORE_PASSWORD on UNIX. . . . . . . . . . . . . . . . . . 47
Configuring INFA_DEFAULT_DB_TRUSTSTORE_PASSWORD on Windows. . . . . . . . . . . . . . . 47
INFA_DEFAULT_DOMAIN. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
Configuring INFA_DEFAULT_DOMAIN on UNIX. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
Configuring INFA_DEFAULT_DOMAIN on Windows. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
INFA_DEFAULT_DOMAIN_PASSWORD. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
Configuring INFA_DEFAULT_DOMAIN_PASSWORD on UNIX. . . . . . . . . . . . . . . . . . . . . . . . 48
Configuring INFA_DEFAULT_DOMAIN_PASSWORD on Windows. . . . . . . . . . . . . . . . . . . . . 48
INFA_DEFAULT_DOMAIN_USER. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
Configuring INFA_DEFAULT_DOMAIN_USER on UNIX. . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
Configuring INFA_DEFAULT_DOMAIN_USER on Windows. . . . . . . . . . . . . . . . . . . . . . . . . 49
INFA_DEFAULT_PWX_OSEPASSWORD. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
Configuring INFA_DEFAULT_PWX_OSEPASSWORD on UNIX. . . . . . . . . . . . . . . . . . . . . . . 50
Configuring INFA_DEFAULT_PWX_OSEPASSWORD on Windows. . . . . . . . . . . . . . . . . . . . . 50
INFA_DEFAULT_PWX_OSPASSWORD. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
Configuring INFA_DEFAULT_PWX_OSPASSWORD on UNIX. . . . . . . . . . . . . . . . . . . . . . . . 50
Configuring INFA_DEFAULT_PWX_OSPASSWORD on Windows. . . . . . . . . . . . . . . . . . . . . . 50
INFA_DEFAULT_SECURITY_DOMAIN. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
Configuring INFA_DEFAULT_SECURITY_DOMAIN on UNIX. . . . . . . . . . . . . . . . . . . . . . . . . 51
Configuring INFA_DEFAULT_SECURITY_DOMAIN on Windows. . . . . . . . . . . . . . . . . . . . . . 51
INFA_JAVA_CMD_OPTS. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
Configuring INFA_JAVA_CMD_OPTS on UNIX. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
Configuring INFA_JAVA_CMD_OPTS on Windows. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
INFA_PASSWORD. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
Configuring INFA_PASSWORD on UNIX. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
Configuring INFA_PASSWORD on Windows. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
INFA_NODE_KEYSTORE_PASSWORD. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
Configuring INFA_NODE_KEYSTORE_PASSWORD on UNIX. . . . . . . . . . . . . . . . . . . . . . . . 53
Configuring INFA_NODE_KEYSTORE_PASSWORD on Windows. . . . . . . . . . . . . . . . . . . . . . 53
INFA_NODE_TRUSTSTORE_PASSWORD. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
Configuring INFA_NODE_TRUSTSTORE_PASSWORD on UNIX. . . . . . . . . . . . . . . . . . . . . . . 54
Configuring INFA_NODE_TRUSTSTORE_PASSWORD on Windows. . . . . . . . . . . . . . . . . . . . 54
INFA_REPCNX_INFO. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
4 Table of Contents
Configuring INFA_REPCNX_INFO on UNIX. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
Configuring INFA_REPCNX_INFO on Windows. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
INFA_REPOSITORY_PASSWORD. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
Configuring INFA_REPOSITORY_PASSWORD on UNIX. . . . . . . . . . . . . . . . . . . . . . . . . . . 55
Configuring INFA_REPOSITORY_PASSWORD on Windows. . . . . . . . . . . . . . . . . . . . . . . . . 56
INFATOOL_DATEFORMAT. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
Configuring INFATOOL_DATEFORMAT on UNIX. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
Configuring INFATOOL_DATEFORMAT on Windows. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
Encrypting Passwords. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57
Using a Password as an Environment Variable. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57
Setting the User Name. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58
Configuring a User Name as an Environment Variable on UNIX. . . . . . . . . . . . . . . . . . . . . . 58
Configuring a User Name as an Environment Variable on Windows. . . . . . . . . . . . . . . . . . . 58
Table of Contents 5
importGlossary. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96
6 Table of Contents
DeleteParameterSetEntries. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164
deployObjectsToFile. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166
DeployApplication. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170
disableMappingValidationEnvironment. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171
enableMappingValidationEnvironment. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174
ListApplicationObjectPermissions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 176
ListApplicationObjects. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178
ListApplicationOptions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 180
ListApplicationPermissions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 181
ListApplications. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183
ListComputeOptions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 184
ListDataObjectOptions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 186
ListMappingEngines. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 187
ListParameterSetEntries. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 190
ListParameterSetObjects. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191
ListParameterSets. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 193
listPatchNames. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 194
ListSequenceObjectProperties. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 196
ListSequenceObjects. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 198
ListServiceOptions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 199
ListServiceProcessOptions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 201
PurgeDataObjectCache. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 202
PurgeResultSetCache. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 204
queryRunTimeObjects. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 206
queryDesignTimeObjects. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 207
RefreshDataObjectCache. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 209
RenameApplication. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 210
replaceMappingHadoopRuntimeConnections. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 212
RestoreApplication. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 214
SetApplicationPermissions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 216
SetApplicationObjectPermissions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 218
setMappingExecutionEnvironment. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 220
SetSequenceState. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 222
StartApplication. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 224
StopApplication. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 226
stopBlazeService. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 227
tag. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 230
untag. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 232
replaceAllTag. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 234
UndeployApplication. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 237
UpdateApplication. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 238
UpdateApplicationOptions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 239
Table of Contents 7
UpdateComputeOptions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 241
UpdateDataObjectOptions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 243
Data Object Options. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 245
UpdateParameterSetEntries. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 245
UpdateServiceOptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 247
Data Integration Service Options. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 249
UpdateServiceProcessOptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 259
Data Integration Service Process Options. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 261
Queries. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 262
Comparison Operators. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 263
Logical Operators. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 265
Rules and Guidelines. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 265
Query Structure. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 266
Query Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 266
Where Clause. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 267
8 Table of Contents
UpdateServiceProcessOptions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 312
UpgradeClusterService. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 314
Table of Contents 9
DB2 for i5/OS Connection Options. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 385
DB2 for z/OS Connection Options. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 388
Facebook Connection Options. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 390
Greenplum Connection Options. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 390
Google Analytics Connection Options. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 391
Google BigQuery Connection Options. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 392
Google Cloud Spanner Connection Options. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 393
Google Cloud Storage Connection Options. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 394
Hadoop Connection Options. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 394
HBase Connection Options. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 399
HDFS Connection Options. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 400
Hive Connection Options. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 400
IBM DB2 Connection Options. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 404
IMS Connection Options. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 406
JDBC Connection Options. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 408
JDBC V2 Connection Options. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 410
JD Edwards EnterpriseOne Connection Options. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 412
Kafka Connection Options. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 413
LDAP Connection Options. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 413
LinkedIn Connection Options. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 414
MapR-DB Connection Options. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 414
Microsoft Azure Blob Storage Connection Options. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 415
Microsoft Azure Data Lake Storage Gen1 Connection Options. . . . . . . . . . . . . . . . . . . . . 416
Microsoft Azure Data Lake Storage Gen2 Connection Options. . . . . . . . . . . . . . . . . . . . . 416
Microsoft Azure SQL Data Warehouse Connection Options. . . . . . . . . . . . . . . . . . . . . . . 417
Microsoft SQL Server Connection Options. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 417
Microsoft Dynamics CRM Connection Options. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 420
Netezza Connection Options. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 422
OData Connection Options. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 423
ODBC Connection Options. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 423
Oracle Connection Options. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 425
Salesforce Connection Options. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 427
Salesforce Marketing Cloud Connection Options. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 428
SAPAPPLICATIONS Connection Options. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 430
Sequential Connection Options. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 430
Snowflake Connection Options. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 432
Tableau Connection Options. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 433
Tableau V3 Connection Options. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 433
Teradata Parallel Transporter Connection Options. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 434
Twitter Connection Options. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 436
Twitter Streaming Connection Options. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 437
VSAM Connection Options. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 437
10 Table of Contents
Web Content-Kapow Katalyst Connection Options. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 439
CreateFolder. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 440
CreateGrid. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 441
CreateGroup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 443
CreateIntegrationService. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 444
Integration Service Options. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 448
Integration Service Process Options. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 452
CreateMMService. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 454
Metadata Manager Service Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 455
CreateOSProfile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 457
Data Integration Service Process Options for Operating System Profiles. . . . . . . . . . . . . . . 460
PowerCenter Integration Service Process Options for Operating System Profiles. . . . . . . . . 461
CreateRepositoryService. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 462
CreateRole. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 467
CreateSAPBWService. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 468
SAP BW Service Options. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 471
SAP BW Service Process Option. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 471
CreateUser . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 472
CreateWSHubService. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 474
Web Services Hub Options. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 477
DeleteNamespace. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 478
DisableNodeResource. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 479
DisableService. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 481
DisableServiceProcess. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 483
DisableUser. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 484
EditUser. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 486
EnableNodeResource. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 488
EnableService. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 490
EnableServiceProcess. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 492
EnableUser . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 493
ExportDomainObjects. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 495
ExportUsersAndGroups. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 497
GetFolderInfo. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 499
GetLastError. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 501
GetLog. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 503
GetNodeName. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 506
GetPasswordComplexityConfig. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 507
getDomainSamlConfig. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 508
GetServiceOption. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 509
GetServiceProcessOption. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 511
GetServiceProcessStatus. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 513
GetServiceStatus. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 514
Table of Contents 11
GetSessionLog. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 516
GetSystemLogDirectory. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 519
getUserActivityLog. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 519
GetWorkflowLog. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 522
Help. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 525
ImportDomainObjects. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 525
ImportUsersAndGroups. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 529
ListAlertUsers. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 531
listAllCustomLDAPTypes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 533
ListAllGroups. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 534
listAllLDAPConnectivity. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 535
ListAllRoles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 537
ListAllUsers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 538
ListConnectionOptions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 539
ListConnectionPermissions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 541
ListConnectionPermissionsByGroup. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 542
ListConnectionPermissionsByUser. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 544
ListConnections. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 545
ListConnectionOptions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 547
listCustomLDAPType. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 549
ListDefaultOSProfiles. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 550
ListDomainCiphers. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 552
ListDomainLinks. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 554
ListDomainOptions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 555
ListFolders. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 557
ListGridNodes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 558
ListGroupPermissions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 560
ListGroupPrivileges. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 562
ListGroupsForUser. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 563
ListLDAPConnectivity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 565
ListLicenses. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 567
ListMonitoringOptions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 568
ListNodeOptions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 569
ListNodeResources. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 571
ListNodeRoles. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 572
ListNodes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 574
ListOSProfiles. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 575
ListRepositoryLDAPConfiguration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 576
ListRolePrivileges. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 578
ListSecurityDomains. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 579
ListServiceLevels. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 581
ListServiceNodes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 582
12 Table of Contents
ListServicePrivileges . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 583
ListServices. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 585
ListSMTPOptions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 587
ListUserPermissions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 589
ListUserPrivileges . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 591
infacmd ListWeakPasswordUsers. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 592
migrateUsers. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 593
MoveFolder. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 595
MoveObject. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 597
Ping. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 598
PingDomain. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 599
PrintSPNAndKeytabNames. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 601
PurgeLog. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 603
PurgeMonitoringData. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 604
RemoveAlertUser. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 606
RemoveConnection. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 608
RemoveConnectionPermissions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 609
removeCustomLDAPType. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 611
RemoveDomainLink. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 612
RemoveFolder. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 614
RemoveGrid. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 615
RemoveGroup. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 616
RemoveGroupPermission . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 618
RemoveGroupPrivilege. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 620
removeLDAPConnectivity. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 622
RemoveLicense. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 623
RemoveNode. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 625
RemoveNodeResource. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 626
RemoveOSProfile. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 628
RemoveRole . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 629
RemoveRolePrivilege . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 631
RemoveService. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 633
RemoveServiceLevel. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 634
RemoveUser. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 636
RemoveUserFromGroup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 637
RemoveUserPermission . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 639
RemoveUserPrivilege . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 641
RenameConnection. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 643
ResetPassword. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 645
RunCPUProfile. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 647
SetConnectionPermissions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 648
SetRepositoryLDAPConfiguration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 650
Table of Contents 13
ShowLicense. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 653
ShutdownNode. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 654
SwitchToGatewayNode. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 655
SwitchToWorkerNode. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 658
SyncSecurityDomains. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 659
UnassignDefaultOSProfile. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 661
UnassignISMMService. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 663
UnassignLicense. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 664
UnassignRoleFromGroup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 666
UnassignRoleFromUser. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 668
UnassignRSWSHubService. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 669
UnassociateDomainNode. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 671
UpdateConnection. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 673
updateCustomLDAPType. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 676
UpdateDomainOptions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 679
UpdateFolder. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 680
UpdateGatewayInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 682
UpdateGrid. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 683
UpdateIntegrationService. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 684
updateLDAPConnectivity. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 687
UpdateLicense. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 690
UpdateMMService. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 691
UpdateMonitoringOptions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 693
UpdateNamespace. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 695
UpdateNodeOptions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 698
UpdateNodeRole. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 700
UpdateOSProfile. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 702
UpdateRepositoryService. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 704
UpdateSAPBWService. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 708
UpdateServiceLevel. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 710
UpdateServiceProcess. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 712
UpdateSMTPOptions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 714
UpdateWSHubService. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 715
validateFeature. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 717
Version. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 718
14 Table of Contents
restoreContents. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 735
removesnapshot. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 737
UpdateServiceOptions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 739
UpdateServiceProcessOptions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 741
upgrade. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 742
Table of Contents 15
listMappingEngines. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 800
listPermissionOnProject. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 802
ListProjects. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 804
ListServiceOptions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 805
ListServiceProcessOptions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 807
ManageGroupPermissionOnProject. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 808
ManageUserPermissionOnProject. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 810
PopulateVCS. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 812
ReassignCheckedOutObject. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 814
rebuildDependencyGraph. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 815
RenameFolder. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 817
replaceMappingHadoopRuntimeConnections. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 818
RestoreContents. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 820
UndoCheckout. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 822
setMappingExecutionEnvironment. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 823
UndoCheckout. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 825
UnlockObject . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 826
UpdateServiceOptions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 828
Model Repository Service Options. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 829
UpdateServiceProcessOptions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 833
UpdateStatistics. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 835
UpgradeContents. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 837
UpgradeExportedObjects. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 838
16 Table of Contents
Chapter 27: infacmd ps Command Reference. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 874
cancelProfileExecution. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 874
CreateWH. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 876
detectOrphanResults. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 877
DropWH. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 879
Execute. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 880
executeProfile. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 882
getExecutionStatus. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 884
getProfileExecutionStatus. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 886
List. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 887
ListAllProfiles. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 889
migrateProfileResults. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 890
migrateScorecards. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 892
Purge. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 893
purgeOrphanResults. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 896
restoreProfilesAndScorecards. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 898
synchronizeProfile. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 899
Table of Contents 17
listReverseProxyServerOptions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 958
listServiceProcessOptions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 960
updateReverseProxyServerOptions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 961
updateServiceProcessOptions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 963
updateServiceOptions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 965
18 Table of Contents
Chapter 34: infacmd sql Command Reference. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1023
ExecuteSQL. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1023
ListColumnOptions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1024
ListColumnPermissions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1026
ListSQLDataServiceOptions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1027
ListSQLDataServicePermissions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1029
ListSQLDataServices. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1030
ListStoredProcedurePermissions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1032
ListTableOptions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1033
ListTablePermissions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1035
PurgeTableCache. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1037
RefreshTableCache . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1038
RenameSQLDataService. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1040
SetColumnPermissions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1041
SetSQLDataServicePermissions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1043
SetStoredProcedurePermissions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1045
SetTablePermissions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1048
StartSQLDataService. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1050
StopSQLDataService. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1052
UpdateColumnOptions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1053
Column Options. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1055
UpdateSQLDataServiceOptions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1056
SQL Data Service Options. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1057
UpdateTableOptions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1059
Virtual Table Options. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1061
Table of Contents 19
cancelWorkflow. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1088
completeTask. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1090
createTables. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1092
delegateTask. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1094
dropTables. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1096
listActiveWorkflowInstances. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1097
listMappingPersistedOutputs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1099
listTasks. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1100
listWorkflowParams. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1104
listWorkflowParams Output. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1105
listWorkflows. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1106
pruneOldInstances. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1107
recoverWorkflow. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1109
releaseTask. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1111
setMappingPersistedOutputs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1113
startTask. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1115
startWorkflow. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1116
upgradeWorkflowParameterFile. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1118
20 Table of Contents
Export Control Files. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1148
Export Control File Parameters for Domain Objects. . . . . . . . . . . . . . . . . . . . . . . . . . . 1149
Export Control File Parameters for Model Repository Objects. . . . . . . . . . . . . . . . . . . . . 1150
Import Control Files. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1153
Import Control File Parameters for Domain Objects. . . . . . . . . . . . . . . . . . . . . . . . . . . 1153
Import Control File Parameters for Model Repository Objects. . . . . . . . . . . . . . . . . . . . . 1155
Rules and Guidelines for Control Files. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1160
Control File Examples for Domain Objects. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1160
Control File Examples for Model Repository Objects. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1161
Table of Contents 21
Running Commands in Interactive Mode. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1222
Running in Wait Mode. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1223
Scripting pmcmd Commands. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1223
Entering Command Options. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1224
aborttask. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1224
abortworkflow. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1226
Connect. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1228
Disconnect. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1229
Exit. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1230
getrunningsessionsdetails. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1230
GetServiceDetails. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1231
getserviceproperties. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1233
getsessionstatistics. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1234
gettaskdetails. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1236
getworkflowdetails. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1238
help. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1241
pingservice. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1242
recoverworkflow. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1242
scheduleworkflow. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1244
SetFolder. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1246
SetNoWait. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1246
SetWait. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1246
ShowSettings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1247
StartTask. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1247
Using Parameter Files with starttask. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1249
StartWorkflow. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1250
Using Parameter Files with startworkflow. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1252
StopTask. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1253
StopWorkflow. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1255
UnscheduleWorkflow. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1257
UnsetFolder. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1258
Version. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1259
WaitTask. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1259
WaitWorkflow. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1261
22 Table of Contents
Connection Subtypes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1267
AddToDeploymentGroup. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1270
ApplyLabel. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1271
AssignIntegrationService. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1273
AssignPermission. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1274
Example. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1275
BackUp. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1276
ChangeOwner. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1276
CheckIn. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1277
CleanUp. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1278
ClearDeploymentGroup. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1278
Connect. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1279
Create. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1280
CreateConnection. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1281
Specifying the Database Code Page. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1284
CreateDeploymentGroup. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1284
CreateFolder. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1285
Assigning Permissions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1286
CreateLabel. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1287
CreateQuery. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1287
Delete. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1293
DeleteConnection. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1294
DeleteDeploymentGroup. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1295
DeleteFolder. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1295
DeleteLabel. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1295
DeleteObject . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1296
DeleteQuery. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1297
DeployDeploymentGroup. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1297
DeployFolder. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1299
ExecuteQuery. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1300
Exit. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1302
FindCheckout. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1302
GetConnectionDetails. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1303
GenerateAbapProgramToFile. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1304
Help. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1306
InstallAbapProgram. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1306
KillUserConnection. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1308
ListConnections. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1309
ListObjectDependencies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1309
ListObjects. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1312
Listing Object Types. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1314
Listing Folders. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1316
Table of Contents 23
Listing Objects. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1316
ListTablesBySess. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1317
ListUserConnections. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1318
MassUpdate. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1318
Session Property Types. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1321
Rules and Guidelines for MassUpdate. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1324
Sample Log File. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1324
ModifyFolder. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1324
Notify. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1326
ObjectExport. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1326
Examples. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1328
ObjectImport . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1328
PurgeVersion. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1329
Examples. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1331
Register. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1331
RegisterPlugin. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1333
Registering a Security Module . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1334
Example. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1334
Restore. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1335
Example. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1336
RollbackDeployment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1336
Example. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1337
Run. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1337
ShowConnectionInfo. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1338
SwitchConnection. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1338
TruncateLog. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1339
UndoCheckout. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1340
Unregister. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1341
UnregisterPlugin. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1342
Unregistering an External Security Module. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1343
Example. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1343
UpdateConnection. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1344
UpdateEmailAddr. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1346
UpdateSeqGenVals. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1347
UpdateSrcPrefix. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1348
UpdateStatistics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1349
UpdateTargPrefix. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1349
Upgrade. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1350
UninstallAbapProgram. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1351
Validate. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1352
Version. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1355
24 Table of Contents
Chapter 44: Working with pmrep Files. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1356
Working with pmrep Files Overview. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1356
Using the Persistent Input File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1356
Creating a Persistent Input File with pmrep. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1357
Creating a Persistent Input File Manually. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1357
Using the Object Import Control File. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1358
Object Import Control File Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1360
Object Import Control File Examples. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1363
Importing Source Objects. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1363
Importing Multiple Objects into a Folder. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1364
Checking In and Labeling Imported Objects. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1364
Retaining Sequence Generator and Normalizer Values. . . . . . . . . . . . . . . . . . . . . . . . . 1364
Importing Objects and Local Shortcut Objects to the Same Repository. . . . . . . . . . . . . . . 1365
Importing Shortcut Objects from Another Repository. . . . . . . . . . . . . . . . . . . . . . . . . . 1365
Importing Objects to Multiple Folders. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1366
Importing Specific Objects. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1366
Reusing and Replacing Dependent Objects. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1366
Replacing Invalid Mappings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1367
Renaming Objects. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1367
Copying SAP Mappings and SAP Program Information. . . . . . . . . . . . . . . . . . . . . . . . . 1368
Applying Default Connection Attributes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1368
Resolving Object Conflicts. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1368
Using the Deployment Control File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1369
Deployment Control File Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1371
Deployment Control File Examples. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1375
Deploying the Latest Version of a Folder. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1375
Deploying the Latest Version of a Deployment Group. . . . . . . . . . . . . . . . . . . . . . . . . . 1375
Listing Multiple Source and Target Folders . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1376
Tips for Working with pmrep Files. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1377
Index. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1378
Table of Contents 25
Preface
Refer to the Informatica® Command Reference for information about the command line programs and
utilities, such as infacmd, infasetup, pmcmd, pmpasswd, and pmrep to manage the Informatica domain,
application services, and objects. Learn command descriptions, options, and arguments. You can perform
much of the command line functionality through the Administrator tool and other client tools.
Informatica Resources
Informatica provides you with a range of product resources through the Informatica Network and other online
portals. Use the resources to get the most from your Informatica products and solutions and to learn from
other Informatica users and subject matter experts.
Informatica Network
The Informatica Network is the gateway to many resources, including the Informatica Knowledge Base and
Informatica Global Customer Support. To enter the Informatica Network, visit
https://network.informatica.com.
To search the Knowledge Base, visit https://search.informatica.com. If you have questions, comments, or
ideas about the Knowledge Base, contact the Informatica Knowledge Base team at
[email protected].
Informatica Documentation
Use the Informatica Documentation Portal to explore an extensive library of documentation for current and
recent product releases. To explore the Documentation Portal, visit https://docs.informatica.com.
26
If you have questions, comments, or ideas about the product documentation, contact the Informatica
Documentation team at [email protected].
Informatica Velocity
Informatica Velocity is a collection of tips and best practices developed by Informatica Professional Services
and based on real-world experiences from hundreds of data management projects. Informatica Velocity
represents the collective knowledge of Informatica consultants who work with organizations around the
world to plan, develop, deploy, and maintain successful data management solutions.
You can find Informatica Velocity resources at http://velocity.informatica.com. If you have questions,
comments, or ideas about Informatica Velocity, contact Informatica Professional Services at
[email protected].
Informatica Marketplace
The Informatica Marketplace is a forum where you can find solutions that extend and enhance your
Informatica implementations. Leverage any of the hundreds of solutions from Informatica developers and
partners on the Marketplace to improve your productivity and speed up time to implementation on your
projects. You can find the Informatica Marketplace at https://marketplace.informatica.com.
To find your local Informatica Global Customer Support telephone number, visit the Informatica website at
the following link:
https://www.informatica.com/services-and-training/customer-success-services/contact-us.html.
To find online support resources on the Informatica Network, visit https://network.informatica.com and
select the eSupport option.
Preface 27
Chapter 1
When you install the Informatica services or the Informatica clients, the command line programs and utilities
are installed by default. You can also install and run the programs and utilities on other machines by
installing the Informatica utilities.
infacmd Administer the Informatica domain and application services and processes, including the
repository and integration services. You can also use infacmd to access and administer
licenses and log events and export and import objects and user accounts.
28
The following table describes the PowerCenter® utilities:
pmcmd Manage workflows. Use pmcmd to start, stop, schedule, and monitor workflows.
pmpasswd Encrypt passwords to use with pmcmd and pmrep environment variables.
pmrep Performs repository administration tasks. Use pmrep to list repository objects, create and
edit groups, and restore and delete repositories.
To install and configure the command line utilities on a machine that does not have the Informatica products
installed, complete the following tasks:
30
Installing the Command Line Utilities
Informatica provides a separate zip file to install the command line utilities on a machine that does not have
the Informatica products installed.
1. Contact Informatica Global Customer Support to get the command line utilities zip file.
2. Extract the files to the machine where you want to run the command line utilities.
3. On Windows, install the Microsoft Visual Studio 2013 redistributable package included in the extracted
files. Run the 32-bit or 64-bit file located in the following directory:
<Utilities installation directory>/PowerCenter/server/VS2013
Informatica products on Windows require the Microsoft Visual Studio 2013 redistributable package.
When you install the Informatica services or the Informatica clients, the installer installs the
redistributable package for you. When you install the standalone command line utilities, the
redistributable package is included in the extracted files, and you must manually install the package.
Installation Directories
The installation directories of the command line utilities vary based on whether the utilities are installed with
Informatica services installation, Informatica client installation, or standalone command line utilities
installation.
When you install the Developer tool, the Informatica utilities are installed in the following directory:
When you install the PowerCenter client, the PowerCenter utilities are installed in the following directory:
When you install the PowerCenter client, the Metadata Manager utilities are installed in the following
directory:
• To run pmrep, pmcmd, and pmpasswd, copy the domains.infa file for the Informatica domain to the
utilities directory.
• To run pmrep, pmcmd, and pmpasswd on UNIX, set the INFA_HOME, PATH, and library path environment
variables to the location of the utilities.
For example, if the command line utilities are installed in the /data/Informatica_cmd_utilities/ folder,
then the PowerCenter utilities are located in the /data/Informatica_cmd_utilities/PowerCenter/
server/bin folder. On Linux, you can set the environment variables at the command prompt as follows:
setenv INFA_HOME /data/Informatica_cmd_utilities/PowerCenter/
setenv PATH .:/data/Informatica_cmd_utilities/PowerCenter/server/bin:$PATH
setenv LD_LIBRARY_PATH .:/data/Informatica_cmd_utilities/PowerCenter/server/bin:
$LD_LIBRARY_PATH
Note: Restart the machine after you configure the INFA_HOME or library path environment variable.
If the domain uses Kerberos authentication, create the domains.infa file. Metadata Manager command line
programs use the domains.infa file to get gateway connectivity information for the domain.
JAVA_HOME
Specifies the location of the Java Virtual Machine. Set JAVA_HOME to the PowerCenter Java directory in
the command line utilities installation. For example:
INFA_HOME
Specifies the Informatica root directory so that any Informatica application or service can find the other
Informatica components that it needs to run. Set INFA_HOME to the PowerCenter directory in the
command line utilities installation. For example:
Set this environment variable on each machine where you installed the Informatica utilities.
If the domain uses Kerberos authentication, you must enter domain connectivity information when you run
the command line program commands. You enter domain connectivity information through the --
domainName option or the --gateway option. To use the --domainName option, the domains.infa file must
contain the domain gateway connectivity information. If the domains.infa file does not exist or the
information in the file is out of date, you must use the --gateway option when you run any command that
connects to the domain.
When you install Informatica services, the domains.infa file is available in the INFA_HOME directory. For any
other installation, create the file and verify that it is available on the machine from which you want to run the
commands.
To create the domains.infa file, run the infacmd isp UpdateGatewayInfo command. The command creates or
updates the domains.infa file in the PowerCenter directory in the command line utilities installation, for
example, <Utilities installation directory>\PowerCenter.
Configure the machines where you installed the Informatica utilities when the domain uses the following
security configurations:
If secure communication is enabled for the domain, you might need to configure the machines to use the
truststore file. If you use a custom truststore file, you must configure environment variables that specify
the truststore file directory and the truststore password.
Kerberos authentication
If the domain uses Kerberos authentication, you must copy the Kerberos configuration file to the
machines where you installed the Informatica utilities. You must also configure the machines to locate
the Kerberos configuration file for the domain.
Related Topics:
• “ Running Commands in a Secure Domain” on page 38
• “Running Commands on UNIX with Kerberos Authentication” on page 38
• “Running Commands on Windows with Kerberos Authentication” on page 40
For example, you can enable or disable a Repository Service from the Administrator tool or the infacmd
command line program.
35
• mmRepoCmd. Use mmRepoCmd to create, delete, back up, and restore Metadata Manager repository
contents. You can also restore a PowerCenter repository back-up file that contains Metadata Manager
objects to the PowerCenter repository database.
• mmXConPluginUtil. Use mmXConPluginUtil to generate the image mapping information or the plug-in for
a universal XConnect.
• rcfmu. Use rcfmu to migrate a resource configuration file from a previous version of Metadata Manager to
the current version.
• rmu. Use rmu to migrate resources from a previous version of Metadata Manager to the current version.
To run command line programs on UNIX, you may need to set the library path environment variable to the
location of the Informatica utilities.
For ease of use, you can configure environment variables that apply each time you run the command line
programs.
For example, you can set an environment variable for the default domain name, user, and password to avoid
typing the options at the command line.
Use the following rules when you enter command options and arguments:
• To enter options, type a hyphen followed by one letter, two letters, or a word, depending on the program
syntax for the command.
For example, the pmrep Connect command uses a single letter option for the repository name:
Connect -r <repository_name>
Syntax Notation
The following table describes the notation used in this book to show the syntax for all Informatica command
line programs:
Convention Description
-x Option placed before a argument. This designates the parameter you enter.
For example, to enter the user name for pmcmd, type -u or -user followed by the
user name.
<x> Required option. If you omit a required option, the command line program returns
an error message.
<x | y > Select between required options. For the command to run, you must select from the
listed options. If you omit a required option, the command line program returns an
error message.
In pmrep, curly brackets denote groupings of required options, as in the following
{x | y} example:
KillUserConnection
{-i <connection_id> |
-n <user_name> |
-a (kill all)}
If a pipe symbol (|) separates options, you must specify exactly one option. If
options are not separated by pipe symbols, you must specify all the options.
[x] Optional parameter. The command runs whether or not you enter optional
parameters. For example, the Help command has the following syntax:
Help [Command]
If you enter a command, the command line program returns information on that
command only. If you omit the command name, the command line program returns
a list of all commands.
Syntax Notation 37
Convention Description
< < x | y> | <a | b> > When a set contains subsets, the superset is indicated with bold brackets < > .
A bold pipe symbol ( | ) separates the subsets.
(text) In pmrep, parentheses surround descriptive text, such as the list of the possible
values for an argument or an explanation for an option that does not take an
argument.
Set the following environment variables before you run the commands:
INFA_TRUSTSTORE
Set the INFA_TRUSTSTORE environment variable with the directory that contains the truststore files for
the SSL certificates. The directory must contain truststore files named infa_truststore.jks and
infa_truststore.pem. You must set the INFA_TRUSTSTORE variable whether you use the default SSL
certificate from Informatica or you specify a SSL certificate.
INFA_TRUSTSTORE_PASSWORD
If you specify the SSL certificate to enable secure communication in the domain, set the
INFA_TRUSTSTORE_PASSWORD environment variable with the password for the infa_truststore.jks that
contains the SSL certificate. You do not need to set this variable if you use the default SSL certificate
from Informatica.
Note: The password must be encrypted. Use the command line program pmpasswd to encrypt the
password with encryption type CRYPT_SYSTEM. For more information, see “Encrypting Passwords” on
page 57.
You must set the environment variables before you run the infacmd, pmrep, mmcmd, mmRepoCmd, and
pmcmd commands on UNIX.
If you have a credentials cache file, you can run the commands without the user name and password options.
To run commands on UNIX with single sign-on, perform the following tasks:
Stores the default path and filename for the Kerberos credentials cache. When you run the kinit utility to
generate the user credential cache, kinit stores the credential cache in the default file that you set in the
KRB5CCNAME environment variable.
KRB5_CONFIG
Stores the path and file name of the Kerberos configuration file. The name of the Kerberos configuration
file is krb5.conf. For information about the contents of the krb5.conf file, see the Informatica Security
Guide.
The commands determine the user credentials based on how you specify the user name and password. The
commands check the credentials in the following order:
1. Command options. If you include the user name option (-un) and the password option (-pd) in the
command, the command uses the user name and password specified for the options.
If the domain uses a single Kerberos realm for authentication, specify the samAccountName for the user
as the value for the user name option. If the domain uses Kerberos cross realm authentication, specify
the user principal name for the user as the value for the user name option.
2. Environment variables. If you do not include the user name and password options in the command, the
command uses the user name and password specified in the environment variables
INFA_DEFAULT_DOMAIN_USER and INFA_DEFAULT_DOMAIN_PASSWORD.
Note: If you do not set the credentials in the command options or environment variables, the command
checks for a credential cache file. If a credential cache is available, the command runs with single sign-on.
If you do not use single sign-on on Windows, set the KRB5_CONFIG environment variable to the path and file
name of the Kerberos configuration file. The name of the configuration file is krb5.conf.
The commands determine the user credentials based on how you specify the user name and password. The
commands check the credentials in the following order:
1. Command options. If you include the user name option (-un) and the password option (-pd) in the
command, the command uses the user name and password specified for the options.
If the domain uses a single Kerberos realm for authentication, specify the samAccountName for the user
as the value for the user name option. If the domain uses Kerberos cross realm authentication, specify
the user principal name for the user as the value for the user name option.
2. Environment variables. If you do not include the user name and password options in the command, the
command uses the user name and password specified in the environment variables
INFA_DEFAULT_DOMAIN_USER and INFA_DEFAULT_DOMAIN_PASSWORD.
Note: If you do not set the credentials in the command options or environment variables, the command uses
the logged-in credentials and runs the command with single sign-on.
41
Environment Variables for Command Line Programs
Overview
You can configure optional environment variables for the command line programs. For example, you can set
environment variables to encrypt passwords, configure time and date display options, or store the default
login information for a domain.
If you are run pmcmd or pmrep in interactive mode, you must exit the command line program and then
reconnect to use changed environment variables.
On Windows, you can configure these environment variables as either user or system variables. For
information about setting environment variables on Windows, see the Windows documentation.
Note: The environment variables that you configure apply to command line programs that run on the node. To
apply changes, restart the node.
The following table describes environment variables you can configure to use with the command line
programs:
INFA_DEFAULT_DATABASE_PASSWORD infasetup Stores the default user name password for the
domain configuration database.
INFA_DEFAULT_DOMAIN_PASSWORD infacmd Stores the default user name password for the
domain.
INFA_DEFAULT_DOMAIN_USER infacmd Stores the default user name for the domain.
INFA_DEFAULT_PWX_OSPASSWORD infacmd pwx Stores a plain text password for the operating
system.
INFATOOL_DATEFORMAT pmcmd Configures the way pmcmd displays the date and
time.
Related Topics:
• “Encrypting Passwords” on page 57
• “Setting the User Name” on page 58
ICMD_JAVA_OPTS
ICMD_JAVA_OPTS environment variable applies to the infacmd command line program.
You can configure the environment variable ICMD_JAVA_OPTS to set the Java options such as -Xmx values
and system properties. To set a system property, pass the value in the following format:
-Dproperty.name=property.value
For example, you might want to increase the system memory used by infacmd. The default system memory
for infacmd is 512 MB. To configure 1024 MB of system memory in a UNIX C shell environment, type:
setenv ICMD_JAVA_OPTS "-Xmx1024m"
ICMD_JAVA_OPTS 43
Configuring ICMD_JAVA_OPTS on UNIX
To configure ICMD_JAVA_OPTS on UNIX:
u Enter the environment variable ICMD_JAVA_OPTS, and set the Java options such as the -Xmx values and
system properties.
For information about setting environment variables on Windows, consult the Windows documentation.
INFA_CLIENT_RESILIENCE_TIMEOUT
INFA_CLIENT_RESILIENCE_TIMEOUT environment variable applies to the infacmd, pmcmd, and pmrep
command line programs.
You can set the environment variable INFA_CLIENT_RESILIENCE_TIMEOUT to limit the number of seconds
the command line programs spend establishing connections to the domain or service. The default time is
180 seconds if you do not set this environment variable.
u Enter the environment variable INFA_CLIENT_RESILIENCE_TIMEOUT, and set the value to the number of
seconds you want the command line programs to spend establishing a connection to the domain or
service.
For information about setting environment variables on Windows, consult the Windows documentation.
pmcmd and pmrep send commands in Unicode and use the code page of the host machine unless you set the
code page environment variable, INFA_CODEPAGENAME, to override it. If you set INFA_CODEPAGENAME for
pmcmd, the code page must be compatible with the Integration Service code page. If you set
INFA_CODEPAGENAME for pmrep, the code page name must be compatible with the repository code page. If
you set INFA_CODEPAGENAME on the machine where you run pmcmd and pmrep, the code page must be
compatible with the Integration Service and the repository code pages.
If the code pages are not compatible, the command might fail.
u Enter the environment variable INFA_CODEPAGENAME, and set the value to the code page name.
For information about setting environment variables on Windows, consult the Windows documentation.
INFA_DEFAULT_DATABASE_PASSWORD
INFA_DEFAULT_DATABASE_PASSWORD environment variable applies to the infasetup command line
program.
Some infasetup commands require a domain configuration database password. You can provide this
password as an option with infasetup, or you can store it as the environment variable
INFA_DEFAULT_DATABASE_PASSWORD.
Use the following steps as a guideline to use an encrypted password as an environment variable:
1. Use the command line program pmpasswd to encrypt the database user password.
pmpasswd generates and displays the encrypted password. For example, if you enter the password
“monday,” it encrypts to f/wRb5PZsZnqESTDPeos7Q==.
2. Configure the password environment variable to set the encrypted value.
INFA_CODEPAGENAME 45
Related Topics:
• “Encrypting Passwords” on page 57
INFA_DEFAULT_DB_TRUSTSTORE_PASSWORD
INFA_DEFAULT_DB_TRUSTSTORE_PASSWORD environment variable applies to the infasetup command line
program.
Some infasetup commands configure secure communication for the domain. You can provide the password
for the database truststore file for the secure database as an option with infasetup, or you can store it as the
environment variable INFA_DEFAULT_DB_TRUSTSTORE_DATABASE_PASSWORD.
Use the following steps as a guideline to use an encrypted password as an environment variable:
1. Use the command line program pmpasswd to encrypt the database user password.
pmpasswd generates and displays the encrypted password. For example, if you enter the password
“monday,” it encrypts to f/wRb5PZsZnqESTDPeos7Q==.
2. Configure the password environment variable to set the encrypted value.
Configuring INFA_DEFAULT_DB_TRUSTSTORE_PASSWORD on
Windows
To configure INFA_DEFAULT_DB_TRUSTSTORE_PASSWORD on Windows:
INFA_DEFAULT_DOMAIN
INFA_DEFAULT_DOMAIN environment variable applies to the infacmd, pmcmd, and pmrep command line
programs.
The command line programs require a domain name. You can provide the domain name as an option with the
command line programs, or you can store it as the environment variable INFA_DEFAULT_DOMAIN. If you have
more than one domain, choose a default domain.
INFA_DEFAULT_DOMAIN 47
Configuring INFA_DEFAULT_DOMAIN on Windows
To configure INFA_DEFAULT_DOMAIN on Windows:
u Enter the environment variable INFA_DEFAULT_DOMAIN, and set the value to the domain name.
For information about setting environment variables on Windows, consult the Windows documentation.
INFA_DEFAULT_DOMAIN_PASSWORD
INFA_DEFAULT_DOMAIN_PASSWORD environment variable applies to the infacmd command line program.
Most infacmd commands require a user password. You can provide a user password as an option with
infacmd, or you can store it as the environment variable INFA_DEFAULT_DOMAIN_PASSWORD.
Use the following steps as a guideline to use an encrypted password as an environment variable:
1. Use the command line program pmpasswd to encrypt the user password.
pmpasswd generates and displays the encrypted password. For example, if you enter the password
“monday,” it encrypts to f/wRb5PZsZnqESTDPeos7Q==.
2. Configure the password environment variable to set the encrypted value.
Related Topics:
• “Encrypting Passwords” on page 57
Most infacmd commands require a user name. You can provide a user name as an option with infacmd, or
you can store it as the environment variable INFA_DEFAULT_DOMAIN_USER.
u Enter the environment variable INFA_DEFAULT_DOMAIN_USER, and set the value to the default user
name.
For information about setting environment variables on Windows, consult the Windows documentation.
INFA_DEFAULT_PWX_OSEPASSWORD
INFA_DEFAULT_PWX_OSEPASSWORD environment variable applies to the infacmd pwx command line
program.
Some infacmd pwx commands require an operating system password. You can provide an encrypted
password as an option with infacmd pwx, or you can store it as the environment variable
INFA_DEFAULT_PWX_OSEPASSWORD.
Use the following steps as a guideline to use an encrypted password as an environment variable:
INFA_DEFAULT_DOMAIN_USER 49
Related Topics:
• “Encrypting Passwords” on page 57
INFA_DEFAULT_PWX_OSPASSWORD
INFA_DEFAULT_PWX_OSPASSWORD environment variable applies to the infacmd pwx command line
program.
Some infacmd pwx commands require an operating system password. You can provide a plain text password
as an option with infacmd pwx, or you can store it as the environment variable
INFA_DEFAULT_PWX_OSPASSWORD.
INFA_DEFAULT_SECURITY_DOMAIN
INFA_DEFAULT_SECURITY_DOMAIN environment variable applies to the infacmd command line program.
The infacmd commands require a security domain if you use LDAP authentication and you specify an
Informatica user. You can set the environment variable INFA_DEFAULT_SECURITY_DOMAIN to the native
security domain or to an LDAP security domain name.
u Enter the environment variable INFA_DEFAULT_SECURITY_DOMAIN and set the value to the name of the
security domain.
For information about setting environment variables on Windows, consult the Windows documentation.
INFA_JAVA_CMD_OPTS
INFA_JAVA_CMD_OPTS environment variable applies to the infasetup command line program.
You can configure the environment variable INFA_JAVA_CMD_OPTS to set the Java options such as -Xmx
values and system properties. To set a system property, pass the value in the following format:
-Dproperty.name=property.value
For example, you might want to increase the system memory used by infasetup. The default system memory
for infasetup is 512 MB. To configure 1024 MB of system memory in a UNIX C shell environment, type:
setenv INFA_JAVA_CMD_OPTS "-Xmx1024m"
INFA_DEFAULT_SECURITY_DOMAIN 51
In a UNIX Bourne shell environment, type:
INFA_JAVA_CMD_OPTS = <Java_Options>
export INFA_JAVA_CMD_OPTS
u Enter the environment variable INFA_JAVA_CMD_OPTS, and set the Java options such as the -Xmx
values and system properties.
For information about setting environment variables on Windows, consult the Windows documentation.
INFA_PASSWORD
INFA_PASSWORD environment variable applies to the infacmd and infasetup command line programs.
Some infacmd and infasetup commands require a user password. You can provide a user password as an
option with these commands, or you can store it as the environment variable INFA_PASSWORD.
You can use the INFA_PASSWORD environment variable to store different types of passwords. For example in
the infasetup DefineDomain command, you can use the variable to set the keystore password. In the infacmd
isp SetLDAPConnectivity command, you can use the variable to set the LDAP credential password. You may
need to change the value of this variable based on the commands that you run.
Use the following steps as a guideline to use an encrypted password as an environment variable:
1. Use the command line program pmpasswd to encrypt the user password.
pmpasswd generates and displays the encrypted password. For example, if you enter the password
“monday,” it encrypts to f/wRb5PZsZnqESTDPeos7Q==.
2. Configure the password environment variable to set the encrypted value.
Related Topics:
• “Encrypting Passwords” on page 57
INFA_NODE_KEYSTORE_PASSWORD
The INFA_NODE_KEYSTORE_PASSWORD environment variable applies to the infasetup command line
program.
Some infasetup commands configure secure communication for the domain. You can provide the password
for the informatica Java Keystore (JKS) file as an option with infasetup, or you can store it as the
environment variable INFA_NODE_KEYSTORE_PASSWORD.
Use the following steps as a guideline to use an encrypted password as an environment variable:
1. Use the command line program pmpasswd to encrypt the database user password.
pmpasswd generates and displays the encrypted password. For example, if you enter the password
“monday,” it encrypts to f/wRb5PZsZnqESTDPeos7Q==.
2. Configure the password environment variable to set the encrypted value.
INFA_NODE_KEYSTORE_PASSWORD 53
INFA_NODE_TRUSTSTORE_PASSWORD
The INFA_NODE_TRUSTSTORE_PASSWORD environment variable applies to the infasetup command line
program.
Some infasetup commands configure secure communication for the domain. You can provide the password
for the infa_truststore.jks file as an option with infasetup, or you can store it as the environment variable
INFA_NODE_TRUSTSTORE_PASSWORD.
Use the following steps as a guideline to use an encrypted password as an environment variable:
1. Use the command line program pmpasswd to encrypt the database user password.
pmpasswd generates and displays the encrypted password. For example, if you enter the password
“monday,” it encrypts to f/wRb5PZsZnqESTDPeos7Q==.
2. Configure the password environment variable to set the encrypted value.
INFA_REPCNX_INFO
The INFA_REPCNX_INFO environment variable applies to the pmrep command line program.
When you run pmrep in command line mode or from a script, it stores repository connection information in a
file, pmrep.cnx. pmrep uses the information in this file to reconnect to the repository. The
INFA_REPCNX_INFO environment variable stores the file name and file path for the repository connection file.
Each time you run pmrep connect, the command deletes the pmrep.cnx file. If the pmrep connect command
succeeds, the command replaces the pmrep.cnx file with the repository connection information.
If you do not set this environment variable, pmrep stores connection information in pmrep.cnx in the home
directory. If you want to set the pmrep.cnx file in another location, specify the file path using the
INFA_REPCNX_INFO environment variable.
INFA_REPOSITORY_PASSWORD
INFA_REPOSITORY_PASSWORD environment variable applies to the infacmd command line program.
Some infacmd commands require a PowerCenter repository password. You can provide a user password as
an option with infacmd, or you can store it as the environment variable INFA_REPOSITORY_PASSWORD.
Use the following steps as a guideline to use an encrypted password as an environment variable:
1. Use the command line program pmpasswd to encrypt the user password.
pmpasswd generates and displays the encrypted password. For example, if you enter the password
“monday,” it encrypts to f/wRb5PZsZnqESTDPeos7Q==.
2. Configure the password environment variable to set the encrypted value.
Related Topics:
• “Encrypting Passwords” on page 57
INFA_REPOSITORY_PASSWORD 55
2. In a UNIX C shell environment, type:
setenv INFA_REPOSITORY_PASSWORD <encrypted password>
In a UNIX Bourne shell environment, type:
INFA_REPOSITORY_PASSWORD = <encrypted password>
export INFA_REPOSITORY_PASSWORD
INFATOOL_DATEFORMAT
INFATOOL_DATEFORMAT environment variable applies to the pmcmd command line program.
Use this environment variable to customize the way pmcmd displays the date and time. Enter the date format
string in DY MON DD HH24:MI:SS YYYY format. pmcmd verifies that the string is a valid format. If the format
string is not valid, the Integration Service generates a warning message and displays the date in the format
DY MON DD HH24:MI:SS YYYY.
u Enter the environment variable INFATOOL_DATEFORMAT, and set the value to the display format string.
For information about setting environment variables on Windows, consult the Windows documentation.
For example, you can encrypt the repository and database passwords for pmrep to maintain security when
using pmrep in scripts. Then you can create an environment variable to store the encrypted password. Or, you
can define a password for a relational database connection object in a parameter file.
The pmpasswd utility uses a AES/CBC/PKCS5 padding cipher and generates a base64 encoded and AES-128
bit encrypted password.
Encrypting Passwords 57
Configuring a Password as an Environment Variable on Windows
To configure a password as an environment variable on Windows:
u Enter the user name environment variable in the Variable field. Enter the user name in the Value field.
For information about setting environment variables on Windows, consult the Windows documentation.
Using infacmd
This chapter includes the following topics:
• Application services and processes. Create, enable, disable, remove, and get the status of application
services and the associated service processes. Ping services. List services and the nodes that run them.
Update service processes and service process options. You cannot use infacmd to create services of a
previous version.
• Domain gateway. Update the gateway node connectivity information.
• Domains. Link domains and remove domain links. Change the domain administrator password. Update
domain options. Add and remove service levels.
• Folders. Create, move, list, update, and remove folders. Move objects between folders.
• Grids. Create and remove grids. List nodes in a grid.
• Licenses. Add, remove, assign, unassign, and list licenses. Show license information.
• Log events. Get and purge log events. Get session and workflow logs. Convert log files from binary to text
format.
• Nodes. Update, ping, shut down, and remove nodes. List node names and options. Update the node role.
Add, enable, list, disable, and remove node resources. Change a node from a gateway node to a worker
node or from a worker node to a gateway node. Calculate the CPU profile for a node.
• Users. Create and remove users. Reset user passwords. Subscribe to and unsubscribe users from alerts.
Assign users permission on objects. Enable user account lockout and unlock user accounts.
59
infacmd ListPlugins
Each infacmd program has a plugin identifier. When you run the program, you include the plugin ID as part of
the program name.
For example, dis is the plugin ID for the Data Integration Services infacmd program.
For example, to run a command that lists deployed applications, run the infacmd dis ListApplications
command:
To list the valid commands for a plugin, enter the following command:
Running Commands
Invoke infacmd from the command line. You can issue commands directly or from a script, batch file, or
other program.
1. At the command prompt, switch to the directory where the infacmd executable is located.
By default, infacmd installs in the following directory of the Informatica services installation:
<Informatica installation directory>/isp/bin
You can also install infacmd from the Informatica Installation DVD.
2. Enter infacmd on Windows or infacmd.sh on UNIX followed by the plugin ID, the command name, and
the required options and arguments. The command names are not case sensitive.
For example:
infacmd(.sh) plugin_ID CommandName [-option1] argument_1 [-option2]
argument_2...Command Options
When you run infacmd, you enter options for each command, followed by the required arguments. For
example, most commands require that you enter the domain name, user name, and password using
command options. Command options are preceded with a hyphen and are not case sensitive. Arguments
follow the option.
To enter an argument that is preceded with a hyphen, enclose the argument in quotation marks using the
backslash (\) as an escape character before each quotation mark. For example, the following command
writes the log for the mapping run with the job ID "-qnLI7G_TEeW9olHBkc9hoA" to the file "MyLog.log" within
the infacmd directory on Windows:
infacmd ms GetRequestLog -dn MyDomain -sn MyDIS -un AdminUser -pd password -id \"-
qnLI7G_TEeW9olHBkc9hoA\" -f MyLog.log
If you omit or incorrectly enter one of the required options, the command fails and infacmd returns an error
message.
• CreateExceptionAuditTables, 62
• CreateService, 64
• DeleteExceptionAuditTables, 68
• ListServiceOptions, 69
• ListServiceProcessOptions, 71
• UpdateServiceOptions, 72
• UpdateServiceProcessOptions, 74
CreateExceptionAuditTables
Creates tables that can contain audit trail data for the work that Analyst tool users perform in exception
management tasks.
<-DomainName|-dn> domain_name
<-ServiceName|-sn> service_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
62
The following table describes infacmd as CreateExceptionAuditTables options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set
-dn the domain name with the -dn option or the environment
variable INFA_DEFAULT_DOMAIN. If you set a domain
name with both methods, the -dn option takes
precedence.
-Password password Required if you specify the user name. Password for the
-pd user name. The password is case sensitive. You can set
a password with the -pd option or the environment
variable INFA_DEFAULT_DOMAIN_PASSWORD. If you set
a password with both methods, the password set with
the -pd option takes precedence.
CreateExceptionAuditTables 63
Rules and Guidelines for Exception Management Audit Tables
Before you create tables to store audit data for exception management tasks, review the following rules and
guidelines:
• The Analyst Service writes audit data for the exception management tasks that a Data Integration Service
creates when it runs a workflow that contains a Human task. Each exception management task is an
instance of a Human task in a workflow.
The HumanTaskDataIntegrationService option on the infacmd as createService help command identifies
the Data Integration Service that creates the exception management tasks.
• Before you create the exception Management audit tables, identify a database and a schema for the
tables. To identify the database and schema, run the infacmd as updateServiceOptions command.
When you run infacmd as updateServiceOptions, set the following options:
-o HumanTaskDataIntegrationService.exceptionDbName
-o HumanTaskDataIntegrationService.exceptionSchemaName
• The audit tables contain all audit trail data for the work that users perform in the Analyst tool that the
Analyst Service specifies. If you do not create the audit tables, the Analyst Service creates audit tables for
each exception management task in the database that contains the task data.
CreateService
Creates an Analyst Service in a domain. Also associates a Model Repository Service, Data Integration
Services, and Metadata Manager Service with the Analyst Service.
<-DomainName|-dn> domain_name
<-NodeName|-nn> node_name
<-ServiceName|-sn> service_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
[<-RepositoryService|-rs> model_repository_service_name]
[<-DataIntegrationService|-ds> data_integration_service_name]
[<-HumanTaskDataIntegrationService|-htds> human_task_data_integration_service_name]
[<-MetadataManagerService|-mm> metadata_manager_service_name]
[<-FlatFileCacheLocation|-ffl> flat_file_location]
[<-CatalogService|-cs> catalog_service_name]
[<-CatalogServiceUserName|-csau> catalog_service_user_name]
[<-CatalogServiceSecurityDomain|-cssdn> catalog_service_security_domain]
[<-RepositoryUsername|-au> model_repository_user_name]
[<-RepositorySecurityDomain|-rssdn> model_repository_security_domain]
[<-RepositoryPassword|-ap> model_repository_password]
[<-BusinessGlossaryExportFileDirectory|-bgefd> business_glossary_export_file_directory]
<-HttpPort> http_port
The following table describes infacmd as CreateService options and arguments:
CreateService 65
Option Argument Description
CreateService 67
DeleteExceptionAuditTables
Deletes tables that can contain audit trail data for the work that Analyst tool users perform in exception
management tasks.
<-DomainName|-dn> domain_name
<-ServiceName|-sn> service_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
The following table describes infacmd as DeleteExceptionAuditTables options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set
-dn the domain name with the -dn option or the environment
variable INFA_DEFAULT_DOMAIN. If you set a domain
name with both methods, the -dn option takes
precedence.
-Password password Required if you specify the user name. Password for the
-pd user name. The password is case sensitive. You can set
a password with the -pd option or the environment
variable INFA_DEFAULT_DOMAIN_PASSWORD. If you set
a password with both methods, the password set with
the -pd option takes precedence.
ListServiceOptions
Lists Analyst Service options. Lists the values for each Analyst Service option.
<-DomainName|-dn> domain_name
<-ServiceName|-sn> service_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
ListServiceOptions 69
The following table describes infacmd as ListServiceOptions options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set
-dn the domain name with the -dn option or the environment
variable INFA_DEFAULT_DOMAIN. If you set a domain
name with both methods, the -dn option takes
precedence.
-ServiceName service_name Required. Name of the Analyst Service. The name is not
-sn case sensitive.
-Password password Required if you specify the user name. Password for the
-pd user name. The password is case sensitive. You can set
a password with the -pd option or the environment
variable INFA_DEFAULT_DOMAIN_PASSWORD. If you set
a password with both methods, the password set with
the -pd option takes precedence.
<-DomainName|-dn> domain_name
<-ServiceName|-sn> service_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-NodeName|-nn> node_name
The following table describes infacmd as ListServiceProcessOptions options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set
-dn the domain name with the -dn option or the environment
variable INFA_DEFAULT_DOMAIN. If you set a domain
name with both methods, the -dn option takes
precedence.
-ServiceName service_name Required. Name of the Analyst Service. The name is not
-sn case sensitive.
-Password password Required if you specify the user name. Password for the
-pd user name. The password is case sensitive. You can set
a password with the -pd option or the environment
variable INFA_DEFAULT_DOMAIN_PASSWORD. If you set
a password with both methods, the password set with
the -pd option takes precedence.
ListServiceProcessOptions 71
Option Argument Description
-NodeName node_name Required. Node where the Analyst Service process runs.
-nn
UpdateServiceOptions
Updates Analyst Service options. To view current option values, run infacmd as ListServiceOptions.
<-DomainName|-dn> domain_name
<-ServiceName|-sn> service_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
-DomainName domain_name Required. Name of the Informatica domain. You can set
-dn the domain name with the -dn option or the environment
variable INFA_DEFAULT_DOMAIN. If you set a domain
name with both methods, the -dn option takes
precedence.
-Password password Required if you specify the user name. Password for the
-pd user name. The password is case sensitive. You can set
a password with the -pd option or the environment
variable INFA_DEFAULT_DOMAIN_PASSWORD. If you set
a password with both methods, the password set with
the -pd option takes precedence.
UpdateServiceOptions 73
Option Argument Description
UpdateServiceProcessOptions
Updates options for the Analyst Service process. To view options, run the infacmd as
ListServiceProcessOptions command.
<-DomainName|-dn> domain_name
<-ServiceName|-sn> service_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-NodeName|-nn> node_name
<-Options|-o> options
The following table describes infacmd as UpdateServiceProcessOptions options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set the
-dn domain name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with both
methods, the -dn option takes precedence.
-Password password Required if you specify the user name. Password for the user
-pd name. The password is case sensitive. You can set a password
with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password
with both methods, the password set with the -pd option takes
precedence.
-NodeName node_name Required. Node where the Analyst Service process runs.
-nn
UpdateServiceProcessOptions 75
Chapter 7
• getDomainObjectPermissions, 76
• getPrivilegeAssociation, 78
• getUserGroupAssociation, 80
• getUserGroupAssociationForRoles, 82
• getUsersPersonalInfo, 84
getDomainObjectPermissions
Gets the list of domain objects to which the specified users or groups have permission. You can generate
reports for the specified users or groups.
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<<-ExistingUserNames|-eu> existing_user_names|
<-ExistingGroupNames|-eg> existing_group_names>
[<-ExistingSecurityDomain|-esd> existing_security_domain]
[<-Format|-fm> format_TEXT_CSV]
[<-OutputFile|-lo> output_file_name]
76
The following table describes infacmd aud getDomainObjectPermissions options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set
-dn the domain name with the -dn option or the environment
variable INFA_DEFAULT_DOMAIN. If you set a domain
name with both methods, the -dn option takes
precedence.
-Password password Required if you specify the user name. Password for the
-pd user name. The password is case sensitive. You can set
a password with the -pd option or the environment
variable INFA_DEFAULT_DOMAIN_PASSWORD. If you set
a password with both methods, the password set with
the -pd option takes precedence.
-SecurityDomain security_domain Name of the security domain that you want to create to
-sdn which the domain user belongs. You can set a security
domain with the -sdn option or the environment variable
INFA_DEFAULT_SECURITY_DOMAIN. If you set a security
domain name with both methods, the -sdn option takes
precedence. The security domain name is case sensitive.
You can specify a value for ‑sdn or use the default based
on the authentication mode:
- Required if the domain uses LDAP authentication.
Default is Native. To work with LDAP authentication,
you need to specify the value for -sdn.
- Optional if the domain uses native authentication or
Kerberos authentication. Default is native for native
authentication. If the domain uses Kerberos
authentication, the default is the LDAP security
domain created during installation. The name of the
security domain is the same as the user realm
specified during installation.
getDomainObjectPermissions 77
Option Argument Description
-OutputFile output_file_name Optional. Name and file path for the output file.
-lo If you do not specify an output file name, infacmd
displays the log events on the screen.
getPrivilegeAssociation
Gets privileges assigned to the users or groups. You can select the users or groups for which you want to
generate report.
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<<-ExistingUserNames|-eu> existing_user_names|
<-ExistingGroupNames|-eg> existing_group_names>
[<-ExistingSecurityDomain|-esd> existing_security_domain]
[<-Format|-fm> format_TEXT_CSV]
[<-OutputFile|-lo> output_file_name]
-DomainName domain_name Required. Name of the Informatica domain. You can set
-dn the domain name with the -dn option or the environment
variable INFA_DEFAULT_DOMAIN. If you set a domain
name with both methods, the -dn option takes
precedence.
-Password password Required if you specify the user name. Password for the
-pd user name. The password is case sensitive. You can set a
password with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a
password with both methods, the password set with the -
pd option takes precedence.
getPrivilegeAssociation 79
Option Argument Description
-OutputFile output_file_name Optional. Name and file path for the output file.
-lo If you do not specify an output file name, infacmd
displays the log events on the screen.
getUserGroupAssociation
Gets list of users that belong to the group or a list of groups associated with specified users. You can select
the users or groups for which you want to generate report.
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<<-ExistingUserNames|-eu> existing_user_names|
<-ExistingGroupNames|-eg> existing_group_names>
[<-ExistingSecurityDomain|-esd> existing_security_domain]
[<-Format|-fm> format_TEXT_CSV]
[<-OutputFile|-lo> output_file_name]
-DomainName domain_name Required. Name of the Informatica domain. You can set
-dn the domain name with the -dn option or the environment
variable INFA_DEFAULT_DOMAIN. If you set a domain
name with both methods, the -dn option takes
precedence.
-Password password Required if you specify the user name. Password for the
-pd user name. The password is case sensitive. You can set
a password with the -pd option or the environment
variable INFA_DEFAULT_DOMAIN_PASSWORD. If you set
a password with both methods, the password set with
the -pd option takes precedence.
getUserGroupAssociation 81
Option Argument Description
-OutputFile output_file_name Optional. Name and file path for the output file.
-lo If you do not specify an output file name, infacmd
displays the log events on the screen.
getUserGroupAssociationForRoles
Gets list of roles assigned to users and groups. You can select the roles for which you want to generate
report.
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-RoleNames|-en> role_names
[<-Format|-fm> format_TEXT_CSV]
[<-OutputFile|-lo> output_file_name]
-DomainName domain_name Required. Name of the Informatica domain. You can set
-dn the domain name with the -dn option or the environment
variable INFA_DEFAULT_DOMAIN. If you set a domain
name with both methods, the -dn option takes
precedence.
-Password password Required if you specify the user name. Password for the
-pd user name. The password is case sensitive. You can set
a password with the -pd option or the environment
variable INFA_DEFAULT_DOMAIN_PASSWORD. If you set
a password with both methods, the password set with
the -pd option takes precedence.
-RoleNames role_names Required. Name of the role assigned for users or groups
-en in the domain for which you want to generate the report.
For multiple roles, separate each role by a comma at the
command line.
getUserGroupAssociationForRoles 83
Option Argument Description
-OutputFile output_file_name Optional. Name and file path for the output file.
-lo If you do not specify an output file name, infacmd
displays the log events on the screen.
getUsersPersonalInfo
Gets user information in the domain. The report displays the full name, security domain, description, contact
details, and user status. If you run the report for users, the report displays the user information for the
specified users. If you run the report for groups, the report organizes user information for all users in the
specified group. The report displays nested groups separately.
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<<-ExistingUserNames|-eu> existing_user_names|
<-ExistingGroupNames|-eg> existing_group_names>
[<-ExistingSecurityDomain|-esd> existing_security_domain]
[<-Format|-fm> format_TEXT_CSV]
[<-OutputFile|-lo> output_file_name]
-DomainName domain_name Required. Name of the Informatica domain. You can set
-dn the domain name with the -dn option or the environment
variable INFA_DEFAULT_DOMAIN. If you set a domain
name with both methods, the -dn option takes
precedence.
-Password password Required if you specify the user name. Password for the
-pd user name. The password is case sensitive. You can set
a password with the -pd option or the environment
variable INFA_DEFAULT_DOMAIN_PASSWORD. If you set
a password with both methods, the password set with
the -pd option takes precedence.
getUsersPersonalInfo 85
Option Argument Description
-OutputFile output_file_name Optional. Name and file path for the output file.
-lo If you do not specify an output file name, infacmd
displays the log events on the screen.
• Autotune, 87
Autotune
Configures services and connections with recommended settings based on the deployment type. Changes
take effect after you recycle the services.
For each specified service, the changes to the service take effect on all nodes that are currently configured to
run the service, and the changes affect all service processes.
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-Size|-s> tuning_size_name
[<-ServiceNames|-sn> service_names]
[<-BlazeConnectionNames|-bcn> connection_names]
[<-SparkConnectionNames|-scn> connection_names]
[<-All|-a> yes_or_no]
87
The following table describes infacmd autotune Autotune options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set the
-dn domain name with the -dn option or the environment
variable INFA_DEFAULT_DOMAIN. If you set a domain name
with both methods, the -dn option takes precedence.
-Password password Required if you specify the user name. Password for the
-pd user name. The password is case sensitive. You can set a
password with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password
with both methods, the password set with the -pd option
takes precedence.
-Size tuning_size_name Required. The deployment type that represents big data
-s processing requirements based on concurrency and volume.
You can enter Sandbox, Basic, Standard, or Advanced.
Autotune 89
Chapter 9
• upgradeRepository, 90
• listGlossary, 91
• exportGlossary, 92
• importGlossary, 96
upgradeRepository
Upgrades the business glossary data in the Model repository. Run this command after you upgrade the
domain and Model Repository Service.
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> Password
[<-SecurityDomain|-sdn> security_domain]
<-AtServiceName|-atn> Analyst_service_name
The following table describes infacmd bg upgradeRepository options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set
-dn the domain name with the -dn option or the environment
variable INFA_DEFAULT_DOMAIN. If you set a domain
name with both methods, the -dn option takes
precedence.
90
Option Argument Description
-Password Password Required if you specify the user name. Password for the
-pd user name. The password is case sensitive. You can set
a password with the -pd option or the environment
variable INFA_DEFAULT_DOMAIN_PASSWORD. If you set
a password with both methods, the password set with
the -pd option takes precedence.
listGlossary
Displays a list of the business glossaries available in the Analyst tool as a standard output. Each glossary
name is displayed as a separate line.
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> Password
[<-SecurityDomain|-sdn> security_domain]
<-AtServiceName|-atn> Analyst_service_name
listGlossary 91
The following table describes infacmd bg upgradeRepository options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set
-dn the domain name with the -dn option or the environment
variable INFA_DEFAULT_DOMAIN. If you set a domain
name with both methods, the -dn option takes
precedence.
-Password Password Required if you specify the user name. Password for the
-pd user name. The password is case sensitive. You can set
a password with the -pd option or the environment
variable INFA_DEFAULT_DOMAIN_PASSWORD. If you set
a password with both methods, the password set with
the -pd option takes precedence.
exportGlossary
Exports the business glossaries available in the Analyst tool. The Analyst tool exports business glossary data
in the .xlsx or .zip format based on the options that you specify.
<-DomainName|-dn> domain_name
<-Password|-pd> Password
[<-SecurityDomain|-sdn> security_domain]
<-AtServiceName|-atn> Analyst_service_name
[<-GlossaryList|-gl> Glossary_list]
[<-Delimiter|-dl> Glossary_name_delimiter]
[<-IncludeCrossGlossaryLinks|-cgl> Include_cross_glossary_links_true_false]
[<-IncludeAuditHistory|-ah> Include_audit_history_true_false]
[<-IncludeAttachment|-att> Include_attachments_true_false]
[<-IncludeOnlyTemplate|-tem> Include_templates_only_true_false]
[<-ExportasPlainTextOnly|-ept> Export_richtext_as_plain_text_true_false]
[<-status|-s> Status_of_assets]
[<-phase|-p> Phase_of_assets]
<-ExportFilePath|-ep> Export_path
exportGlossary 93
Option Argument Description
exportGlossary 95
Option Argument Description
importGlossary
Imports business glossaries from .xlsx or .zip files that were exported from the Analyst tool.
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> Password
[<-SecurityDomain|-sdn> security_domain]
<-AtServiceName|-atn> Analyst_service_name
[<-GlossaryList|-gl> Glossary_list]
[<-Delimiter|-dl> Glossary_name_delimiter]
[<-IncludeAuditHistory|-ah> Include_audit_history_true_false]
[<-IncludeAttachment|-att> Include_attachments_true_false]
[<-IncludeOnlyTemplate|-tem> Include_templates_only_true_false]
[<-IncludeRichTextContentforConflictingAssets|-irt>
Include_richtextcontent_conflicting_assets_true_false]
<-ImportFilePath|-ip> Import_path
[<-ResolutionOnMatchByName|-rmn> Copy_or_replace_or_skip_assets_by_name]
[<-ResolutionOnMatchById|-rmi> Copy_or_replace_or_skip_assets_by_id]
The following table describes infacmd bg importGlossary options and arguments:
importGlossary 97
Option Argument Description
importGlossary 99
Option Argument Description
• deleteClusters, 101
• listClusters, 103
• updateADLSCertificate, 104
deleteClusters
Deletes clusters created by the cluster workflow from the cloud platform.
101
The following table describes infacmd ccps deleteClusters options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set
-dn the domain name with the -dn option or the environment
variable INFA_DEFAULT_DOMAIN. If you set a domain
name with both methods, the -dn option takes
precedence.
-Password password Required if you specify the user name. Password for the
-pd user name. The password is case sensitive. You can set
a password with the -pd option or the environment
variable INFA_DEFAULT_DOMAIN_PASSWORD. If you set
a password with both methods, the password set with
the -pd option takes precedence.
-ConfigurationName Name of the cluster Required. Name of the cluster configuration on the
-cn configuration domain. Values are not case sensitive.
listClusters
Lists clusters that the cluster workflow creates and that exist on the cloud platform.
-DomainName domain_name Required. Name of the Informatica domain. You can set
-dn the domain name with the -dn option or the environment
variable INFA_DEFAULT_DOMAIN. If you set a domain
name with both methods, the -dn option takes
precedence.
-Password password Required if you specify the user name. Password for the
-pd user name. The password is case sensitive. You can set
a password with the -pd option or the environment
variable INFA_DEFAULT_DOMAIN_PASSWORD. If you set
a password with both methods, the password set with
the -pd option takes precedence.
listClusters 103
Option Argument Description
updateADLSCertificate
Updates the Azure Data Lake Service Principal certificate path in a cloud provisioning configuration.
-DomainName domain_name Required. Name of the Informatica domain. You can set
-dn the domain name with the -dn option or the environment
variable INFA_DEFAULT_DOMAIN. If you set a domain
name with both methods, the -dn option takes
precedence.
-Password password Required if you specify the user name. Password for the
-pd user name. The password is case sensitive. You can set
a password with the -pd option or the environment
variable INFA_DEFAULT_DOMAIN_PASSWORD. If you set
a password with both methods, the password set with
the -pd option takes precedence.
updateADLSCertificate 105
Chapter 11
• createConfiguration, 106
• createConfigurationWithParams, 108
• deleteConfiguration, 111
• clearConfigurationProperties, 112
• exportConfiguration, 114
• listAssociatedConnections, 115
• listConfigurationGroupPermissions, 117
• listConfigurationSets, 118
• listConfigurationProperties, 120
• listConfigurations, 121
• listConfigurationUserPermissions, 122
• refreshConfiguration, 124
• setConfigurationPermissions, 126
• setConfigurationProperties, 128
• updateConfiguration, 130
createConfiguration
Imports cluster information directly from a cluster or from a cluster archive file.
The cluster configuration is an object in the domain that contains configuration information about the
compute cluster.
106
[<-DistributionType|-dt> CDH|EMR|HDI|HDP|MAPR|DATABRICKS]
[<-DistributionVersion|-dv> distribution_version]
[<-ClusterManagerUri|-uri> cluster_manager_uri]
[<-ClusterManagerUser|-cmu> cluster_manager_user]
[<-ClusterManagerPassword|-cmp> cluster_manager_password]
[<-ClusterName|-cln> cluster_name]
[<-FilePath|-path> file_path]
The following table describes infacmd cluster createConfiguration options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set
-dn the domain name with the -dn option or the environment
variable INFA_DEFAULT_DOMAIN. If you set a domain
name with both methods, the -dn option takes
precedence.
-Password password Required if you specify the user name. Password for the
-pd user name. The password is case sensitive. You can set
a password with the -pd option or the environment
variable INFA_DEFAULT_DOMAIN_PASSWORD. If you set
a password with both methods, the password set with
the -pd option takes precedence.
createConfiguration 107
Option Argument Description
-ConfigurationName Name of the cluster Required. The cluster configuration name must meet the
-cn configuration following requirements:
- Unique within the domain
- Cannot exceed 128 characters
- Cannot contain white spaces or the following special
characters:
- ~`!$%^&*()-+={[}]|\:;"'<,>.?/
Values are not case sensitive.
-DistributionVersion Distribution version Optional. Specify a distribution version other than the
-dv default version.
Each distribution has a default version. Use the -dv
option to specify a different supported version to apply
to the cluster configuration.
Default is the most recent distribution version that Big
Data Management supports.
-ClusterManagerUri Cluster manager URI Required to import directly from the cluster. URI of the
-uri cluster configuration web interface.
-ClusterManagerUser Cluster Manager user Required to import directly from the cluster. User name
-cmu of the account to log in to the cluster configuration web
interface.
-ClusterManagerPassword Cluster Manager password Required to import directly from the cluster. Password of
-cmp the account to log in to the cluster configuration web
interface.
-FilePath Path and filename to the Required to import cluster information from a file. Path
-path location of the archive file. and file name of the archive file that contains cluster
information.
createConfigurationWithParams
Creates a cluster configuration through cluster parameters that you specify in the command line.
The cluster configuration is an object in the domain that contains configuration information about the
compute cluster.
-DomainName domain_name Required. Name of the Informatica domain. You can set
-dn the domain name with the -dn option or the environment
variable INFA_DEFAULT_DOMAIN. If you set a domain
name with both methods, the -dn option takes
precedence.
-Password password Required if you specify the user name. Password for the
-pd user name. The password is case sensitive. You can set
a password with the -pd option or the environment
variable INFA_DEFAULT_DOMAIN_PASSWORD. If you set
a password with both methods, the password set with
the -pd option takes precedence.
createConfigurationWithParams 109
Option Argument Description
-ConfigurationName Name of the cluster Required. The cluster configuration name must meet the
-cn configuration following requirements:
- Unique within the domain
- Cannot exceed 128 characters
- Cannot contain white spaces or the following special
characters:
- ~`!$%^&*()-+={[}]|\:;"'<,>.?/
Values are not case sensitive.
-DistributionVersion Distribution version Optional. Specify a distribution version other than the
-dv default version.
Each distribution has a default version. Use the -dv
option to specify a different supported version to apply
to the cluster configuration.
Default is the most recent distribution version that Big
Data Management supports.
You cannot delete a cluster configuration that is used by any connection object.
-DomainName domain_name Required. Name of the Informatica domain. You can set
-dn the domain name with the -dn option or the environment
variable INFA_DEFAULT_DOMAIN. If you set a domain
name with both methods, the -dn option takes
precedence.
-Password password Required if you specify the user name. Password for the
-pd user name. The password is case sensitive. You can set
a password with the -pd option or the environment
variable INFA_DEFAULT_DOMAIN_PASSWORD. If you set
a password with both methods, the password set with
the -pd option takes precedence.
deleteConfiguration 111
Option Argument Description
-ConfigurationName Name of the cluster Required. Name of the cluster configuration on the
-cn configuration domain. Values are not case sensitive.
clearConfigurationProperties
Clears overridden property values in the cluster configuration set.
The command clears overridden values of imported properties and restores the value that was imported. The
command deletes user-defined properties from a configuration set. To delete an imported property, use the -
del option.
Note: When you delete an imported property, the refresh operation restores the property if it exists on the
cluster.
For example, the following command deletes the user-defined properties "foo.bar" and "biz.baz" from the
core-site.xml set of the CDH1 cluster configuration:
infacmd cluster clearConfigurationProperties -cn CDH1 -cs core-site.xml -pn foo.bar
biz.baz
The infacmd cluster clearConfigurationProperties command uses the following syntax:
clearConfigurationProperties
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-ConfigurationName|-cn> configuration name
<-ConfigurationSet|-cs> configuration set
<-PropertyNames|-pn> list of property names separated by space
[<-DeleteProperties|-del> delete_properties]
-DomainName domain_name Required. Name of the Informatica domain. You can set
-dn the domain name with the -dn option or the environment
variable INFA_DEFAULT_DOMAIN. If you set a domain
name with both methods, the -dn option takes
precedence.
-Password password Required if you specify the user name. Password for the
-pd user name. The password is case sensitive. You can set
a password with the -pd option or the environment
variable INFA_DEFAULT_DOMAIN_PASSWORD. If you set
a password with both methods, the password set with
the -pd option takes precedence.
-ConfigurationName Name of the cluster Required. Name of the cluster configuration on the
-cn configuration domain. Values are not case sensitive.
clearConfigurationProperties 113
Option Argument Description
-DeleteProperties delete_properties Optional. When you set the option to TRUE, deletes an
-del imported property.
Default is FALSE.
exportConfiguration
Exports a cluster configuration to an archive file containing .xml files or a combined .xml file.
Export the properties that a cluster configuration object contains to a compressed file in a path that you
specify.
When you export the cluster configuration file, you create a .zip archive.
-DomainName domain_name Required. Name of the Informatica domain. You can set
-dn the domain name with the -dn option or the environment
variable INFA_DEFAULT_DOMAIN. If you set a domain
name with both methods, the -dn option takes
precedence.
-Password password Required if you specify the user name. Password for the
-pd user name. The password is case sensitive. You can set
a password with the -pd option or the environment
variable INFA_DEFAULT_DOMAIN_PASSWORD. If you set
a password with both methods, the password set with
the -pd option takes precedence.
-ConfigurationName Name of the cluster Required. Name of the cluster configuration on the
-cn configuration domain. Values are not case sensitive.
-FilePath Path and file name to the Required. Path and file name of the compressed file to
-path location of the file to be created as an archive of the cluster configuration.
create. You can specify an absolute path or a relative path to the
file name. Include a .zip or .tar suffix.
listAssociatedConnections
Lists connections by type that are associated with the specified cluster configuration.
listAssociatedConnections 115
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-ConfigurationName|-cn> configuration_name
The following table describes infacmd cluster listAssociatedConnections options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set
-dn the domain name with the -dn option or the environment
variable INFA_DEFAULT_DOMAIN. If you set a domain
name with both methods, the -dn option takes
precedence.
-Password password Required if you specify the user name. Password for the
-pd user name. The password is case sensitive. You can set
a password with the -pd option or the environment
variable INFA_DEFAULT_DOMAIN_PASSWORD. If you set
a password with both methods, the password set with
the -pd option takes precedence.
-ConfigurationName Name of the cluster Required. Name of the cluster configuration on the
-cn configuration domain. Values are not case sensitive.
Command output includes group permissons and the security domain that the group is a member of.
-DomainName domain_name Required. Name of the Informatica domain. You can set
-dn the domain name with the -dn option or the environment
variable INFA_DEFAULT_DOMAIN. If you set a domain
name with both methods, the -dn option takes
precedence.
-Password password Required if you specify the user name. Password for the
-pd user name. The password is case sensitive. You can set
a password with the -pd option or the environment
variable INFA_DEFAULT_DOMAIN_PASSWORD. If you set
a password with both methods, the password set with
the -pd option takes precedence.
listConfigurationGroupPermissions 117
Option Argument Description
-ConfigurationName Name of the cluster Required. Name of the cluster configuration on the
-cn configuration domain. Values are not case sensitive.
-Direct Whether to list direct or Optional. Determines whether you list permissions that
effective permissons. the administrator has directly granted to the cluster
configuration. Specify one of these values:
- Direct. The permissions that the administrator directly
granted to the group.
- Effective. All of the permissions that the group has,
including direct and inherited permissions.
Default is effective.
GroupFilter Group filter Optional. List the group or groups to show results for. If
-groups you do not specify a group, the command displays
results for all groups by default. Separate group names
with spaces.
listConfigurationSets
Lists the configuration sets that a cluster configuration contains.
-DomainName domain_name Required. Name of the Informatica domain. You can set
-dn the domain name with the -dn option or the environment
variable INFA_DEFAULT_DOMAIN. If you set a domain
name with both methods, the -dn option takes
precedence.
-Password password Required if you specify the user name. Password for the
-pd user name. The password is case sensitive. You can set
a password with the -pd option or the environment
variable INFA_DEFAULT_DOMAIN_PASSWORD. If you set
a password with both methods, the password set with
the -pd option takes precedence.
-ConfigurationName Name of the cluster Required. Name of the cluster configuration on the
-cn configuration domain. Values are not case sensitive.
listConfigurationSets 119
listConfigurationProperties
Lists properties and active values for a configuration set.
-DomainName domain_name Required. Name of the Informatica domain. You can set
-dn the domain name with the -dn option or the environment
variable INFA_DEFAULT_DOMAIN. If you set a domain
name with both methods, the -dn option takes
precedence.
-Password password Required if you specify the user name. Password for the
-pd user name. The password is case sensitive. You can set
a password with the -pd option or the environment
variable INFA_DEFAULT_DOMAIN_PASSWORD. If you set
a password with both methods, the password set with
the -pd option takes precedence.
-ConfigurationName Name of the cluster Required. Name of the cluster configuration on the
-cn configuration domain. Values are not case sensitive.
listConfigurations
Lists the cluster configurations in the domain.
listConfigurations 121
The following table describes infacmd cluster listConfigurations options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set
-dn the domain name with the -dn option or the environment
variable INFA_DEFAULT_DOMAIN. If you set a domain
name with both methods, the -dn option takes
precedence.
-Password password Required if you specify the user name. Password for the
-pd user name. The password is case sensitive. You can set
a password with the -pd option or the environment
variable INFA_DEFAULT_DOMAIN_PASSWORD. If you set
a password with both methods, the password set with
the -pd option takes precedence.
listConfigurationUserPermissions
Lists the permissions that a user has for a cluster configuration.
-DomainName domain_name Required. Name of the Informatica domain. You can set
-dn the domain name with the -dn option or the environment
variable INFA_DEFAULT_DOMAIN. If you set a domain
name with both methods, the -dn option takes
precedence.
-Password password Required if you specify the user name. Password for the
-pd user name. The password is case sensitive. You can set
a password with the -pd option or the environment
variable INFA_DEFAULT_DOMAIN_PASSWORD. If you set
a password with both methods, the password set with
the -pd option takes precedence.
-ConfigurationName Name of the cluster Required. Name of the cluster configuration on the
-cn configuration domain. Values are not case sensitive.
listConfigurationUserPermissions 123
Option Argument Description
-Direct Whether to list direct or Optional. Determines whether you list permissions that
effective permissons. the administrator has directly granted to the cluster
configuration. Specify one of these values:
- Direct. The permissions that the administrator directly
granted to the group.
- Effective. All of the permissions that the group has,
including direct and inherited permissions.
Default is effective.
UserFilter user_filter Optional. List the user or users to show results for. If
-users you do not specify a user, the command displays results
for all users by default.
Values are not case sensitive.
refreshConfiguration
Refreshes a cluster configuration from a cluster archive file or from a remote cluster manager. Changes take
effect after you restart the Data Integration Service.
Updates the cluster configuration properties from a cluster or from a cluster archive file. The
refreshConfiguration command updates the configuration values that you imported. It does not affect the
overrides that you configured.
-DomainName domain_name Required. Name of the Informatica domain. You can set
-dn the domain name with the -dn option or the environment
variable INFA_DEFAULT_DOMAIN. If you set a domain
name with both methods, the -dn option takes
precedence.
-Password password Required if you specify the user name. Password for the
-pd user name. The password is case sensitive. You can set
a password with the -pd option or the environment
variable INFA_DEFAULT_DOMAIN_PASSWORD. If you set
a password with both methods, the password set with
the -pd option takes precedence.
-ConfigurationName Name of the cluster Required. Name of the cluster configuration on the
-cn configuration domain. Values are not case sensitive.
-ClusterManagerUri Cluster manager URI Required to import directly from the cluster. URI of the
-uri cluster configuration web interface.
-ClusterManagerUser Cluster Manager user Required to import directly from the cluster. User name
-cmu of the account to log in to the cluster configuration web
interface.
refreshConfiguration 125
Option Argument Description
-ClusterManagerPassword Cluster Manager password Required to import directly from the cluster. Password of
-cmp the account to log in to the cluster configuration web
interface.
-FilePath Path and filename to the Required to import cluster information from a file. Path
-path location of the archive file. and file name of the archive file that contains cluster *-
site.xml configuration files.
setConfigurationPermissions
Sets permissions on cluster configuration to a user or a group after removing previous permissions.
Allows you to add, change or delete cluster configuration permissions for a user or a group. Removes
previous permissions on the user or group.
You can grant multiple permissions from the following set in a single command: READ, WRITE, EXECUTE,
GRANT. You can grant only ALL or NONE separately.
-DomainName domain_name Required. Name of the Informatica domain. You can set
-dn the domain name with the -dn option or the environment
variable INFA_DEFAULT_DOMAIN. If you set a domain
name with both methods, the -dn option takes
precedence.
-Password password Required if you specify the user name. Password for the
-pd user name. The password is case sensitive. You can set
a password with the -pd option or the environment
variable INFA_DEFAULT_DOMAIN_PASSWORD. If you set
a password with both methods, the password set with
the -pd option takes precedence.
-ConfigurationName Name of the cluster Required. Name of the cluster configuration on the
-cn configuration domain. Values are not case sensitive.
setConfigurationPermissions 127
Option Argument Description
-RecipientSecurityDomain recipient_security_domain Security domain that the user or group is a member of.
-rsd
-Permissions READ | WRITE | EXECUTE | Permission or permissions to grant. To enter more than
-p GRANT one permission, separate permissions with a space.
ALL
NONE
setConfigurationProperties
Adds user-defined properties or overrides imported property values.
-DomainName domain_name Required. Name of the Informatica domain. You can set
-dn the domain name with the -dn option or the environment
variable INFA_DEFAULT_DOMAIN. If you set a domain
name with both methods, the -dn option takes
precedence.
-Password password Required if you specify the user name. Password for the
-pd user name. The password is case sensitive. You can set
a password with the -pd option or the environment
variable INFA_DEFAULT_DOMAIN_PASSWORD. If you set
a password with both methods, the password set with
the -pd option takes precedence.
-ConfigurationName Name of the cluster Required. Name of the cluster configuration on the
-cn configuration domain. Values are not case sensitive.
-UserProperties User properties to set Property name-value pairs. Use the equals (=) character
-up to delimit property-value pairs. Use the characters &: to
separate each pair.
-UserProperties Examples
The following examples show how to add a single user property, multiple property-value pairs, or how to
overwrite a user property:
To add a single user property, use the equals (=) character to delimit property-value pairs. For example,
the following command adds the property foo.bar to the core-site.xml namespace of the cluster
configuration, and assigns foo.bar a value of 1:
infacmd cluster setConfigurationProperties -cn cdh -cs core-site.xml -up 'foo.bar=1'
Add multiple property-value pairs
Use the equals (=) character to delimit property-value pairs, and use &: to separate pairs. For example,
the following command adds the property foo.bar to the core-site.xml namespace of the cluster
configuration and assigns foo.bar a value of 1. It then adds the property start.interval to the same
namespace and assigns start.interval a value of 5:
infacmd cluster setConfigurationProperties -cn cdh -cs core-site.xml -up
'foo.bar=1&:start.interval=5'
setConfigurationProperties 129
Overwrite a user property
To overwrite the value of a user property, specify the property-value pair with another value. For example,
the following command edits the existing property fs.trash.interval in the core-site.xml namespace of the
cluster configuration. The command overrides the existing value and assigns a value of 2:
infacmd cluster setConfigurationProperties -cn cdh -cs core-site.xml -up
'fs.trash.interval=2'
updateConfiguration
Updates the Hadoop distribution version of a cluster configuration.
Use the -dv option to change the distribution version of the Hadoop distribution of a cluster configuration.
-DomainName domain_name Required. Name of the Informatica domain. You can set
-dn the domain name with the -dn option or the environment
variable INFA_DEFAULT_DOMAIN. If you set a domain
name with both methods, the -dn option takes
precedence.
-Password password Required if you specify the user name. Password for the
-pd user name. The password is case sensitive. You can set
a password with the -pd option or the environment
variable INFA_DEFAULT_DOMAIN_PASSWORD. If you set
a password with both methods, the password set with
the -pd option takes precedence.
-ConfigurationName Name of the cluster Required. Name of the cluster configuration on the
-cn configuration domain. Values are not case sensitive.
updateConfiguration 131
Chapter 12
• CreateAuditTables, 132
• CreateService, 134
• DeleteAuditTables, 136
• ListServiceOptions, 138
• ListServiceProcessOptions, 139
• Purge, 141
• RemoveService, 142
• ResyncData, 144
• UpdateServiceOptions, 146
• UpdateServiceProcessOptions, 148
• Upgrade, 150
CreateAuditTables
Creates audit tables that contain audit trail log events for reference tables managed by the specified Content
Management Service.
<-DomainName|-dn> domain_name
<-ServiceName|-sn> service_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
132
The following table describes infacmd cms CreateAuditTables options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set
-dn the domain name with the -dn option or the environment
variable INFA_DEFAULT_DOMAIN. If you set a domain
name with both methods, the -dn option takes
precedence.
-Password password Required if you specify the user name. Password for the
-pd user name. The password is case sensitive. You can set
a password with the -pd option or the environment
variable INFA_DEFAULT_DOMAIN_PASSWORD. If you set
a password with both methods, the password set with
the -pd option takes precedence..
CreateAuditTables 133
CreateService
Creates a Content Management Service in a domain.
<-DomainName|-dn> domain_name
<-ServiceName|-sn> service_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-NodeName|-nn> node_name
<-DataServer|-ds> data_service_name
<-RepositoryService|-rs> repository_service_name
<-RepositoryUsername|-rsu> repository_user_name
<-RepositoryPassword|-rsp> repository_password
[<-RepositorySecurityDomain|-rssd> repository_security_domain]
<-ReferenceDataLocation|-rdl> reference_data_location
[<-HttpPort> http_port]
[<-HttpsPort> https_port]
[<-KeystoreFile|-kf> keystore_file_location]
[<-KeystorePassword|-kp> keystore_password]
The following table describes infacmd cms CreateService options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set
-dn the domain name with the -dn option or the environment
variable INFA_DEFAULT_DOMAIN. If you set a domain
name with both methods, the -dn option takes
precedence.
-Password password Required if you specify the user name. Password for the
-pd user name. The password is case sensitive. You can set
a password with the -pd option or the environment
variable INFA_DEFAULT_DOMAIN_PASSWORD. If you set
a password with both methods, the password set with
the -pd option takes precedence.
CreateService 135
Option Argument Description
-ReferenceDataLocation reference_data_location Required. Connection name for the database that stores
-rdl data values for the reference tables defined in the Model
repository. The specified database stores reference data
values. The Model repository stores metadata for the
reference tables.
-HttpPort http_port Required. Unique HTTP port number for the Content
Management Service.
-HttpsPort https_port Optional. HTTPS port number that the service runs on
when you enable the Transport Layer Security (TLS)
protocol.
-KeystoreFile keystore_file_location Path and file name of the keystore file that contains the
-kf keys and certificates required if you enable TLS and use
the HTTPS protocol for the service.
-KeystorePassword> keystore_password Required if you enable TLS and use HTTPS connections
-kp for the service. A plain-text password for the keystore
file.
DeleteAuditTables
Deletes the audit trail tables for the specified Content Management Service.
<-DomainName|-dn> domain_name
<-ServiceName|-sn> service_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
-DomainName domain_name Required. Name of the Informatica domain. You can set
-dn the domain name with the -dn option or the environment
variable INFA_DEFAULT_DOMAIN. If you set a domain
name with both methods, the -dn option takes
precedence.
-Password password Required if you specify the user name. Password for the
-pd user name. The password is case sensitive. You can set
a password with the -pd option or the environment
variable INFA_DEFAULT_DOMAIN_PASSWORD. If you set
a password with both methods, the password set with
the -pd option takes precedence..
DeleteAuditTables 137
ListServiceOptions
Lists the options for a Content Management Service.
<-DomainName|-dn> domain_name
<-ServiceName|-sn> service_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
The following table describes infacmd cms ListServiceOptions options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set
-dn the domain name with the -dn option or the environment
variable INFA_DEFAULT_DOMAIN. If you set a domain
name with both methods, the -dn option takes
precedence.
-Password password Required if you specify the user name. Password for the
-pd user name. The password is case sensitive. You can set
a password with the -pd option or the environment
variable INFA_DEFAULT_DOMAIN_PASSWORD. If you set
a password with both methods, the password set with
the -pd option takes precedence..
ListServiceProcessOptions
Lists the options for a Content Management Service process.
<-DomainName|-dn> domain_name
<-ServiceName|-sn> service_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-NodeName|-nn> node_name
ListServiceProcessOptions 139
The following table describes cms ListServiceProcessOptions options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set
-dn the domain name with the -dn option or the environment
variable INFA_DEFAULT_DOMAIN. If you set a domain
name with both methods, the -dn option takes
precedence.
-Password password Required if you specify the user name. Password for the
-pd user name. The password is case sensitive. You can set
a password with the -pd option or the environment
variable INFA_DEFAULT_DOMAIN_PASSWORD. If you set
a password with both methods, the password set with
the -pd option takes precedence.
NodeName node_name Required. Name of the node where the service process
-nn runs.
When you run infacmd cms Purge, the Content Management Service identifies the tables that store data for
reference table objects in the associated Model repository. The Content Management Service deletes all
other tables from the warehouse and generates a list of the deleted tables. Run infacmd cms Purge on the
master Content Management Service for the Model repository.
Note: To prevent accidental data loss, the purge operation does not delete tables if the Model repository does
not contain a reference table object.
Before you run infacmd cms Purge, verify the following prerequisites:
• The user name that you specify in the command has the Manage Service privilege on the domain.
• The Model repository user that the Content Management Service specifies has the Administrator role on
the Model Repository Service.
• All Data Integration Services associated with the Model repository are available.
• There are no data operations in progress on the reference data warehouse.
• The reference data warehouse stores data for the reference table objects in a single Model repository.
The infacmd cms Purge command uses the following syntax:
Purge
<-DomainName|-dn> domain_name
<-ServiceName|-sn> service_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
The following table describes infacmd cms Purge options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set
-dn the domain name with the -dn option or the environment
variable INFA_DEFAULT_DOMAIN. If you set a domain
name with both methods, the -dn option takes
precedence.
Purge 141
Option Argument Description
-Password password Required if you specify the user name. Password for the
-pd user name. The password is case sensitive. You can set
a password with the -pd option or the environment
variable INFA_DEFAULT_DOMAIN_PASSWORD. If you set
a password with both methods, the password set with
the -pd option takes precedence.
RemoveService
Removes the Content Management Service from the domain. Before you remove the service, you must
disable it.
<-DomainName|-dn> domain_name
<-ServiceName|-sn> service_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
The following table describes infacmd cms RemoveService options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set the
-dn domain name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with both
methods, the -dn option takes precedence.
-ServiceName service_name Required. Name of the service you want to remove. To enter a
-sn name that contains a space or other non-alphanumeric character,
enclose the name in quotation marks.
-UserName user_name Required if the domain uses Native or LDAP authentication. User
-un name to connect to the domain. You can set the user name with
the -un option or the environment variable
INFA_DEFAULT_DOMAIN_USER. If you set a user name with both
methods, the -un option takes precedence.
Optional if the domain uses Kerberos authentication. To run the
command with single sign-on, do not set the user name. If you set
the user name, the command runs without single sign-on.
-Password password Required if you specify the user name. Password for the user
-pd name. The password is case sensitive. You can set a password
with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password with
both methods, the password set with the -pd option takes
precedence.
-SecurityDomain security_domain Required if the domain uses LDAP authentication. Optional if the
-sdn domain uses native authentication or Kerberos authentication.
Name of the security domain to which the domain user belongs.
You can set a security domain with the -sdn option or the
environment variable INFA_DEFAULT_SECURITY_DOMAIN. If you
set a security domain name with both methods, the -sdn option
takes precedence. The security domain name is case sensitive.
If the domain uses native or LDAP authentication, the default is
Native. If the domain uses Kerberos authentication, the default is
the LDAP security domain created during installation. The name of
the security domain is the same as the user realm specified during
installation.
RemoveService 143
ResyncData
Synchronizes probabilistic model files or classifier model files between a specified Content Management
Service machine and the master Content Management Service machine in the domain. The ResyncData
command updates the files on the Content Management Service machine that you specify with the files from
the master Content Management Service machine.
The command synchronizes any file saved on the master Content Management Service machine after a time
and date that you specify. You run the ResyncData command for a single type of model file. To synchronize
probabilistic model files and classifier model files, you must run the command twice.
When you run infacmd cms ResyncData, you must have access permissions on both Content Management
Service machines. Informatica Administrator sets the access permissions on the services.
<-DomainName|-dn> domain_name
<-ServiceName|-sn> service_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-Type|-t> type
<-StartTime|-st> start_time
The following table describes infacmd cms resyncData options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set
-dn the domain name with the -dn option or the environment
variable INFA_DEFAULT_DOMAIN. If you set a domain
name with both methods, the -dn option takes
precedence.
-Password password Required if you specify the user name. Password for the
-pd user name. The password is case sensitive. You can set
a password with the -pd option or the environment
variable INFA_DEFAULT_DOMAIN_PASSWORD. If you set
a password with both methods, the password set with
the -pd option takes precedence
.
-Type type Required. Identifies the type of data file to copy from the
-t master Content Management Service machine. Enter one
of the following options:
- NER. Specifies probabilistic model data files.
- Classifier. Specifies classifier model data files.
-StartTime start_time Required. Identifies the files to copy from the master
-st Content Management Service machine to the Content
Management Service machine that you specify in the
ServiceName property. The command does not copy any
file with a time stamp earlier than the StartTime value.
The command uses the system clock on the master
Content Management Service machine to determine the
time.
Enter the date in the default locale format.
ResyncData 145
UpdateServiceOptions
Updates the Content Management Service with options that are introduced in the current release. To view
current options, run the infacmd cms ListServiceOptions command.
<-DomainName|-dn> domain_name
<-ServiceName|-sn> service_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-Options|-o> options
The following table describes infacmd cms UpdateServiceOptions options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set
-dn the domain name with the -dn option or the environment
variable INFA_DEFAULT_DOMAIN. If you set a domain
name with both methods, the -dn option takes
precedence.
-Password password Required if you specify the user name. Password for the
-pd user name. The password is case sensitive. You can set
a password with the -pd option or the environment
variable INFA_DEFAULT_DOMAIN_PASSWORD. If you set
a password with both methods, the password set with
the -pd option takes precedence.
• Use the FileTransferOptions.TempLocation option to identify the reference data staging directory. The
Content Management Service uses the directory to stage data that it adds to a reference table.
• Use the DataServiceOptions.ReferenceDataLocation option to identify the connection to the reference
data database. The reference data database stores the values for the reference tables that you can select
in the Model repository.
• Use the DataServiceOptions.RefDataLocationSchema option to specify the schema that identifies the
reference data tables in the reference data database.
If you do not specify a reference table schema on the Content Management Service, the service uses the
schema that the database connection specifies. If you do not specify a schema on the Content
Management Service or on the database connection, the service uses the default database schema.
You can also set the options in Informatica Administrator.
Note: Establish the database and the schema that the Content Management Service will use for reference
data before you create a managed reference table.
UpdateServiceOptions 147
UpdateServiceProcessOptions
Updates options for a Content Management Service process. To view current options, run the infacmd cms
ListServiceProcessOptions command.
<-DomainName|-dn> domain_name
<-ServiceName|-sn> service_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-NodeName|-nn> node_name
<-Options|-o> options
The following table describes infacmd cms UpdateServiceProcessOptions options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set
-dn the domain name with the -dn option or the environment
variable INFA_DEFAULT_DOMAIN. If you set a domain
name with both methods, the -dn option takes
precedence.
-Password password Required if you specify the user name. Password for the
-pd user name. The password is case sensitive. You can set
a password with the -pd option or the environment
variable INFA_DEFAULT_DOMAIN_PASSWORD. If you set
a password with both methods, the password set with
the -pd option takes precedence.
NodeName node_name Required. Name of the node where the service process
-nn runs.
UpdateServiceProcessOptions 149
Upgrade
Upgrades the Content Management Service configuration. Run infacmd cms Upgrade when you upgrade to
the current version of Informatica Data Quality.
<-DomainName|-dn> domain_name
<-ServiceName|-sn> service_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
The infacmd cms Upgrade command checks the service configuration on the domain and verifies the
following service options:
The Upgrade command verifies that the Model repository in the domain uses a master Content
Management Service. If the Model Repository Service does not specify a master Content Management
Service, the Upgrade command sets the current service as the master Content Management Service . By
default, the first Content Management Service to connect to a Model Repository Service becomes the
master Content Management Service.
The Upgrade command uses the Data Integration Service associated with the Content Management
Service to identify the Model Repository Service in the domain.
The Upgrade command verifies that the Content Management Service has a valid username, password,
and security domain to connect to the Model Repository Service. If these options are not set, the
Upgrade command uses the username, password, and security domain values on the associated Data
Integration Service to connect to the Model Repository Service.
The Upgrade command verifies that the Content Management Service specifies a reference data
location. If the service does not specify a reference data location, the Upgrade command sets the
location to the staging database defined on the Analyst Service.
The following table describes infacmd cms Upgrade options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set
-dn the domain name with the -dn option or the environment
variable INFA_DEFAULT_DOMAIN. If you set a domain
name with both methods, the -dn option takes
precedence.
-Password password Required if you specify the user name. Password for the
-pd user name. The password is case sensitive. You can set
a password with the -pd option or the environment
variable INFA_DEFAULT_DOMAIN_PASSWORD. If you set
a password with both methods, the password set with
the -pd option takes precedence..
Upgrade 151
Chapter 13
• AddParameterSetEntries, 153
• BackupApplication, 155
• CancelDataObjectCacheRefresh, 156
• CreateService, 158
• compareMapping, 161
• DeleteParameterSetEntries, 164
• deployObjectsToFile, 166
• DeployApplication, 170
• disableMappingValidationEnvironment, 171
• enableMappingValidationEnvironment, 174
• ListApplicationObjectPermissions, 176
• ListApplicationObjects, 178
• ListApplicationOptions, 180
• ListApplicationPermissions, 181
• ListApplications, 183
• ListComputeOptions, 184
• ListDataObjectOptions, 186
• ListMappingEngines, 187
• ListParameterSetEntries, 190
• ListParameterSetObjects, 191
• ListParameterSets, 193
• listPatchNames, 194
• ListSequenceObjectProperties, 196
• ListSequenceObjects, 198
• ListServiceOptions, 199
• ListServiceProcessOptions, 201
• PurgeDataObjectCache, 202
• PurgeResultSetCache, 204
• queryRunTimeObjects, 206
• queryDesignTimeObjects, 207
152
• RefreshDataObjectCache, 209
• RenameApplication, 210
• replaceMappingHadoopRuntimeConnections, 212
• RestoreApplication, 214
• SetApplicationPermissions, 216
• SetApplicationObjectPermissions, 218
• setMappingExecutionEnvironment, 220
• SetSequenceState, 222
• StartApplication, 224
• StopApplication, 226
• stopBlazeService, 227
• tag, 230
• UndeployApplication, 237
• UpdateApplication, 238
• UpdateApplicationOptions, 239
• UpdateComputeOptions, 241
• UpdateDataObjectOptions, 243
• UpdateParameterSetEntries, 245
• UpdateServiceOptions , 247
• UpdateServiceProcessOptions , 259
• Queries, 262
AddParameterSetEntries
Adds entries to a parameter set. Run this command to add parameters from a mapping or workflow that has
been deployed as an application.
<-DomainName|-dn> domain_name
<-ServiceName|-sn> service_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-Application|-a> application
<-projectScope|-prs> path to the mapping or workflow that contains the parameters. For a
mapping, M1, in project P1 and folder F1, the path is P1/F1/mapping/M1.
AddParameterSetEntries 153
<-paramNameValues|-pnv> parameter name-value pairs, separated by space
The following table describes infacmd dis AddParameterSetEntries options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set the
-dn domain name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with
both methods, the -dn option takes precedence.
-ServiceName service_name Required. Name of the Data Integration Service that the
-sn application is deployed to.
-Password password Required if you specify the user name. Password for the user
-pd name. The password is case sensitive. You can set a
password with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password
with both methods, the password set with the -pd option
takes precedence.
-projectScope project scope Required. Path to the mapping or workflow that contains the
-prs parameters. For a mapping, M1, in project P1 and folder F1,
the path is P1/F1/mapping/M1.
BackupApplication
Backs up a deployed application from a Data Integration Service to an XML file.
The backup file contains all the properties settings for the application. You can restore the application to
another Data Integration Service. You must stop the application before you back it up.
<-DomainName|-dn> domain_name
<-ServiceName|-sn> service_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-Application|-a> application
<-FileName|-f> file_name
The following table describes infacmd dis BackupApplication options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set the
-dn domain name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with both
methods, the -dn option takes precedence.
-ServiceName service_name Required. Name of the Data Integration Service that the
-sn application is deployed to.
BackupApplication 155
Option Argument Description
-UserName user_name Required if the domain uses Native or LDAP authentication. User
-un name to connect to the domain. You can set the user name with
the -un option or the environment variable
INFA_DEFAULT_DOMAIN_USER. If you set a user name with both
methods, the -un option takes precedence.
Optional if the domain uses Kerberos authentication. To run the
command with single sign-on, do not set the user name. If you set
the user name, the command runs without single sign-on.
-Password password Required if you specify the user name. Password for the user
-pd name. The password is case sensitive. You can set a password
with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password with
both methods, the password set with the -pd option takes
precedence.
-SecurityDomain security_domain Required if the domain uses LDAP authentication. Optional if the
-sdn domain uses native authentication or Kerberos authentication.
Name of the security domain to which the domain user belongs.
You can set a security domain with the -sdn option or the
environment variable INFA_DEFAULT_SECURITY_DOMAIN. If you
set a security domain name with both methods, the -sdn option
takes precedence. The security domain name is case sensitive.
If the domain uses native or LDAP authentication, the default is
Native. If the domain uses Kerberos authentication, the default is
the LDAP security domain created during installation. The name of
the security domain is the same as the user realm specified during
installation.
Filename file_name Required. Name and file path of the application backup file.
-f
CancelDataObjectCacheRefresh
Stops the last request to refresh the logical data object cache. If the cache mapping is running, the command
stops the current request to refresh the logical data object cache. Future periodic requests to refresh the
logical data object cache are not affected.
<-DomainName|-dn> domain_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-ServiceName|-sn> service_name
<-Application|-a> application
<-Folder|-f> folder
<-DataObject|-do> data_model.data_object
The following table describes infacmd dis CancelDataObjectCacheRefresh options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set
-dn the domain name with the -dn option or the environment
variable INFA_DEFAULT_DOMAIN. If you set a domain
name with both methods, the -dn option takes
precedence.
-Password password Required if you specify the user name. Password for the
-pd user name. The password is case sensitive. You can set
a password with the -pd option or the environment
variable INFA_DEFAULT_DOMAIN_PASSWORD. If you set
a password with both methods, the password set with
the -pd option takes precedence.
CancelDataObjectCacheRefresh 157
Option Argument Description
-Folder folder Folder in the application that contains the data object.
-f
-DataObject data_model.data_object Required. Name of the logical data object. The name
-do must be in the following syntax:
<data_model>.<data_object>
CreateService
Creates a Data Integration Service. By default, the Data Integration Service is enabled when you create it.
<-DomainName|-dn> domain_name
<-ServiceName|-sn> service_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
[<-BackupNodes|-bn> node_name1,node_name2,...]
<-RepositoryService|-rs> model_repository_service_name
<-RepositoryUserName|-rsun> model_repository_user_name
<-RepositoryPassword|-rspd> model_repository_password
[<-RepositorySecurityDomain|-rssdn> model_repository_security_domain]
[<-HttpPort> http_port]
[<-KeystoreFile|-kf> keystore_file_location]
[<-KeystorePassword|-kp> keystore_password]
[<-httpProtocolType|-pt> http_protocol_type]
The following table describes infacmd dis CreateService options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set the
-dn domain name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with both
methods, the -dn option takes precedence.
-Password password Required if you specify the user name. Password for the user
-pd name. The password is case sensitive. You can set a password
with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password
with both methods, the password set with the -pd option takes
precedence.
CreateService 159
Option Argument Description
-NodeName node_name Required if you do not specify grid name. Node where the Data
-nn Integration Service runs. You can run the Data Integration
Service on a node or grid.
-GridName grid_name Required if you do not specify node name. Grid where the Data
-gn Integration Service runs. You can run the Data Integration
Service on a node or grid.
-BackupNodes node_name1,node Optional. Nodes on which the service can run if the primary
-bn _name2,... node is unavailable. You can configure backup nodes if you
have high availability.
-RepositorySecurityDomain model_repository_ Required if you use LDAP authentication. Name of the security
-rssdn security_domain domain that the Model repository user belongs to.
-HttpPort http_port Required if you do not specify an HTTPS port. Unique HTTP
port number used for each Data Integration Service process.
After you create the service, you can define different port
numbers for each Data Integration Service process.
Default is 8095.
-HttpsPort https_port Required if you do not specify an HTTP port. Unique HTTPS
port number used for each Data Integration Service process.
After you create the service, you can define different port
numbers for each Data Integration Service process.
-KeystoreFile keystore_file_loca Path and file name of the keystore file that contains the keys
-kf tion and certificates required if you use the HTTPS protocol for the
Data Integration Service. You can create a keystore file with a
keytool. keytool is a utility that generates and stores private or
public key pairs and associated certificates in a keystore file.
You can use the self-signed certificate or use a certificate
signed by a certificate authority.
If you run the Data Integration Service on a grid, the keystore
file on each node in the grid must contain the same keys.
-httpProtocolType http_protocol_typ Security protocol that the Data Integration Service uses. Enter
-pt e one of the following values:
- HTTP. Requests to the service must use an HTTP URL.
- HTTPS. Requests to the service must use an HTTPS URL.
- Both. Requests to the service can use either an HTTP or an
HTTPS URL.
When you set the HTTP protocol type to HTTPS or Both, you
enable Transport Layer Security (TLS) for the service.
You can also enable TLS for each web service deployed to an
application. When you enable HTTPS for the Data Integration
Service and enable TLS for the web service, the web service
uses an HTTPS URL. When you enable HTTPS for the Data
Integration Service and do not enable TLS for the web service,
the web service can use an HTTP URL or an HTTPS URL. If you
enable TLS for a web service and do not enable HTTPS for the
Data Integration Service, the web service does not start.
Default is HTTP.
compareMapping
Compares two queried mappings.
Query the mappings to compare mapping properties, transformation properties, and ports within
transformations. To query design-time mappings, specify the design-time Model repository. To query run-
time mappings, do not specify a Model repository. The query will use the Model repository associated with
the Data Integration Service that runs the request.
<-DomainName|-dn> domain_name
<-ServiceName|-sn> DIS_service_name
<-UserName|-un> DIS_user_name
<-Password|-pd> DIS_password
[<-SecurityDomain|-sdn> DIS_security_domain]
[<-sourceRepositoryService|-srcrs> source_MRS_name]
[<-sourceRepositoryUserName|-srcrsun> source_MRS_user_name]
[<-sourceRepositoryPassword|-srcrspd> source_MRS_password]
[<-sourceRepositorySecurityDomain|-srcrssdn> source_MRS_security_domain]
<-sourceQuery|-srcq> source_query
[<-targetRepositoryService|-tgtrs> target_MRS_name]
compareMapping 161
[<-targetRepositoryUserName|-tgtrsun> target_MRS_user_name]
[<-targetRepositoryPassword|-tgtrspd> target_MRS_password]
[<-targetRepositorySecurityDomain|-tgtrssdn> target_MRS_security_domain]
<-targetQuery|-tgtq> target_query
[<-TimeZone|-tz> time_zone]
The following table describes infacmd dis compareMapping options and arguments:
compareMapping 163
Option Argument Description
DeleteParameterSetEntries
Deletes entries from a parameter set. Run this command to delete parameter set entries for a mapping or
workflow that has been deployed as an application. You can delete specific parameter set entries or you can
delete all of the parameter set entries.
If any parameter that you want to delete does not exist in the parameter set, the infacmd returns a warning
message. The message indicates the parameter is not deleted because it is not in the parameter set.
<-DomainName|-dn> domain_name
<-ServiceName|-sn> service_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-Application|-a> application
The following table describes infacmd dis DeleteParameterSetEntries options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set the
-dn domain name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with
both methods, the -dn option takes precedence.
-ServiceName service_name Required. Name of the Data Integration Service that the
-sn application is deployed to.
-Password password Required if you specify the user name. Password for the user
-pd name. The password is case sensitive. You can set a
password with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password
with both methods, the password set with the -pd option
takes precedence.
DeleteParameterSetEntries 165
Option Argument Description
-projectScope project scope Required. Path to the mapping or workflow that contains the
-prs parameters. For a mapping, M1, in project P1 and folder F1,
the path is P1/F1/mapping/M1.
-paramNames parameter names Required. Parameter set entry names to delete, separated by
-pnv spaces. To delete all the parameters, use the -all option
instead of this option.
deployObjectsToFile
Deploys design-time objects to an application patch archive file.
Query the objects that you want to package in the application patch archive file. You can use the file to
perform the following tasks:
• Deploy an incremental application to a Data Integration Service for the first time by using infacmd dis
“DeployApplication” on page 170.
• Update a deployed incremental application by using infacmd tools “patchApplication” on page 1081.
• Redeploy an incremental application by using infacmd dis “UpdateApplication” on page 238.
Note: The infacmd dis deployObjectsToFile command creates an application patch archive file on any node in
a grid. You can also view the node details in the query report.
<-DomainName|-dn> domain_name
<-ServiceName|-sn> DIS_service_name
<-UserName|-un> DIS_user_name
<-Password|-pd> DIS_password
[<-SecurityDomain|-sdn> DIS_security_domain]
<-RepositoryService|-rs> MRS_service_name
<-RepositoryUserName|-rsun> MRS_user_name
<-RepositoryPassword|-rspd> MRS_password
[<-RepositorySecurityDomain|-rssdn> MRS_security_domain]
<-Query|-q> Query
[<-TimeZone|-tz> time_zone]
<-PatchName|-ptn> patch_name
<-Application|-a> application_name
[<-FilePath|-fp> DIS_file_path]
[<-OperatingSystemProfile|-osp> OSProfile_name]
[<-MappingDeploymentProperties|-mdp>
Mapping_Deployment_Property_key=value_pairs_separated_by_semicolon]
The following table describes infacmd dis deployObjectsToFile options and arguments:
deployObjectsToFile 167
Option Argument Description
% * + \ / ? ; < >
deployObjectsToFile 169
Option Argument Description
DeployApplication
Deploys an application to a Data Integration Service.
<-DomainName|-dn> domain_name
<-ServiceName|-sn> service_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-FileName|-f> file_name
<-Application|-a> application
The following table describes infacmd dis DeployApplication options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set the
-dn domain name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with
both methods, the -dn option takes precedence.
-ServiceName service_name Required. Name of the Data Integration Service that the
-sn application is deployed to.
-Password password Required if you specify the user name. Password for the user
-pd name. The password is case sensitive. You can set a
password with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password
with both methods, the password set with the -pd option
takes precedence.
disableMappingValidationEnvironment
Disables the selected mapping validation environment for mappings that are deployed to the Data Integration
Service.
Use the ValidationEnvironment parameter to disable a validation environment for a mapping. Repeat the
command for each environment that you want to remove.
disableMappingValidationEnvironment 171
Use filters to specify one or more mappings in an application. If you do not include filters, the command
updates all mappings that are deployed to the Data Integration Service. A mapping must match all specified
filters to be modified.
Changes take effect after you recycle the Data Integration Service.
Password password Required if you specify the user name. Password for
-pd the user name. The password is case sensitive. You
can set a password with the -pd option or the
environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a
password with both methods, the password set with
the -pd option takes precedence.
MappingNamesFilter mapping names Optional. The names of mappings that you want to
-mnf disable the validation environment for. Separate
mapping names with commas.
Default is all mappings that are deployed to the Data
Integration Service.
disableMappingValidationEnvironment 173
enableMappingValidationEnvironment
Enables a mapping validation environment for mappings that are deployed to the Data Integration Service.
The mapping validation environment properties indicate the engines that the mapping will be validated to run
in.
Use the ValidationEnvironment parameter to specify a validation environment. Repeat the command and
specify a different validation environment to enable an additional validation environment for the mapping.
Use filters to specify one or more mappings in an application or all applications that are deployed to a Data
Integration Service. If you do not include filters, the command updates all mappings that are deployed to the
Data Integration Service. A mapping must match all specified filters to be modified.
Changes take effect after you recycle the Data Integration Service.
Password password Required if you specify the user name. Password for
-pd the user name. The password is case sensitive. You
can set a password with the -pd option or the
environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a
password with both methods, the password set with
the -pd option takes precedence.
MappingNamesFilter mapping names Optional. The names of mappings that you want to
-mnf enable the validation environment for. Separate
mapping names with commas.
Default is all mappings that are deployed to the Data
Integration Service.
enableMappingValidationEnvironment 175
Option Argument Description
ListApplicationObjectPermissions
Lists the permissions that a user or group has for an application object such as mapping or workflow.
<-DomainName|-dn> domain_name
<-ServiceName|-sn> service_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-Application|-a> application_name
<-ApplicationObjectType|-t> application_object_type_Mapping_Workflow
<-ApplicationObject|-ao> application_object_name
-DomainName domain_name Required. Name of the Informatica domain. You can set the
-dn domain name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with both
methods, the -dn option takes precedence.
-ServiceName service_name Required. Name of the Data Integration Service where the
-sn application is deployed.
-Password password Required if you specify the user name. Password for the user
-pd name. The password is case sensitive. You can set a
password with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password
with both methods, the password set with the -pd option
takes precedence.
ListApplicationObjectPermissions 177
Option Argument Description
-Direct | direct | effective Required. Level of permissions to list. Direct permissions are
-Effective permissions assigned directly to the user or group. Effective
permissions include direct permissions and inherited
permissions.
ListApplicationObjects
Lists the objects that an application contains.
When you use the -ListObjectTypes option, the command also lists the type of each object.
-DomainName domain_name Optional. Name of the Informatica domain. You can set
-dn the domain name with the -dn option or the environment
variable INFA_DEFAULT_DOMAIN. If you set a domain
name with both methods, the -dn option takes
precedence.
-ServiceName service_name Required. Name of the Data Integration Service that the
-sn application is deployed to.
-Password password Required if you specify the user name. Password for the
-pd user name. The password is case sensitive. You can set
a password with the -pd option or the environment
variable INFA_DEFAULT_DOMAIN_PASSWORD. If you set
a password with both methods, the password set with
the -pd option takes precedence.
ListApplicationObjects 179
Option Argument Description
-PageSize page_size Required when you specify the PageIndex option. The
-ps number of results to display in each group. When you
specify a page size, you organize command results in
groups. For example, if you specify -PageSize 5, then
the command returns results in groups of five or fewer.
-PageIndex page_index Optional. Starting with zero, the number of page results
-pi to display. For example, if you specify -PageSize 5 -
PageIndex 0, then the command returns the first page
of five results, results one through five.
If you omit this option, the command returns the first
PageSize of results. Default is zero.
ListApplicationOptions
Lists the properties for an application.
<-DomainName|-dn> domain_name
<-ServiceName|-sn> service_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-Application|-a> application
The following table describes infacmd dis ListApplicationOptions options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set
-dn the domain name with the -dn option or the environment
variable INFA_DEFAULT_DOMAIN. If you set a domain
name with both methods, the -dn option takes
precedence.
-ServiceName service_name Required. Name of the Data Integration Service that the
-sn application is deployed to.
-Password password Required if you specify the user name. Password for the
-pd user name. The password is case sensitive. You can set
a password with the -pd option or the environment
variable INFA_DEFAULT_DOMAIN_PASSWORD. If you set
a password with both methods, the password set with
the -pd option takes precedence.
ListApplicationPermissions
Lists the permissions that a user or group has for an application.
<-DomainName|-dn> domain_name
ListApplicationPermissions 181
<-ServiceName|-sn> service_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-Application|-a> application_name
-DomainName domain_name Required. Name of the Informatica domain. You can set the
-dn domain name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with both
methods, the -dn option takes precedence.
-ServiceName service_name Required. Name of the Data Integration Service where the
-sn application is deployed.
-UserName user_name Required if the domain uses Native or LDAP authentication. User
-un name to connect to the domain. You can set the user name with
the -un option or the environment variable
INFA_DEFAULT_DOMAIN_USER. If you set a user name with both
methods, the -un option takes precedence.
Optional if the domain uses Kerberos authentication. To run the
command with single sign-on, do not set the user name. If you set
the user name, the command runs without single sign-on.
-Password password Required if you specify the user name. Password for the user
-pd name. The password is case sensitive. You can set a password
with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password with
both methods, the password set with the -pd option takes
precedence.
-SecurityDomain security_domain Required if the domain uses LDAP authentication. Optional if the
-sdn domain uses native authentication or Kerberos authentication.
Name of the security domain to which the domain user belongs.
You can set a security domain with the -sdn option or the
environment variable INFA_DEFAULT_SECURITY_DOMAIN. If you
set a security domain name with both methods, the -sdn option
takes precedence. The security domain name is case sensitive.
If the domain uses native or LDAP authentication, the default is
Native. If the domain uses Kerberos authentication, the default is
the LDAP security domain created during installation. The name
of the security domain is the same as the user realm specified
during installation.
-Direct | direct | effective Required. Level of permissions to list. Direct permissions are
-Effective permissions assigned directly to the user or group. Effective
permissions include direct permissions and inherited
permissions.
ListApplications
Lists the applications that are deployed to a Data Integration Service.
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-ServiceName|-sn> service_name
The following table describes infacmd dis ListApplications options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set
-dn the domain name with the -dn option or the environment
variable INFA_DEFAULT_DOMAIN. If you set a domain
name with both methods, the -dn option takes
precedence.
ListApplications 183
Option Argument Description
-Password password Required if you specify the user name. Password for the
-pd user name. The password is case sensitive. You can set a
password with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a
password with both methods, the password set with the -
pd option takes precedence.
-ServiceName service_name Required. Name of the Data Integration Service for which
-sn to list applications.
ListComputeOptions
List Data Integration Service properties for a node with the compute role.
<-DomainName|-dn> domain_name
<-ServiceName|-sn> service_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-NodeName|-nn> node_name
-DomainName domain_name Required. Name of the Informatica domain. You can set
-dn the domain name with the -dn option or the environment
variable INFA_DEFAULT_DOMAIN. If you set a domain
name with both methods, the -dn option takes
precedence.
-Password password Required if you specify the user name. Password for the
-pd user name. The password is case sensitive. You can set
a password with the -pd option or the environment
variable INFA_DEFAULT_DOMAIN_PASSWORD. If you set
a password with both methods, the password set with
the -pd option takes precedence.
NodeName node_name Required. Node with the compute role that is assigned to
-nn the Data Integration Service or to the Data Integration
Service grid.
ListComputeOptions 185
ListDataObjectOptions
Lists properties of a data object.
<-DomainName|-dn> domain_name
<-ServiceName|-sn> service_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-Application|-a> application
<-Folder|-f> folder
<-DataObject|-do> data_model.data_object
The following table describes infacmd dis ListDataObjectOptions options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set
-dn the domain name with the -dn option or the environment
variable INFA_DEFAULT_DOMAIN. If you set a domain
name with both methods, the -dn option takes
precedence.
-Password password Required if you specify the user name. Password for the
-pd user name. The password is case sensitive. You can set
a password with the -pd option or the environment
variable INFA_DEFAULT_DOMAIN_PASSWORD. If you set
a password with both methods, the password set with
the -pd option takes precedence.
ListMappingEngines
Lists the execution engines of the mappings deployed to a Data Integration Service. You can filter the results
based on the application, validation environment, execution environment, and execution environment
parameters. If you do not specify any filters, the command lists the execution engines of all deployed
mappings.
<-DomainName|-dn> domain_name
<-ServiceName|-sn> service_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-ProjectName|-pn> project_name]
[<-SecurityDomain|-sdn> security_domain]
ListMappingEngines 187
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
[<-Application|-a> application_name]
[<-ValidationEnvironmentFilter|-vef> validation_environment_name]
[<-ExecutionEnvironmentFilter|-eef> execution_environment_name]
[<-ExecutionEnvironmentParamNameFilter|-pnf> execution_environment_parameter_name]
The following table describes infacmd dis listMappingEngines options and arguments:
ListMappingEngines 189
ListParameterSetEntries
Lists the entries in a parameter set.
<-DomainName|-dn> domain_name
<-ServiceName|-sn> service_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-Application|-a> application
<-projectScope|-prs> path to the mapping or workflow that contains the parameters. For a
mapping, M1, in project P1 and folder F1, the path is P1/F1/mapping/M1.
The following table describes infacmd dis ListParameterSetEntries options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set the
-dn domain name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with
both methods, the -dn option takes precedence.
-ServiceName service_name Required. Name of the Data Integration Service that the
-sn application is deployed to.
-Password password Required if you specify the user name. Password for the user
-pd name. The password is case sensitive. You can set a
password with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password
with both methods, the password set with the -pd option
takes precedence.
-projectScope project scope Required. Path to the mapping or workflow that contains the
-prs parameters. For a mapping, M1, in project P1 and folder F1,
the path is P1/F1/mapping/M1.
ListParameterSetObjects
List the objects in a specific parameter set.
<-DomainName|-dn> domain_name
<-ServiceName|-sn> service_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
ListParameterSetObjects 191
The following table describes infacmd dis ListParameterSetObjects options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set the
-dn domain name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with
both methods, the -dn option takes precedence.
-ServiceName service_name Required. Name of the Data Integration Service that the
-sn application is deployed to.
-Password password Required if you specify the user name. Password for the user
-pd name. The password is case sensitive. You can set a
password with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password
with both methods, the password set with the -pd option
takes precedence.
-parameterset parameter set Required. The name of the parameter set that you want to
-ps view.
<-DomainName|-dn> domain_name
<-ServiceName|-sn> service_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-Application|-a> application
The following table describes infacmd dis ListParameterSets options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set the
-dn domain name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with
both methods, the -dn option takes precedence.
-ServiceName service_name Required. Name of the Data Integration Service that the
-sn application is deployed to.
-Password password Required if you specify the user name. Password for the user
-pd name. The password is case sensitive. You can set a
password with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password
with both methods, the password set with the -pd option
takes precedence.
ListParameterSets 193
Option Argument Description
listPatchNames
Lists all patches that have been applied to an incremental application.
<-DomainName|-dn> domain_name
<-ServiceName|-sn> service_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilientTimeout|-re> timeout_period_in_seconds]
<-Application|-a> application_name
-DomainName domain_name Required. Name of the Informatica domain. You can set
-dn the domain name with the -dn option or the environment
variable INFA_DEFAULT_DOMAIN. If you set a domain
name with both methods, the -dn option takes
precedence.
-Password password Required if you specify the user name. Password for the
-pd user name. The password is case sensitive. You can set a
password with the -dpd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a
password with both methods, the password set with the -
pd option takes precedence.
listPatchNames 195
ListSequenceObjectProperties
Lists the properties for a sequence data object.
-DomainName domain_name Required. Name of the Informatica domain. You can set
-dn the domain name with the -dn option or the environment
variable INFA_DEFAULT_DOMAIN. If you set a domain
name with both methods, the -dn option takes
precedence.
-Password password Required if you specify the user name. Password for the
-pd user name. The password is case sensitive. You can set
a password with the -pd option or the environment
variable INFA_DEFAULT_DOMAIN_PASSWORD. If you set
a password with both methods, the password set with
the -pd option takes precedence.
-SequenceObjectPath sequence object path Required. Path to the sequence data object. The path
-sop must include the following objects, in order, and where
applicable:
- Project
- Folders
- SQL data service or web service
- Mapping
- Sequence Generator transformation
- Sequence data object
If the sequence data object is in a mapping, SQL data
service, or web service, you must use a prefix before the
mapping name, SQL data service name, or web service
name. Use the following prefixes with options in the
command:
- Mapping:<mapping name>
- SQLDS:<SQL data service name>
- WS:<web service name>
Separate the options with a slash (/). For example:
<project name>/<folder>/SQLDS:<SQL Data
Service Name>/Mapping:<virtual table
mapping>/<Sequence Generator
transformation>/<sequence data object name>
ListSequenceObjectProperties 197
ListSequenceObjects
Lists the sequence data objects deployed to an application.
-DomainName domain_name Required. Name of the Informatica domain. You can set
-dn the domain name with the -dn option or the environment
variable INFA_DEFAULT_DOMAIN. If you set a domain
name with both methods, the -dn option takes
precedence.
-Password password Required if you specify the user name. Password for the
-pd user name. The password is case sensitive. You can set
a password with the -pd option or the environment
variable INFA_DEFAULT_DOMAIN_PASSWORD. If you set
a password with both methods, the password set with
the -pd option takes precedence.
ListServiceOptions
Lists the properties for a Data Integration Service.
<-DomainName|-dn> domain_name
<-ServiceName|-sn> service_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
ListServiceOptions 199
The following table describes infacmd dis ListServiceOptions options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set
-dn the domain name with the -dn option or the environment
variable INFA_DEFAULT_DOMAIN. If you set a domain
name with both methods, the -dn option takes
precedence.
-Password password Required if you specify the user name. Password for the
-pd user name. The password is case sensitive. You can set
a password with the -pd option or the environment
variable INFA_DEFAULT_DOMAIN_PASSWORD. If you set
a password with both methods, the password set with
the -pd option takes precedence.
<-DomainName|-dn> domain_name
<-ServiceName|-sn> service_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-NodeName|-nn> node_name
The following table describes infacmd dis ListServiceProcessOptions options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set
-dn the domain name with the -dn option or the environment
variable INFA_DEFAULT_DOMAIN. If you set a domain
name with both methods, the -dn option takes
precedence.
-Password password Required if you specify the user name. Password for the
-pd user name. The password is case sensitive. You can set
a password with the -pd option or the environment
variable INFA_DEFAULT_DOMAIN_PASSWORD. If you set
a password with both methods, the password set with
the -pd option takes precedence.
ListServiceProcessOptions 201
Option Argument Description
-NodeName node_name Required. Name of node where the service process runs.
-nn
PurgeDataObjectCache
Purges the cache for a logical data object. If caching for logical data objects is enabled, this command
deletes all cache for a logical data object except the latest cache run. If the latest cache run is older than the
time set in the Cache Refresh Period property, the latest cache run is also deleted. If caching for logical data
objects is not enabled, this command deletes all cache for the logical data object.
You must disable the application for a logical data object before you purge the data object cache.
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-ServiceName|-sn> service_name
<-Application|-a> application
<-DataObject|-do> data_model.data_object
[<-PurgeAll|-pa> true|false]
The following table describes infacmd dis PurgeDataObjectCache options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set
-dn the domain name with the -dn option or the environment
variable INFA_DEFAULT_DOMAIN. If you set a domain
name with both methods, the -dn option takes
precedence.
-Password password Required if you specify the user name. Password for the
-pd user name. The password is case sensitive. You can set
a password with the -pd option or the environment
variable INFA_DEFAULT_DOMAIN_PASSWORD. If you set
a password with both methods, the password set with
the -pd option takes precedence.
-ServiceName service_name Required. Name of the Data Integration Service that the
-sn application is deployed to.
PurgeDataObjectCache 203
Option Argument Description
Application application Name of the application that contains the data object.
-a
Folder folder Name of the folder that contains the data object model.
-f
DataObject data_model.data_object Name of the data object with the cache you need to
-do purge.
-PurgeAll true | false Optional. Deletes all cache for a logical data object.
-pa
PurgeResultSetCache
Purges the result set caches for an application. You can purge the cache for an application when you do not
need the existing result set caches for the SQL data services and the web services in the application.
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-ServiceName|-sn> service_name
<-Application|-a> application
-DomainName domain_name Required. Name of the Informatica domain. You can set
-dn the domain name with the -dn option or the environment
variable INFA_DEFAULT_DOMAIN. If you set a domain
name with both methods, the -dn option takes
precedence.
-Password password Required if you specify the user name. Password for the
-pd user name. The password is case sensitive. You can set
a password with the -pd option or the environment
variable INFA_DEFAULT_DOMAIN_PASSWORD. If you set
a password with both methods, the password set with
the -pd option takes precedence.
-ServiceName service_name Required. Name of the Data Integration Service that the
-sn application is deployed to.
Application application Name of the application that you want to purge the result
-a set cache for.
PurgeResultSetCache 205
queryRunTimeObjects
Queries run-time objects that are deployed to a Data Integration Service and returns a list of the objects.
<-DomainName|-dn> domain_name
<-ServiceName|-sn> service_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
<-Query|-q> query
The following table describes infacmd dis queryRunTimeObjects options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set
-dn the domain name with the -dn option or the environment
variable INFA_DEFAULT_DOMAIN. If you set a domain
name with both methods, the -dn option takes
precedence.
-Password password Required if you specify the user name. Password for the
-pd user name. The password is case sensitive. You can set a
password with the -dpd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a
password with both methods, the password set with the -
pd option takes precedence.
-Query query Required. A string that queries the object. For more
-q information, see “Queries” on page 262 .
<-DomainName|-dn> domain_name
<-ServiceName|-sn> DIS_service_name
<-UserName|-un> DIS_user_name
<-Password|-pd> DIS_password
[<-SecurityDomain|-sdn> DIS_security_domain]
<-RepositoryService|-rs> MRS_service_name
<-RepositoryUserName|-rsun> MRS_user_name
<-RepositoryPassword|-rspd> MRS_password
[<-RepositorySecurityDomain|-rssdn> MRS_security_domain]
<-Query|-q> Query
[<-TimeZone|-tz> time_zone]
The following table describes infacmd dis queryDesignTimeObjects options and arguments:
queryDesignTimeObjects 207
Option Argument Description
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-ServiceName|-sn> service_name
<-Application|-a> application
<-Folder|-f> folder
<-DataObject|-do> data_model.data_object
The following table describes infacmd dis RefreshDataObjectCache options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set
-dn the domain name with the -dn option or the environment
variable INFA_DEFAULT_DOMAIN. If you set a domain
name with both methods, the -dn option takes
precedence.
-Password password Required if you specify the user name. Password for the
-pd user name. The password is case sensitive. You can set
a password with the -pd option or the environment
variable INFA_DEFAULT_DOMAIN_PASSWORD. If you set
a password with both methods, the password set with
the -pd option takes precedence.
RefreshDataObjectCache 209
Option Argument Description
-ServiceName service_name Required. Name of the Data Integration Service that you
-sn want to list the applications for.
-Application application Required. Name of the application that contains the data
-a object.
-Folder folder Required. Name of the folder that contains the data
-f object.
-DataObject data_model.data_object Required. Name of the data object that has cache to
-do refresh.
RenameApplication
Renames a deployed application. Before you rename an application, run infacmd dis StopApplication to stop
it.
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-Application|-a> application
<-NewName|-n> new_name
The following table describes infacmd dis RenameApplication options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set
-dn the domain name with the -dn option or the environment
variable INFA_DEFAULT_DOMAIN. If you set a domain
name with both methods, the -dn option takes
precedence.
-Password password Required if you specify the user name. Password for the
-pd user name. The password is case sensitive. You can set
a password with the -pd option or the environment
variable INFA_DEFAULT_DOMAIN_PASSWORD. If you set
a password with both methods, the password set with
the -pd option takes precedence.
RenameApplication 211
Option Argument Description
replaceMappingHadoopRuntimeConnections
Replaces the Hadoop connection of all mappings in deployed applications with another Hadoop connection.
The Data Integration Service uses the Hadoop connection to connect to the Hadoop cluster to run mappings
in the Hadoop environment.
The command does not modify Hadoop connections in the transformations. You can specify the application
name to replace the Hadoop connection of an application.
replaceMappingHadoopRuntimeConnections
<-DomainName|-dn> domain_name
<-ServiceName|-sn> service_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
[<-ApplicationName|-an> application_name]
<-OldConnectionName|-oc> connection_name_of_old_connection_to_replace
<-NewConnectionName|-nc> connection_name_of_new_connection
The following table describes the replaceMappingHadoopRuntimeConnections options and arguments:
replaceMappingHadoopRuntimeConnections 213
Option Argument Description
RestoreApplication
Restores an application from a backup file. When you deploy a restored application, the application state
depends on the default deployment mode. The application properties are retained in the restored application.
<-DomainName|-dn> domain_name
<-ServiceName|-sn> service_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-FileName|-f> file_name
[<-Application|-a> application]
The following table describes infacmd dis RestoreApplication options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set
-dn the domain name with the -dn option or the environment
variable INFA_DEFAULT_DOMAIN. If you set a domain
name with both methods, the -dn option takes
precedence.
-Password password Required if you specify the user name. Password for the
-pd user name. The password is case sensitive. You can set
a password with the -pd option or the environment
variable INFA_DEFAULT_DOMAIN_PASSWORD. If you set
a password with both methods, the password set with
the -pd option takes precedence.
-Application application Optional. Name of the application after after you deploy
-a it. If there is a name conflict, the deploy fails.
RestoreApplication 215
SetApplicationPermissions
Assigns or denies permissions on an application to a user or a group.
You can allow or deny permissions to users with the -ap or -dp options of the SetApplicationPermissions
command. If you do not explicitly allow or deny permissions using one of the options, all permissions on the
application are revoked.
<-DomainName|-dn> domain_name
<-ServiceName|-sn> service_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-Application|-a> application_name
[<-GranteeSecurityDomain|-gsdn> grantee_security_domain]
[<-AllowedPermissions|-ap> allowed_permissions]
[<-DeniedPermissions|-dp> denied_permissions]
The following table describes infacmd dis SetApplicationPermissions options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set the
-dn domain name with the -dn option or the environment
variable INFA_DEFAULT_DOMAIN. If you set a domain name
with both methods, the -dn option takes precedence.
-ServiceName service_name Required. Name of the Data Integration Service where the
-sn application is deployed.
-Password password Required if you specify the user name. Password for the
-pd user name. The password is case sensitive. You can set a
password with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a
password with both methods, the password set with the -pd
option takes precedence.
-GranteeSecurityDomain grantee_security_domain Required if you use LDAP authentication and you are
-gsdn granting user permissions. Name of the security domain
that the user belongs to.
SetApplicationPermissions 217
SetApplicationObjectPermissions
Assigns or denies permissions on an application object such as mapping or workflow to a user or a group.
You can allow or deny permissions to users with the -ap or -dp options of the
SetApplicationObjectPermissions command. If you do not explicitly allow or deny permissions using one of
the options, the user inherits the application-level permission on the mapping or the workflow.
<-DomainName|-dn> domain_name
<-ServiceName|-sn> service_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-Application|-a> application_name
<-ApplicationObjectType|-t> application_object_type_Mapping_Workflow
<-ApplicationObject|-ao> application_object_name
[<-GranteeSecurityDomain|-gsdn> grantee_security_domain]
[<-AllowedPermissions|-ap> allowed_permissions]
[<-DeniedPermissions|-dp> denied_permissions]
The following table describes infacmd dis SetApplicationObjectPermissions options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set the
-dn domain name with the -dn option or the environment
variable INFA_DEFAULT_DOMAIN. If you set a domain name
with both methods, the -dn option takes precedence.
-ServiceName service_name Required. Name of the Data Integration Service where the
-sn application is deployed.
-Password password Required if you specify the user name. Password for the
-pd user name. The password is case sensitive. You can set a
password with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a
password with both methods, the password set with the -pd
option takes precedence.
-GranteeSecurityDomain grantee_security_domain Required if you use LDAP authentication and you are
-gsdn granting user permissions. Name of the security domain
that the user belongs to.
SetApplicationObjectPermissions 219
Option Argument Description
setMappingExecutionEnvironment
Specifies the mapping execution environment for mappings that are deployed to the Data Integration Service.
Use filters to specify a list of mappings, all mappings in an application, or all applications that are deployed
to a Data Integration Service. If you do not include filters, the command updates all mappings that are
deployed to the Data Integration Service. A mapping must match all specified filters to be modified.
Changes take effect after you recycle the Data Integration Service.
Password password Required if you specify the user name. Password for
-pd the user name. The password is case sensitive. You
can set a password with the -pd option or the
environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a
password with both methods, the password set with
the -pd option takes precedence.
MappingNamesFilter mapping names Optional. The names of mappings that you want to
-mnf set the execution environment for. Separate
mapping names with commas.
Default is all mappings that are deployed to the
Data Integration Service.
setMappingExecutionEnvironment 221
Option Argument Description
SetSequenceState
Updates the current value of a sequence data object.
<-DomainName|-dn> domain_name
<-ServiceName|-sn> service_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-Application|-a> application
<-SequenceObjectPath|-sop> sequence_object_path
<-SequenceValue|-sv> sequence_value
-DomainName domain_name Required. Name of the Informatica domain. You can set
-dn the domain name with the -dn option or the environment
variable INFA_DEFAULT_DOMAIN. If you set a domain
name with both methods, the -dn option takes
precedence.
-Password password Required if you specify the user name. Password for the
-pd user name. The password is case sensitive. You can set
a password with the -pd option or the environment
variable INFA_DEFAULT_DOMAIN_PASSWORD. If you set
a password with both methods, the password set with
the -pd option takes precedence.
SetSequenceState 223
Option Argument Description
-SequenceObjectPath sequence object path Required. Path to the sequence data object. The path
-sop can include the following objects, in order, and where
applicable:
- Project
- Folders
- SQL data service or web service
- Mapping
- Sequence Generator transformation
- Sequence data object
To update a reusable sequence data object, specify the
path using only the project, folders, and sequence data
object.
To update a non-reusable sequence data object that is in
a mapping, SQL data service, or web service, use a prefix
before the mapping name, SQL data service name, or
web service name. Use the following prefixes with
options in the command:
- Mapping:<mapping name>
- SQLDS:<SQL data service name>
- WS:<web service name>
Separate the options with a slash (/). For example:
<project name>/<folder>/SQLDS:<SQL Data
Service Name>/Mapping:<virtual table
mapping>/<Sequence Generator
transformation>/<sequence data object name>
-SequenceValue sequence_value Required. The new value for sequence data object. Enter
-sv a value that is greater than or equal to the start value of
the sequence data object and less than or equal to the
end value.
StartApplication
Starts a deployed application. You must enable the application before you can start it. The Data Integration
Service must be running.
<-DomainName|-dn> domain_name
<-ServiceName|-sn> service_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
<-Application|-a> application
The following table describes infacmd dis StartApplication options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set
-dn the domain name with the -dn option or the environment
variable INFA_DEFAULT_DOMAIN. If you set a domain
name with both methods, the -dn option takes
precedence.
-ServiceName service_name Required. Name of the Data Integration Service that the
-sn application is deployed to.
-Password password Required if you specify the user name. Password for the
-pd user name. The password is case sensitive. You can set
a password with the -pd option or the environment
variable INFA_DEFAULT_DOMAIN_PASSWORD. If you set
a password with both methods, the password set with
the -pd option takes precedence.
StartApplication 225
Option Argument Description
StopApplication
Stops an application from running. You might stop an application if you need to back it up or if you want to
prevent users from accessing it.
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-ServiceName|-sn> service_name
<-Application|-a> application
The following table describes infacmd dis StopApplication options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set
-dn the domain name with the -dn option or the environment
variable INFA_DEFAULT_DOMAIN. If you set a domain
name with both methods, the -dn option takes
precedence.
-Password password Required if you specify the user name. Password for the
-pd user name. The password is case sensitive. You can set
a password with the -pd option or the environment
variable INFA_DEFAULT_DOMAIN_PASSWORD. If you set
a password with both methods, the password set with
the -pd option takes precedence.
stopBlazeService
Stops the components of the Blaze engine from running. You might stop the Blaze engine components from
running if you want to perform maintenance on the Hadoop cluster such as cleaning up resources or applying
software patches.
<-DomainName|-dn> domain_name
<-ServiceName|-sn> service_name
<-UserName|-un> user_name
<-Password|-pd> password
stopBlazeService 227
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-HadoopConnection|-hc> Hadoop_Cluster_Connection_Name
The following table describes infacmd dis stopBlazeService options and arguments:
Note: When you run the stopBlazeService command, some component logs might not be written to aggregate
log files on HDFS. You can view the logs in the directory configured for the Blaze engine logs based on the
following Blaze advanced property in the Hadoop connection: infagrid.node.local.root.log.dir
stopBlazeService 229
tag
Assigns tags to design-time objects.
Tags are metadata that defines an object in the Model Repository service. Query the objects and specify the
tags to group objects according to their business usage. If you reassign a tag to an object, the command will
overwrite the existing tag.
<-ServiceName|-sn> DIS_service_name
<-UserName|-un> DIS_user_name
<-Password|-pd> DIS_password
[<-SecurityDomain|-sdn> DIS_security_domain]
<-RepositoryService|-rs> MRS_service_name
<-RepositoryUserName|-rsun> MRS_user_name
<-RepositoryPassword|-rspd> MRS_password
[<-RepositorySecurityDomain|-rssdn> MRS_security_domain]
<-Query|-q> Query
<-TagName|-tn> tag_name
[<-TagDescription|-td> tag_description]
[<-TimeZone|-tz> time_zone]
The following table describes infacmd dis tag options and arguments:
tag 231
Option Argument Description
untag
Removes tags from design-time objects.
If business usage has changed, remove tags to ungroup objects. Query the objects and specify the tags to
remove.
<-ServiceName|-sn> DIS_service_name
<-UserName|-un> DIS_user_name
<-Password|-pd> DIS_password
[<-SecurityDomain|-sdn> DIS_security_domain]
<-RepositoryService|-rs> MRS_service_name
<-RepositoryUserName|-rsun> MRS_user_name
<-RepositoryPassword|-rspd> MRS_password
[<-RepositorySecurityDomain|-rssdn> MRS_security_domain]
<-Query|-q> Query
<-TagName|-tn> tag_name
[<-TimeZone|-tz> time_zone]
tag 233
Option Argument Description
replaceAllTag
Replaces all tags that are assigned to design-time objects.
Query the objects and replace the assigned tags. If the business usage has changed, you can use the
command to ungroup objects and assign new tags to regroup objects. All assigned tags are deleted and
replaced with the specified tag.
<-ServiceName|-sn> DIS_service_name
<-UserName|-un> DIS_user_name
<-Password|-pd> DIS_password
[<-SecurityDomain|-sdn> DIS_security_domain]
<-RepositoryUserName|-rsun> MRS_user_name
<-RepositoryPassword|-rspd> MRS_password
[<-RepositorySecurityDomain|-rssdn> MRS_security_domain]
<-Query|-q> Query
<-TagName|-tn> tag_name
[<-TagDescription|-td> tag_description]
[<-TimeZone|-tz> time_zone]
The following table describes infacmd dis replaceAllTag options and arguments:
tag 235
Option Argument Description
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-ServiceName|-sn> service_name
<-Application|-a> application
The following table describes infacmd dis UndeployApplication options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set the
-dn domain name with the -un option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with both
methods, the -dn option takes precedence.
-Password password Required if you specify the user name. Password for the user
-pd name. The password is case sensitive. You can set a
password with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password
with both methods, the password set with the -pd option
takes precedence.
UndeployApplication 237
Option Argument Description
-ServiceName service_name Required. Name of the Data Integration Service to remove the
-sn application from.
-Application application Required. Name of the application to remove from the Data
-a Integration Service.
UpdateApplication
Updates an application from an application file and maintains the configuration. The application must be
deployed to a Data Integration Service. End users can access the latest version of the application.
<-DomainName|-dn> domain_name
<-ServiceName|-sn> service_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-FileName|-f> file_name
[<-Application|-a> application]
The following table describes infacmd dis UpdateApplication options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set
-dn the domain name with the -dn option or the environment
variable INFA_DEFAULT_DOMAIN. If you set a domain
name with both methods, the -dn option takes
precedence.
-Password password Required if you specify the user name. Password for the
-pd user name. The password is case sensitive. You can set
a password with the -pd option or the environment
variable INFA_DEFAULT_DOMAIN_PASSWORD. If you set
a password with both methods, the password set with
the -pd option takes precedence.
UpdateApplicationOptions
Updates application properties.
Separate each option and value with a space. To view current properties, run infacmd dis
ListApplicationOptions.
UpdateApplicationOptions 239
Enter connection options in the following format:
... -o option_name=value option_name=value ...
Separate multiple options with a space. To enter a value that contains a space or other non-alphanumeric
character, enclose the value in quotation marks.
<-DomainName|-dn> domain_name
<-ServiceName|-sn> service_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-Application|-a> application
<-Options|-o> options
The following table describes infacmd dis UpdateApplicationOptions options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set
-dn the domain name with the -dn option or the environment
variable INFA_DEFAULT_DOMAIN. If you set a domain
name with both methods, the -dn option takes
precedence.
-ServiceName service_name Required. Name of the Data Integration Service that the
-sn application is deployed to.
-Password password Required if you specify the user name. Password for the
-pd user name. The password is case sensitive. You can set
a password with the -pd option or the environment
variable INFA_DEFAULT_DOMAIN_PASSWORD. If you set
a password with both methods, the password set with
the -pd option takes precedence.
UpdateComputeOptions
Updates Data Integration Service properties for a node with the compute role. Use the command to override
Data Integration Service properties for a specific compute node.
<-DomainName|-dn> domain_name
<-ServiceName|-sn> service_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
UpdateComputeOptions 241
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-NodeName|-nn> node_name
<-Options|-o> options
The following table describes infacmd dis UpdateComputeOptions options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set
-dn the domain name with the -dn option or the environment
variable INFA_DEFAULT_DOMAIN. If you set a domain
name with both methods, the -dn option takes
precedence.
-Password password Required if you specify the user name. Password for the
-pd user name. The password is case sensitive. You can set
a password with the -pd option or the environment
variable INFA_DEFAULT_DOMAIN_PASSWORD. If you set
a password with both methods, the password set with
the -pd option takes precedence.
NodeName node_name Required. Node with the compute role that is assigned to
-nn the Data Integration Service or to the Data Integration
Service grid.
UpdateDataObjectOptions
Updates data object properties. To view the current options, run the infacmd dis ListDataObjectOptions
command.
<-DomainName|-dn> domain_name
<-ServiceName|-sn> service_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-Application|-a> application
<-Folder|-f> folder
<-DataObject|-do> data_model.data_object
<-Options|-o> options
UpdateDataObjectOptions 243
The following table describes infacmd dis UpdateDataObjectOptions options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set
-dn the domain name with the -dn option or the environment
variable INFA_DEFAULT_DOMAIN. If you set a domain
name with both methods, the -dn option takes
precedence.
-ServiceName service_name Required. Name of the Data Integration Service that the
-sn application is deployed to.
-Password password Required if you specify the user name. Password for the
-pd user name. The password is case sensitive. You can set
a password with the -pd option or the environment
variable INFA_DEFAULT_DOMAIN_PASSWORD. If you set
a password with both methods, the password set with
the -pd option takes precedence.
-Folder Folder Required. Name of the folder that contains the data
-f object model.
-DataObject data_model.data_object Required. Name of the data object that you want to
-do update.
Option Description
DataObjectOptions.CachingEnabled Cache the logical data object in the data object cache database. True or
false. Default is true.
DataObjectOptions.CacheTableName The name of the user-managed table from which the Data Integration
Service accesses the logical data object cache. A user-managed cache
table is a table in the data object cache database that you create, populate,
and manually refresh when needed.
If you specify a cache table name, the Data Object Cache Manager does not
manage the cache for the object and ignores the cache refresh period. If
you do not specify a cache table name, the Data Object Cache Manager
manages the cache for the object.
UpdateParameterSetEntries
Updates entries from a parameter set. Run this command to update the values in parameter set entries for a
mapping or workflow in an application.
<-DomainName|-dn> domain_name
<-ServiceName|-sn> service_name
<-UserName|-un> user_name
<-Password|-pd> password
UpdateParameterSetEntries 245
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-Application|-a> application
<-projectScope|-prs> path to the mapping or workflow that contains the parameters. For a
mapping, M1, in project P1 and folder F1, the path is P1/F1/mapping/M1.
-DomainName domain_name Required. Name of the Informatica domain. You can set the
-dn domain name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with
both methods, the -dn option takes precedence.
-ServiceName service_name Required. Name of the Data Integration Service that the
-sn application is deployed to.
-Password password Required if you specify the user name. Password for the user
-pd name. The password is case sensitive. You can set a
password with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password
with both methods, the password set with the -pd option
takes precedence.
-projectScope project scope Required. Path to the mapping or workflow that contains the
-prs parameters. For a mapping, M1, in project P1 and folder F1,
the path is P1/F1/mapping/M1.
UpdateServiceOptions
Updates Data Integration Service properties. To view current properties run the infacmd dis
ListServiceOptions command.
You can change service properties and you can change the service to run on a single node or on a grid.
Changes take effect after you recycle the service. You can use the RecycleMode (-rm) option to recycle the
service.
UpdateServiceOptions
<-DomainName|-dn> domain_name
<-ServiceName|-sn> service_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
[<-Options|-o> options]
[<-RecycleMode|-rm> recycle_mode]
UpdateServiceOptions 247
[<-BackupNodes|-bn> node_name1,node_name2,...]
The following table describes infacmd dis UpdateServiceOptions options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set
-dn the domain name with the -dn option or the environment
variable INFA_DEFAULT_DOMAIN. If you set a domain
name with both methods, the -dn option takes
precedence.
-Password password Required if you specify the user name. Password for the
-pd user name. The password is case sensitive. You can set
a password with the -pd option or the environment
variable INFA_DEFAULT_DOMAIN_PASSWORD. If you set
a password with both methods, the password set with
the -pd option takes precedence.
-NodeName node_name If you want to remove the Data Integration Service from
-nn a grid and run it on a single node, enter the node name.
You can enter the node name or grid name, but you
cannot enter both.
-GridName grid_name If you want to move the Data Integration Service from a
-gn single node to a grid, enter the grid name. You can enter
the node name or grid name, but you cannot enter both.
-RecycleMode recycle_mode Optional. Recycle mode restarts the service and applies
-rm the latest service and service process properties. Select
Abort or Complete.
- Complete. Stops all applications and cancels all jobs
within each application. Waits for all jobs to cancel
before disabling the service.
- Abort. Stops all applications and tries to cancel all
jobs before aborting them and disabling the service.
Default is Complete.
-BackupNodes node_name1,node_name2,. Optional. Nodes on which the service can run if the
-bn .. primary node is unavailable. You can configure backup
nodes if you have high availability.
Option Description
UpdateServiceOptions 249
Option Description
AdvancedProfilingServiceOptions.MaxParallelCol Number of threads that can run mappings at the same time.
umnBatches Default is 1.
AdvancedProfilingServiceOptions.ReservedThread Number of threads of the Maximum Execution Pool Size that are
s for priority requests. Default is 1.
DataObjectCacheOptions.CacheConnection The database connection name for the database that stores the
data object cache. Enter a valid connection object name.
DataObjectCacheOptions.EnableNestedLDOCache Indicates that the Data Integration Service can use cache data
for a logical data object used as a source or a lookup in another
logical data object during a cache refresh. If false, the Data
Integration Service accesses the source resources even if you
enabled caching for the logical data object used as a source or a
lookup.
For example, logical data object LDO3 joins data from logical
data objects LDO1 and LDO2. A developer creates a mapping
that uses LDO3 as the input and includes the mapping in an
application. You enable caching for LDO1, LDO2, and LDO3. If
you enable nested logical data object caching, the Data
Integration Service uses cache data for LDO1 and LDO2 when it
refreshes the cache table for LDO3. If you do not enable nested
logical data object caching, the Data Integration Service
accesses the source resources for LDO1 and LDO2 when it
refreshes the cache table for LDO3.
Default is false.
DataObjectCacheOptions.MaxConcurrentRefreshR Maximum number of cache refreshes that can occur at the same
equests time.
ExecutionOptions.CacheDirectory Directory for index and data cache files for transformations.
Default is <home directory>/cache.
Enter a list of directories separated by semicolons to increase
performance during cache partitioning for Aggregator, Joiner, or
Rank transformations.
You cannot use the following characters in the directory path:
* ? < > " | ,
ExecutionOptions.DisHadoopKeytab The file path to the Kerberos keytab file on the machine on which
the Data Integration Service runs.
ExecutionOptions.DISHomeDirectory Root directory accessible by the node. This is the root directory
for other service directories. Default is <Informatica
installation directory>/tomcat/bin. If you change the
default value, verify that the directory exists.
You cannot use the following characters in the directory path:
* ? < > " | ,
ExecutionOptions.EnableOSProfile Indicates that the Data Integration Service can use operating
system profiles for mapping execution. You can enable operating
system profiles if the Data Integration Service runs on UNIX or
Linux.
Default is false.
ExecutionOptions.HadoopInfaHomeDir The PowerCenter Big Data Edition home directory on every data
node created by the Hadoop RPM install. Type /
<PowerCenterBigDataEditionInstallationDirectory>/
Informatica.
UpdateServiceOptions 251
Option Description
ExecutionOptions.RejectFilesDirectory Directory for reject files. Reject files contain rows that were
rejected when running a mapping. Default is <home
directory>/reject.
You cannot use the following characters in the directory path:
* ? < > " | ,
ExecutionOptions.TargetDirectory Default directory for target flat files used in a mapping. Default
is <home directory>/target.
Enter a list of directories separated by semicolons to increase
performance when multiple partitions write to the flat file target.
If the Data Integration Service runs on a grid, you can use a
shared directory to create one directory for target files. If you
configure a different directory for each node with the compute
role, ensure that the target files are consistent among all target
directories.
You cannot use the following characters in the directory path:
* ? < > " | ,
UpdateServiceOptions 253
Option Description
ExecutionOptions.TemporaryDirectories Directory for temporary files created when jobs are run. Default
is <home directory>/disTemp.
Enter a list of directories separated by semicolons to optimize
performance during profile operations and during cache
partitioning for Sorter transformations.
You cannot use the following characters in the directory path:
* ? < > " | , [ ]
HttpConfigurationOptions.HTTPProtocolType Security protocol that the Data Integration Service uses. Enter
one of the following values:
- HTTP. Requests to the service must use an HTTP URL.
- HTTPS. Requests to the service must use an HTTPS URL.
- Both. Requests to the service can use either an HTTP or an
HTTPS URL.
When you set the HTTP protocol type to HTTPS or Both, you
enable Transport Layer Security (TLS) for the service.
You can also enable TLS for each web service deployed to an
application. When you enable HTTPS for the Data Integration
Service and enable TLS for the web service, the web service uses
an HTTPS URL. When you enable HTTPS for the Data Integration
Service and do not enable TLS for the web service, the web
service can use an HTTP URL or an HTTPS URL. If you enable
TLS for a web service and do not enable HTTPS for the Data
Integration Service, the web service does not start.
Default is HTTP.
HttpProxyServerOptions.HttpServerUser Authenticated user name for the HTTP proxy server. This is
required if the proxy server requires authentication.
LoggingOptions.LogLevel Level of error messages that the Data Integration Service writes
to the Service log. Choose one of the following message levels:
Fatal, Error, Warning, Info, Trace, or Debug.
UpdateServiceOptions 255
Option Description
Modules.MappingService Enter false to disable the module that runs mappings and
previews. Default is true.
Modules.ProfilingService Enter false to disable the module that runs profiles and
generates scorecards. Default is true.
Modules.RESTService Enter false to disable the module that runs the REST web service.
Default is true.
Modules.SQLService Enter false to disable the module that runs SQL queries against
an SQL data service. Default is true.
Modules.WebService Enter false to disable the module that runs web service operation
mappings. Default is true.
Modules.WorkflowOrchestrationService Enter false to disable the module that runs workflows. Default is
true.
ProfilingServiceOptions.ExportPath Location to export profile results. Enter the file system path.
Default is ./ProfileExport.
RepositoryOptions.RepositorySecurityDomain LDAP security domain name if you are using LDAP. If you are not
using LDAP the default domain is native.
RepositoryOptions.RepositoryUserName User name to access the Model repository. The user must have
the Create Project privilege for the Model Repository Service.
ResultSetCacheOptions.EnableEncryption Indicates whether result set cache files are encrypted using 128-
bit AES encryption. Valid values are true or false. Default is true.
ResultSetCacheOptions.FileNamePrefix The prefix for the names of all result set cache files stored on
disk. Default is RSCACHE.
SQLServiceOptions.DTMKeepAliveTime Number of milliseconds that the DTM process stays open after it
completes the last request. Identical SQL queries can reuse the
open process.
Use the keepalive time to increase performance when the time
required to process the SQL query is small compared to the
initialization time for the DTM process. If the query fails, the
DTM process terminates. Must be greater than or equal to 0. 0
means that the Data Integration Service does not keep the DTM
process in memory. Default is 0.
You can also set this property for each SQL data service that is
deployed to the Data Integration Service. If you set this property
for a deployed SQL data service, the value for the deployed SQL
data service overrides the value you set for the Data Integration
Service.
UpdateServiceOptions 257
Option Description
SQLServiceOptions.SkipLogFiles Prevents the Data Integration Service from generating log files
when the SQL data service request completes successfully and
the tracing level is set to INFO or higher. Default is false.
WSServiceOptions.DTMKeepAliveTime Number of milliseconds that the DTM process stays open after it
completes the last request. Web service requests that are issued
against the same operation can reuse the open process.
Use the keepalive time to increase performance when the time
required to process the request is small compared to the
initialization time for the DTM process. If the request fails, the
DTM process terminates. Must be greater than or equal to 0. 0
means that the Data Integration Service does not keep the DTM
process in memory. Default is 5000.
You can also set this property for each web service that is
deployed to the Data Integration Service. If you set this property
for a deployed web service, the value for the deployed web
service overrides the value you set for the Data Integration
Service.
WSServiceOptions.SkipLogFiles Prevents the Data Integration Service from generating log files
when the web service request completes successfully and the
tracing level is set to INFO or higher. Default is false.
WSServiceOptions.WSDLLogicalURL Prefix for the WSDL URL if you use an external HTTP load
balancer. For example,
http://loadbalancer:8080
The Data Integration Service requires an external HTTP load
balancer to run a web service on a grid. If you run the Data
Integration Service on a single node, you do not need to specify
the logical URL.
UpdateServiceProcessOptions
Updates properties for a Data Integration Service process. To view current properties, run the infacmd dis
ListServiceProcessOptions command.
<-DomainName|-dn> domain_name
<-ServiceName|-sn> service_name
<-UserName|-un> user_name
UpdateServiceProcessOptions 259
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-NodeName|-nn> node_name
<-Options|-o> options
The following table describes infacmd dis UpdateServiceProcessOptions options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set
-dn the domain name with the -dn option or the environment
variable INFA_DEFAULT_DOMAIN. If you set a domain
name with both methods, the -dn option takes
precedence.
-Password password Required if you specify the user name. Password for the
-pd user name. The password is case sensitive. You can set
a password with the -pd option or the environment
variable INFA_DEFAULT_DOMAIN_PASSWORD. If you set
a password with both methods, the password set with
the -pd option takes precedence.
NodeName node_name Required. Node where the Data Integration Service runs.
-nn
Option Description
GeneralOptions.JVMOptions Java Virtual Machine (JVM) command line options to run Java-
based programs. When you configure the JVM options, you must
set the Java SDK classpath, Java SDK minimum memory, and
Java SDK maximum memory properties.
GeneralOptions.HttpPort Unique HTTP port number for the Data Integration Service
process when the service uses the HTTP protocol.
GeneralOptions.HttpsPort Unique HTTPS port number for the Data Integration Service
process when the service uses the HTTPS protocol.
LoggingOptions.LogDirectory Directory for Data Integration Service node process logs. Default
is <INFA_HOME>\logs\dislogs.
If the Data Integration Service runs on a grid, use a shared
directory to create one directory for log files. Use a shared
directory to ensure that if the master service process fails over
to another node, the new master service process can access
previous log files.
ResultSetCacheOptions.MaxTotalDiskSize Maximum number of bytes allowed for the total result set cache
file storage. Default is 0.
UpdateServiceProcessOptions 261
Option Description
ResultSetCacheOptions.MaxTotalMemorySize Maximum number of bytes allocated for the total result set
cache storage in memory. Default is 0.
ResultSetCacheOptions.MaxNumCaches Maximum number of result set cache instances allowed for this
Data Integration Service process. Default is 0.
HttpConfigurationOptions.KeyStoreFile Path and file name of the keystore file that contains the keys
and certificates required if you use the HTTPS protocol for the
Data Integration Service. You can create a keystore file with a
keytool. keytool is a utility that generates and stores private or
public key pairs and associated certificates in a keystore file.
You can use the self-signed certificate or use a certificate
signed by a certificate authority.
If you run the Data Integration Service on a grid, the keystore file
on each node in the grid must contain the same keys.
HttpConfigurationOptions.TrustStoreFile Path and file name of the truststore file that contains
authentication certificates trusted by the Data Integration
Service.
If you run the Data Integration Service on a grid, the truststore
file on each node in the grid must contain the same keys.
Queries
Use queries to retrieve design-time and run-time objects.
You can retrieve design-time objects from a Model repository or run-time objects that were deployed to a
Data Integration Service. To build a query, use query parameters to determine the objects that you want to
retrieve. You can make a query more specific by using the where clause and operators.
• compareMapping
• deployObjectsToFile
• queryRunTimeObjects
• queryDesignTimeObjects
• replaceAllTag
• tag
• untag
When you pass a query to a command, the command operates only on the objects that the query returns. If
you pass the query name=mapping1 to the command infacmd dis tag, the command assigns tags only to
objects with the name mapping1.
To pass a query to the commands, specify the query as a string. For example, see the value for the -q option
in the command syntax for the following infacmd dis queryDesignTimeObjects command:
./infacmd.sh dis queryDesignTimeObjects -dn Domain_v299 -un Administrator
-pd Administrator -rs MRS_v299 -rsun Administrator -rspd Administrator
-q "all" -sn DIS_v299
Comparison Operators
Use the comparison operators with query parameters to build a query. You can use comparison operators to
specify criteria when you query objects.
The following table lists the comparison operators that you can use with each type of query parameter:
Queries 263
Query Includes Query Comparison Operators Examples
Parameter Parameters
Type
If you have build a query specifying a criterion by using comparison operators, the query returns the object
that satisfies the criterion to the client.
For example, you can build a query to fetch objects that have the name mapping 1.
name=mapping1
Note: The time format is YYYY-MM-DD HH24:MI:SS.
The following table describes sample queries with both recursive and non-recursive folder paths:
name=map1 folder=/ Non-recursive. The query examines only the objects that are nested directly under the
project.
name=map1 Non-recursive. The query examines only the objects that are located in the path /f1/f2/.
folder=/f1/f2/
name=map1 folder=f1 Recursive. The query examines all objects that are located in folder f1 and all subfolders
within f1.
name=map1 Recursive. The query examines all objects that are located in the path /f1/f2 and all
folder=/f1/f2 subfolders of f2.
Note: If you use a forward slash to specify a non-recursive folder path, you can only use the comparison
operators =, !=, ~in~, and ~not-in~.
Logical Operators
Use logical operators to test whether one or more conditions in a query are TRUE or FALSE.
Note: You cannot use logical operators to test location query parameters, including folder names, project
names, and application names.
Consider the following rules and guidelines when you use the infacmd dis commands:
Queries 265
Query Structure
Use parameters, operations, and the where clause to build a query.
You can structure a query by using parameters, comparison operators, logical operators, and the where
clause. You can control the query precedence by using parentheses.
Query parameters
Query parameters are categorized into subject, time, status, and location. Each query parameter must be
combined with a comparison operator. For example,
mapping=Mapping1
Comparison operators
Comparison operators are used to specify criteria to query objects. Comparison operators are used with
the query parameters to build a query.
Logical operators
Logical operators are used to test a condition in a query. Logical operators can have multiple query
parameters. For example,
mapping=Mapping1 || createdBy=admin
Where clause
The where clause is used to restrict the query scope. For example,
name=mapping1 where project=project1, folder=folder1.
Query Parameters
Use query parameters to query design-time objects in a Model repository and run-time objects that are
deployed to a Data Integration Service. You can use subject, time, status, and location to build a query.
Parameters that test a subject such as specific object or user. The following table lists the subject
parameters:
name Design-time object Name of the object that you want to query.
Run-time object You can specify the name of one of the following types of objects:
- Mapping
- Physical data object
- Parameter set
Parameters that test the time when an object was changed. The following table lists the time
parameters:
lastModifiedTime Design-time object Time when the object was last modified.
checkInTime Design-time object Time when the object was last checked in.
Note: Applies only if the Model repository is integrated with a version
control system.
checkOutTime Design-time object Time when the object was last checked out.
Note: Applies only if the Model repository is integrated with a version
control system.
Status
Parameters that test the status of an object. The following table lists the status parameters:
versionStatus Design-time Version status of the object. The version status can either be checked in or
object checked out.
Note: Applies only if the Model repository is integrated with a version control
system.
Location
Parameters that test where an object is located such as specific project, folder, or run-time application.
The following table lists the location parameters:
application Run-time object Name of the run-time application that contains the object.
Where Clause
Use a where clause to restrict the scope of a query.
You can specify only location query parameters inside a where clause. Location query parameters do not
support logical operators, so you cannot use logical operators inside the where clause.
For example, the following query locates a mapping within a specific project and folder:
name=mapping1 where project1, folder=folder1
Queries 267
You can use parentheses outside of the where clause. For example, the following query uses expressions
(name contains super && name ends-with boy) and (name contains ragnarok) that are enclosed in
parentheses and are outside of the where clause:
(name contains super && name ends-with boy) || (name contains ragnarok) where
project=MapGenTest
You can use all keyword to locate all design-time objects on a Model repository or all run-time objects that
are deployed to a Data Integration Service. You can use all keyword with the where clause.
For example, the following query locates all objects within a specific folder:
all where folder=Folder_1
• startSparkJobServer, 269
• stopSparkJobServer, 271
startSparkJobServer
Starts the Spark Jobserver on the Data Integration Service machine. By default, the Spark Jobserver starts
when you preview hierarchical data.
Run this command to manually start the Spark Jobserver in the background to save time when you preview
hierarchical data.
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-ServiceName|-sn> service_name
<-ConfigurationName|-cn> configuration_name
269
The following table describes infacmd dp startSparkJobServer options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set
-dn the domain name with the -dn option or the environment
variable INFA_DEFAULT_DOMAIN. If you set a domain
name with both methods, the -dn option takes
precedence.
-Password password Required if you specify the user name. Password for the
-pd user name. The password is case sensitive. You can set
a password with the -pd option or the environment
variable INFA_DEFAULT_DOMAIN_PASSWORD. If you set
a password with both methods, the password set with
the -pd option takes precedence.
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-ServiceName|-sn> service_name
-DomainName domain_name Required. Name of the Informatica domain. You can set
-dn the domain name with the -dn option or the environment
variable INFA_DEFAULT_DOMAIN. If you set a domain
name with both methods, the -dn option takes
precedence.
-Password password Required if you specify the user name. Password for the
-pd user name. The password is case sensitive. You can set
a password with the -pd option or the environment
variable INFA_DEFAULT_DOMAIN_PASSWORD. If you set
a password with both methods, the password set with
the -pd option takes precedence.
stopSparkJobServer 271
Option Argument Description
• createRepository, 273
• createService, 275
• updateService, 279
• upgradeRepository, 282
createRepository
Creates a Data Preparation repository.
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-ServiceName|-sn> service_name
273
The following table describes infacmd idp createRepository options and arguments:
createService
Creates an Interactive Data Preparation Service.
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-ServiceName|-sn> service_name
[<-BackupNodes|-bn> node_name1,node_name2,...]
[<-LicenseName|-ln> license_name]
<-RepositoryUser|-rsun> repository_user
[<-RepositoryPassword|-rspd> repository_password]
[<-RepositorySecurityDomain|-rssdn> model_repository_security_domain]
createService 275
<-DISServiceName|-dsn> dis_service_name
[<-KeystoreFile|-kf> keystore_file_location]
[<-KeystorePassword|-kp> keystore_password]
[<-TruststoreFile|-tsf> truststore_file_location]
[<-TruststorePassword|-tsp> truststore_password]
[<-RulesServerPort|-rpo> RulesServerPort]
[<-SolrPort|-spo> SolrPort]
<-maxHeapSize|-mxhs> maxHeapSize]
[<-FolderPath|-fp> full_folder_path]
The following table describes infacmd idp createService options and arguments:
createService 277
Option Argument Description
updateService
Updates Interactive Data Preparation Service properties.
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-ServiceName|-sn> service_name
<-RepositoryUser|-rsun> repository_user
[<-RepositoryPassword|-rspd> repository_password]
[<-RepositorySecurityDomain|-rssdn> model_repository_security_domain]
updateService 279
<-DISServiceName|-dsn> dis_service_name
[<-NodeName|-nn> node_name]
[<-BackupNodes|-bn> node_name1,node_name2,...]
The following table describes infacmd idp updateService options and arguments:
updateService 281
Option Argument Description
upgradeRepository
Upgrades the contents of a Data Preparation repository.
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-ServiceName|-sn> service_name
upgradeRepository 283
Option Argument Description
• createService, 285
• purgeauditevents, 289
• updateService, 291
• upgradeService, 295
createService
Creates an Enterprise Data Preparation Service.
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-ServiceName|-sn> service_name
[<-Description|-des> description]
[<-BackupNodes|-bn> node_name1,node_name2,...]
[<-LicenseName|-ln> license_name]
285
[<-HttpPort|-hp> http_port]
[<-HttpsPort|-hsp> https_port]
[<-KeystoreFile|-kf> keystore_file_location]
[<-KeystorePassword|-kp> keystore_password]
[<-TruststoreFile|-tf> truststore_file_location]
[<-TruststorePassword|-tp> truststore_password]
[<-FolderPath|-fp> full_folder_path]
<-RepositoryService|-rs> repository_service_name
<-RepositoryUser|-rsun> repository_user
[<-RepositoryPassword|-rspd> repository_password]
[<-RepositorySecurityDomain|-rssdn> model_repository_security_domain]
<-DataPreparationServiceName|-dpsn> data_preparation_service_name
<-DISServiceName|-dsn> dis_service_name
<-CatalogService|-ct> catalog_service_name
<-CatalogServiceUser|-ctun> catalogservice_user
<-CatalogServicePassword|-ctpd> catalogservice_password
[<-CatalogSecurityDomain|-cssdn> catalog_security_domain]
The following table describes infacmd edp createService options and arguments:
createService 287
Option Argument Description
-ServiceOptions option_name=value ... Optional. Service properties that define how the
-so Enterprise Data Preparation Service runs.
-KeystoreFile keystore_file_location Optional. Path and file name of the keystore file
-kf that contains the keys and certificates required if
you use the HTTPS protocol for the service. You
can create a keystore file with a keytool. keytool
is a utility that generates and stores private or
public key pairs and associated certificates in a
keystore file. You can use the self-signed
certificate or use a certificate signed by a
certificate authority.
-TruststoreFile truststore_file_location Optional. Path and the file name of the truststore
-tf file that contains authentication certificates for
the HTTPS connection.
purgeauditevents
Purges all Enterprise Data Preparation user activity events from the audit database. Optionally purges project
history events from the audit database.
For more information about the events logged in the audit database, see the Informatica Enterprise Data
Preparation Administrator Guide.
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
purgeauditevents 289
<-ServiceName|-sn> service_name
<-AuditDataRetentionPeriod|-rp> audit_data_retention_period_in_weeks
[<-PurgeProjectHistoryEvents|-phe> true|false]
The following table describes infacmd edp purgeauditevents options and arguments:
updateService
Updates an Enterprise Data Preparation Service.
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-ServiceName|-sn> service_name
updateService 291
INFO|TRACE|DEBUG (default INFO)),customLogDirectory,SecurityMode(nonsecure|kerberos
(default nonsecure)),IDLKerberosPrincipal(Principal Name for User
Impersonation),IDLKerberosKeyTabFileName(SPN Keytab File for User Impersonation),
LogAuditEvents(true|false (default
false)),JDBCPort,ZeppelinURL,MaxFileUploadSize(default=512MB),DownloadRowsSize(default=10
00000),MaxRecommendations(default=10),MaxSampleSize(default=50000),SampleSize(default=500
00),hiveExecutionEngine(MR|Spark|Tez|Cluster-Default (default=Cluster-
Default),LocalSystemDirectory*,SolrJVMOptions,IndexDir)
[<-BackupNodes|-bn> node_name1,node_name2,...]
[<-RepositoryService|-rs> repository_service_name]
[<-RepositoryUser|-rsun> repository_user]
[<-RepositoryPassword|-rspd> repository_password]
[<-RepositorySecurityDomain|-rssdn> model_repository_security_domain]
[<-DataPreparationServiceName|-dpsn> data_preparation_service_name]
[<-DISServiceName|-dsn> dis_service_name]
[<-CatalogService|-ct> catalog_service_name]
[<-CatalogServiceUser|-ctun> catalogservice_user]
[<-CatalogServicePassword|-ctpd> catalogservice_password]
[<-CatalogSecurityDomain|-cssdn> catalog_security_domain]
The following table describes infacmd edp updateService options and arguments:
-ServiceOptions option_name=value ... Optional. Service properties that define how the
-so service runs.
updateService 293
Option Argument Description
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-ServiceName|-sn> service_name
The following table describes infacmd edp upgradeService options and arguments:
upgradeService 295
Option Argument Description
• ListServiceOptions, 297
• UpdateServiceOptions, 298
• UpdateSMTPOptions, 300
ListServiceOptions
Returns a list of properties that are configured for the Email Service. To configure Email Service properties,
run infacmd es updateServiceOptions. To configure Email Service email server properties, run infacmd es
updateSMTPOptions.
<-DomainName|-dn> domain_name
[<-SecurityDomain|-sdn> security_domain]
<-UserName|-un> user_name
<-Password|-pd> password
[<-ServiceName|-sn> service_name]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
297
The following table describes the infacmd es listServiceOptions options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set the
-dn domain name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with both
methods, the -dn option takes precedence.
-SecurityDomain security_domain Required if the domain uses LDAP authentication. Optional if the
-sdn domain uses native authentication or Kerberos authentication.
Name of the security domain to which the domain user belongs.
You can set a security domain with the -sdn option or the
environment variable INFA_DEFAULT_SECURITY_DOMAIN. If you
set a security domain name with both methods, the -sdn option
takes precedence. The security domain name is case sensitive.
If the domain uses native or LDAP authentication, the default is
Native. If the domain uses Kerberos authentication, the default is
the LDAP security domain created during installation. The name
of the security domain is the same as the user realm specified
during installation.
-UserName user_name Required if the domain uses Native or LDAP authentication. User
-un name to connect to the domain. You can set the user name with
the -un option or the environment variable
INFA_DEFAULT_DOMAIN_USER. If you set a user name with both
methods, the -un option takes precedence.
Optional if the domain uses Kerberos authentication. To run the
command with single sign-on, do not set the user name. If you set
the user name, the command runs without single sign-on.
-Password password Required if you specify the user name. Password for the user
-pd name. The password is case sensitive. You can set a password
with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password with
both methods, the password set with the -pd option takes
precedence.
UpdateServiceOptions
Updates Email Service properties. Run this command to configure domain properties and nodes for the Email
Service. To view current Email Service properties, run infacmd es listServiceOptions.
<-DomainName|-dn> domain_name
[<-SecurityDomain|-sdn> security_domain]
<-UserName|-un> user_name
<-Password|-pd> password
[<-ServiceName|-sn> service_name]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
-DomainName domain_name Required. Name of the Informatica domain. You can set the
-dn domain name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with both
methods, the -dn option takes precedence.
-SecurityDomain security_domain Required if the domain uses LDAP authentication. Optional if the
-sdn domain uses native authentication or Kerberos authentication.
Name of the security domain to which the domain user belongs.
You can set a security domain with the -sdn option or the
environment variable INFA_DEFAULT_SECURITY_DOMAIN. If you
set a security domain name with both methods, the -sdn option
takes precedence. The security domain name is case sensitive.
If the domain uses native or LDAP authentication, the default is
Native. If the domain uses Kerberos authentication, the default is
the LDAP security domain created during installation. The name
of the security domain is the same as the user realm specified
during installation.
-UserName user_name Required if the domain uses Native or LDAP authentication. User
-un name to connect to the domain. You can set the user name with
the -un option or the environment variable
INFA_DEFAULT_DOMAIN_USER. If you set a user name with both
methods, the -un option takes precedence.
Optional if the domain uses Kerberos authentication. To run the
command with single sign-on, do not set the user name. If you set
the user name, the command runs without single sign-on.
-Password password Required if you specify the user name. Password for the user
-pd name. The password is case sensitive. You can set a password
with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password with
both methods, the password set with the -pd option takes
precedence.
UpdateServiceOptions 299
Option Argument Description
-NodeName primary node name Optional. Primary node on which the service runs.
-nn
-BackupNodes backup node names Optional. Nodes on which the service can run if the primary node
-bn is unavailable.
UpdateSMTPOptions
Updates the SMTP properties for the Email Service. Business glossaries and workflows use the Email Service
SMTP configuration to email notifications.
The following notifications use the Email Service SMTP configuration to send emails:
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ServiceName|-sn> service_name]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
[<-SMTPServerHostName|-sa> smtp_host]
[<-SMTPUsername|-su> smtp_email_password]
[<-SMTPEmailPassword|-se> smtp_email_password]
[<-SMTPEmailAddress|-ss> smtp_email_address]
[<-SMTPAuthEnabled|-sau> smtp_auth_enabled]
[<-SMTPTLSEnabled|-stls> smtp_tls_enabled]
[<-SMTPSSLEnabled|-sssl> smtp_ssl_enabled]
The following table describes the infacmd es updateSMTPOptions options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set the
-dn domain name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with both
methods, the -dn option takes precedence.
-Password password Required if you specify the user name. Password for the user
-pd name. The password is case sensitive. You can set a
password with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password
with both methods, the password set with the -pd option
takes precedence.
UpdateSMTPOptions 301
Option Argument Description
-SMTPServerHostName smtp_host Optional. The SMTP outbound mail server host name. For
-sa example, enter the Microsoft Exchange Server for Microsoft
Outlook. Default is localhost.
-SMTPUsername smtp_user Optional. The user name for authentication upon sending if
-su required by the outbound mail server.
-SMTPEmailAddress smtp_email_address Optional. Email address that the Email Service uses in the
-ss From field when sending notification emails from a workflow.
Default is [email protected].
SMTPPort smtp_port Optional. Port number used by the outbound SMTP mail
-sp server. Valid values are from 1 to 65535. Default is 25.
-SMTPAuthEnabled smtp_auth_enabled Optional. Indicates that the SMTP server is enabled for
-sau authentication. If true, the outbound mail server requires a
user name and password. If true, you must select whether the
server uses the Transport Layer Security (TLS) protocol or
the Secure Sockets Layer (SSL) protocol. Enter true or
false. Default is false.
-SMTPTLSEnabled smtp_tls_enabled Optional. Indicates that the SMTP server uses the TLS
-stls protocol. If true, enter the TLS port number for the SMTP
server port property. Enter true or false. Default is false.
-SMTPSSLEnabled smtp_ssl_enabled Optional. Indicates that the SMTP server uses the SSL
-sssl protocol. If true, enter the SSL port number for the SMTP
server port property. Enter true or false. Default is false.
• cleanCluster, 303
• createservice, 304
• ListServiceOptions, 308
• ListServiceProcessOptions, 309
• UpdateServiceOptions, 311
• UpdateServiceProcessOptions, 312
• UpgradeClusterService, 314
cleanCluster
Cleans the Informatica Cluster Service.
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
<-ServiceName|-sn> service_name
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
303
The following table describes infacmd ihs cleanCluster options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set the
-dn domain name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with both
methods, the -dn option takes precedence.
-UserName user_name Required if the domain uses Native or LDAP authentication. User
-un name to connect to the domain. You can set the user name with
the -un option or the environment variable
INFA_DEFAULT_DOMAIN_USER. If you set a user name with both
methods, the -un option takes precedence.
Optional if the domain uses Kerberos authentication. To run the
command with single sign-on, do not set the user name. If you set
the user name, the command runs without single sign-on.
-Password password Required if you specify the user name. Password for the user
-pd name. The password is case sensitive. You can set a password
with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password with
both methods, the password set with the -pd option takes
precedence.
-SecurityDomain security_domain Required if the domain uses LDAP authentication. Optional if the
-sdn domain uses native authentication or Kerberos authentication.
Name of the security domain to which the domain user belongs.
You can set a security domain with the -sdn option or the
environment variable INFA_DEFAULT_SECURITY_DOMAIN. If you
set a security domain name with both methods, the -sdn option
takes precedence. The security domain name is case sensitive.
If the domain uses native or LDAP authentication, the default is
Native. If the domain uses Kerberos authentication, the default is
the LDAP security domain created during installation. The name
of the security domain is the same as the user realm specified
during installation.
createservice
Creates an Informatica Cluster Service.
<-NodeName|-nn> node_name
[<-SecurityDomain|-sdn> security_domain]
<-UserName|-un> user_name
<-Password|-pd> password
<-ServiceName|-sn> service_name
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
[<-HttpPort|-p> port_name]
[<-HttpsPort|-sp> https_port_name]
[<-KeystoreFile|-kf> keystore_file_location]
[<-KeystorePassword|-kp> keystore_password]
[<-SSLProtocol|-sslp> ssl_protocol]
<-HadoopGatewayHost|-hgh>
[<-HadoopGatewayPort|-hgp>]
<-HadoopNodes|-hn>
[<-GatewayUser|-gu>]
[<-TrustStoreLocation|-tf>]
[<-TrustStorePassword|-tp>]
[<-KdcHost|-kh> kdc_host]
[<-AdminServerHost|-ah> kdc_host]
[<-Realm|-r> realm]
[<-LdapUrl|-lu> ldap_url]
[<-ContainerDn|-cd> container_dn]
[<-AdminUserPrincipal|-au> admin_principal]
[<-AdminPassword|-ap> admin_password]
[<-BackupNodes|-bn> node_name1,node_name2,...]
createservice 305
The following table describes infacmd ihs CreateService options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set
-dn the domain name with the -dn option or the environment
variable INFA_DEFAULT_DOMAIN. If you set a domain
name with both methods, the -dn option takes precedence.
-Password password Required if you specify the user name. Password for the
-pd user name. The password is case sensitive. You can set a
password with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a
password with both methods, the password set with the -
pd option takes precedence.
-HttpPort port_name Optional. A unique HTTP port number used for Informatica
-p Cluster Service. The default port number is 9075.
-EnableTls enable_tls true|false Optional. Select this option to enable Transport Layer
-tls Security.
-KeystorePassword keystore_password Required if you select Enable Transport layer Security. The
-kp password for the keystore file.
-HadoopGatewayHost Hadoop_Gateway_Host Required. Fully qualified host name of the node that
-hgh serves as the gateway to the Hadoop cluster.
-GatewayUser Gateway_User Optional. Username for the Hadoop Gateway Node. Enable
-gu a SSH connection from Informatica Domain to Hadoop
Gateway Host. Default is root.
createservice 307
Option Argument Description
-BackupNodes node_name1,node_name2,... Optional. Nodes on which the service can run if the
-bn primary node is unavailable. You can configure backup
nodes if you have high availability.
ListServiceOptions
Lists options for the Informatica Cluster Service.
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
<-ServiceName|-sn> service_name
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
-DomainName domain_name Required. Name of the Informatica domain. You can set the
-dn domain name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with both
methods, the -dn option takes precedence.
-UserName user_name Required if the domain uses Native or LDAP authentication. User
-un name to connect to the domain. You can set the user name with
the -un option or the environment variable
INFA_DEFAULT_DOMAIN_USER. If you set a user name with both
methods, the -un option takes precedence.
Optional if the domain uses Kerberos authentication. To run the
command with single sign-on, do not set the user name. If you set
the user name, the command runs without single sign-on.
-Password password Required if you specify the user name. Password for the user
-pd name. The password is case sensitive. You can set a password
with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password with
both methods, the password set with the -pd option takes
precedence.
-SecurityDomain security_domain Required if the domain uses LDAP authentication. Optional if the
-sdn domain uses native authentication or Kerberos authentication.
Name of the security domain to which the domain user belongs.
You can set a security domain with the -sdn option or the
environment variable INFA_DEFAULT_SECURITY_DOMAIN. If you
set a security domain name with both methods, the -sdn option
takes precedence. The security domain name is case sensitive.
If the domain uses native or LDAP authentication, the default is
Native. If the domain uses Kerberos authentication, the default is
the LDAP security domain created during installation. The name
of the security domain is the same as the user realm specified
during installation.
ListServiceProcessOptions
Lists process options for the Informatica Cluster Service.
ListServiceProcessOptions 309
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
<-ServiceName|-sn> service_name
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-NodeName|-nn> node_name
The following table describes infacmd ihs ListServiceProcessOptions options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set the
-dn domain name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with both
methods, the -dn option takes precedence.
-UserName user_name Required if the domain uses Native or LDAP authentication. User
-un name to connect to the domain. You can set the user name with
the -un option or the environment variable
INFA_DEFAULT_DOMAIN_USER. If you set a user name with both
methods, the -un option takes precedence.
Optional if the domain uses Kerberos authentication. To run the
command with single sign-on, do not set the user name. If you set
the user name, the command runs without single sign-on.
-Password password Required if you specify the user name. Password for the user
-pd name. The password is case sensitive. You can set a password
with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password with
both methods, the password set with the -pd option takes
precedence.
-SecurityDomain security_domain Required if the domain uses LDAP authentication. Optional if the
-sdn domain uses native authentication or Kerberos authentication.
Name of the security domain to which the domain user belongs.
You can set a security domain with the -sdn option or the
environment variable INFA_DEFAULT_SECURITY_DOMAIN. If you
set a security domain name with both methods, the -sdn option
takes precedence. The security domain name is case sensitive.
If the domain uses native or LDAP authentication, the default is
Native. If the domain uses Kerberos authentication, the default is
the LDAP security domain created during installation. The name
of the security domain is the same as the user realm specified
during installation.
-NodeName node_name Required. Name of the node where the service process runs.
-nn
UpdateServiceOptions
Updates service options for the Informatica Cluster Service. Separate multiple options with a space. To enter
a value that contains a space or other non-alphanumeric character, enclose the value in quotation marks.
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
<-ServiceName|-sn> service_name
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-Options|-o> options
[<-PrimaryNode|-nn> node_name]
[<-BackupNodes|-bn> node_name1,node_name2,...]
The following table describes infacmd ihs UpdateServiceOptions options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set the
-dn domain name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with both
methods, the -dn option takes precedence.
-UserName user_name Required if the domain uses Native or LDAP authentication. User
-un name to connect to the domain. You can set the user name with
the -un option or the environment variable
INFA_DEFAULT_DOMAIN_USER. If you set a user name with both
methods, the -un option takes precedence.
Optional if the domain uses Kerberos authentication. To run the
command with single sign-on, do not set the user name. If you
set the user name, the command runs without single sign-on.
UpdateServiceOptions 311
Option Argument Description
-Password password Required if you specify the user name. Password for the user
-pd name. The password is case sensitive. You can set a password
with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password
with both methods, the password set with the -pd option takes
precedence.
-SecurityDomain security_domain Required if the domain uses LDAP authentication. Optional if the
-sdn domain uses native authentication or Kerberos authentication.
Name of the security domain to which the domain user belongs.
You can set a security domain with the -sdn option or the
environment variable INFA_DEFAULT_SECURITY_DOMAIN. If you
set a security domain name with both methods, the -sdn option
takes precedence. The security domain name is case sensitive.
If the domain uses native or LDAP authentication, the default is
Native. If the domain uses Kerberos authentication, the default
is the LDAP security domain created during installation. The
name of the security domain is the same as the user realm
specified during installation.
-PrimaryNode node_name Optional. Primary node on which the Informatica Cluster Service
-nn runs.
-BackupNodes node_name1,node_name2,... Optional. Nodes on which the Informatica Cluster Service can
-bn run if the primary node is unavailable. You can configure backup
nodes if you have high availability.
UpdateServiceProcessOptions
Updates service process options for the Informatica Cluster Service. Separate multiple options with a space.
To enter a value that contains a space or other non-alphanumeric character, enclose the value in quotation
marks.
<-DomainName|-dn> domain_name
<-NodeName|-nn> node_name
<-Password|-pd> password
<-ServiceName|-sn> service_name
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-Options|-o> options
The following table describes infacmd ihs UpdateServiceProcessOptions options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set the
-dn domain name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with both
methods, the -dn option takes precedence.
-NodeName node_name Required. Name of the node where the service process runs.
-nn
-UserName user_name Required if the domain uses Native or LDAP authentication. User
-un name to connect to the domain. You can set the user name with
the -un option or the environment variable
INFA_DEFAULT_DOMAIN_USER. If you set a user name with both
methods, the -un option takes precedence.
Optional if the domain uses Kerberos authentication. To run the
command with single sign-on, do not set the user name. If you set
the user name, the command runs without single sign-on.
-Password password Required if you specify the user name. Password for the user
-pd name. The password is case sensitive. You can set a password
with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password with
both methods, the password set with the -pd option takes
precedence.
-SecurityDomain security_domain Required if the domain uses LDAP authentication. Optional if the
-sdn domain uses native authentication or Kerberos authentication.
Name of the security domain to which the domain user belongs.
You can set a security domain with the -sdn option or the
environment variable INFA_DEFAULT_SECURITY_DOMAIN. If you
set a security domain name with both methods, the -sdn option
takes precedence. The security domain name is case sensitive.
If the domain uses native or LDAP authentication, the default is
Native. If the domain uses Kerberos authentication, the default is
the LDAP security domain created during installation. The name
of the security domain is the same as the user realm specified
during installation.
UpdateServiceProcessOptions 313
Option Argument Description
UpgradeClusterService
Upgrades the Informatica Cluster Service.
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
<-ClusterServiceName|-csn> cluster_service_name
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-InputFileName|-if> input_file_name
The following table describes infacmd ihs UpgradeClusterService options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set the
-dn domain name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with both
methods, the -dn option takes precedence.
-Password password Required if you specify the user name. Password for the user
-pd name. The password is case sensitive. You can set a password
with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password
with both methods, the password set with the -pd option takes
precedence.
-ClusterServiceName cluster_service_name Required. Refers to the name of the Informatica Cluster Service.
-csn
-InputFileName input_file_name Required. Complete path to the Catalog Service backup ZIP file
-if on the local machine. The upgrade process validates the
backup ZIP file and does not restore data.
UpgradeClusterService 315
Chapter 19
• ExportToPC, 316
• ImportFromPC, 319
• genReuseReportFromPC, 321
ExportToPC
Exports objects from the Model repository or an export file and converts them to PowerCenter objects.
The ExportToPC command converts objects from the Model repository or from an XML file that you exported
from the Model repository. You must choose either a Model repository or a source file for export. If you
choose both options, the source file option takes precedence. Run ExportToPC command to create an XML
file that you can import into PowerCenter with the pmrep program.
<-Release|-rel> release_number
[<-SourceFile|-sf> source_file]
[<-SourceRepository|-sr> source_repository]
[<-Recursive|-r>]
[<-TargetLocation|-tl> target_location]
[<-TargetFolder|-tf> target_folder_name]
[<-CodePage|-cp> target_code_page]
[<-Check|-c>]
[<-ReferenceDataLocation|-rdl> reference_data_output_location]
[<-ConvertMappletTargets|-cmt>]
[<-ConvertMappingsToMapplets|-cmm>]
[<-NoValidation|-nv>]
[<-DSTErrorFormat|-def>]
316
[<-OptimizationLevel|- O optimization_level 1 or Optimization_level 2]
The following table describes infacmd ipc ExportToPC command options and arguments:
-SourceFile source_file Optional. The full path to an XML file containing source objects that you
-sf exported with the Developer tool.
-SourceRepository source_reposito Optional. The Model repository that contains the objects to export to
-sr ry PowerCenter.
To specify the gateway host and port to connect to the Model Repository
Service, use the following command syntax in a non-Kerberos domain:
<Model repository name>@<host>:<port>#<projectname>
?
user=<username>[&namespace=<namespace>]&password=<password
>
To specify the domain name when you have multiple gateway nodes, use the
following command syntax to establish a resilient connection to the Model
Repository Service in a non-Kerberos domain:
<Model repository name>@<domainname>#<projectname>
?
user=<username>[&namespace=<namespace>]&password=<password
>
To specify the domain name with the logged-in credentials, use the following
command syntax to run the command with single sign on:
<Model repository name>@<domainname>#<projectname>
?isloggedinuser=true[&namespace=<namespace>]
To specify the gateway host and port with the logged-in credentials, use the
following command syntax to run the command with single sign on:
<Model repository name>@<host>:<port>#<projectname>
?isloggedinuser=true[&namespace=<namespace>]
To specify the gateway host and port with the user credentials you specify
instead of the logged-in credentials, use the following command syntax in a
Kerberos domain:
<Model repository name>@<host>:<port>#<projectname>
?
iskerberos=true&user=<username>[&namespace=<namespace>]&pa
ssword=<password> &Kerberosrealm=<kerberosrealm>
To specify the domain name with the user credentials you specify instead of
the logged-in credentials, use the following command syntax in a Kerberos
domain:
<Model repository name>@<domainname>#<projectname>
?
iskerberos=true&user=<username>[&namespace=<namespace>]&pa
ssword=<password> &Kerberosrealm=<kerberosrealm>
The port parameter is the HTTP port. The &namespace parameter is optional.
The default namespace is native.
ExportToPC 317
Option Argument Description
-Recursive - Optional. Exports all mappings and logical data object models from the
-r source folders. Exports each subfolder below the objects, and any subfolders
below that.
Default is false.
-TargetLocation target_location Optional. The full path to the target XML file.
-tl
-TargetFolder target_folder_n Optional. The PowerCenter folder to export the objects to. The ExportToPC
-tf ame command places the folder name in the target XML file. If you do not
configure a folder name, the ExportToPC command creates a folder name.
-CodePage target_code_pa Optional. Code page of the PowerCenter repository. Default is UTF-8.
-cp ge
- reference_data_ Optional. Location where you want to save reference table data. The
ReferenceDataLoc output_location ExportToPC command saves the reference table data as one or more
ation dictionary .dic files.
-rdl
-NoValidation - Optional. The ExportToPC command does not validate source objects before
-nv converting them.
Default is false.
-DSTErrorFormat - Optional. The error messages appear in a format that the Developer tool can
-def parse. The full path of each object displays in the error messages.
Default is to display errors in a user-friendly format.
OptimizationLevel optimization_le Optional. Controls the optimization methods that the Data Integration Service
-O vel applies to the mapping. Enter the numeric value that is associated with the
optimization level that you want to configure. Enter one of the following
numeric values:
- 0 (None). The Data Integration Service does not apply any optimization.
- 1 (Minimal). The Data Integration Service applies the early projection
optimization method.
- 2 (Normal). The Data Integration Service applies the early projection, early
selection, branch pruning, push-into, pushdown, and predicate optimization
methods. Normal is the default optimization level.
- 3 (Full). The Data Integration Service applies the cost-based, early
projection, early selection, branch pruning, predicate, push-into, pushdown,
and semi-join optimization methods.
If you do not use this option, the Data Integration Service applies the
optimization level configured in the mapping properties for the deployed
application in the Administrator tool.
ImportFromPC
Converts a PowerCenter repository object XML file to a Model repository object XML file. Export PowerCenter
repository objects to an XML file. Run the importFromPC command to create a target XML file with objects
that you can import into a Model repository.
You can import the target XML file to a Model respository with the infacmd tools ImportObjects command or
from the Developer tool. If you use the command line to import the target XML file, ImportFromPC does not
assign connections to the Model repository objects in the target XML file. You can assign connections with
the infacmd oie ImportObjects command or from the Developer tool.
<-Release|-rel> release_number
[<-SourceFile|-sf> source_file]
[<-TargetFile|-tf> target_location]
[<-Check|-c>]
[<-Db2Type|-dt> default_db2_type]
[<-Db2TypesFile|-df> db2_types_file]
[<-DefaultLookUpConType|-dl> default_lookup_con_type]
ImportFromPC 319
[<-LookUpConTypesFile|-lcf> lookup_connection_types_file]
[<-ConvertOverriddenProps|-orprops> recreate_transformation_with_overridden_properties_
in_mappings]
[<-LogFile|-lf> log_file]
The following table describes infacmd ipc ImportFromPC command options and arguments:
-SourceFile source_file Required. The full path to a PowerCenter XML file containing the source
-sf objects.
-TargetFile target_location Required if you do not specify -Check or -c. The full path to a target XML file.
-tf
-Db2Type default_db2_typ Optional. The DB2 subsystem type used for conversion.
-dt e You can specify either Db2Type or Db2TypesFile, or both. If you specify both
Db2Type and Db2TypesFile for IBM DB2 objects, the DB2 source and target
that are not listed in the Db2TypesFile gets converted to the Db2Type.
If you do not specify a DB2 subsystem type, the default DB2 subsystem type
is used.
Default is LUW.
-Db2TypesFile db2_types_file Optional. A property file that contains the PowerCenter DB2 source and Db2
-df subsystem type. You can use a Db2 types file if the Db2 source and target
are from different subsystems such as LUW, z/OS, or i/OS.
You can specify either Db2Type or Db2TypesFile, or both. If you specify both
Db2Type and Db2TypesFile for IBM DB2 objects, the DB2 source and target
that are not listed in the Db2TypesFile gets converted to the Db2Type.
If you do not specify the DB2 subsystem type, the default DB2 subsystem
type is used.
Default is LUW.
- lookup_connect Optional. A property file that contains the lookup source and the lookup
LookUpConTypesF ion_type_file connection type. You can use a lookup connection type file if the lookup
ile objects are from different databases, such as Oracle or IBM DB2.
-lcf You can specify either DefaultLookUpConType or LookUpConTypesFile, or
both.
If you specify both the files for the lookup objects, the Lookup
transformations that are not listed in the LookUpConTypesFile converts to
the DefaultLookUpConType.
If you do not specify the DefaultLookUpConType for a lookup object during
conversion, the default connection type is used.
Default is ODBC.
-LogFile log_file Optional. Path and file name of the output log file.
-lf Default is STDOUT.
genReuseReportFromPC
Generates a report that estimates how many PowerCenter mappings can be reused in the Model repository
for a native or Hadoop environment. You can generate the report as a PDF or Excel file.
Note: If you generate the report as an Excel file, click Enable Content in the message bar to load all sheets.
Before you run the infacmd ipc genReuseReportFromPC command, verify that you complete the following
tasks:
<-RepositoryName|-r> Pc_Repository_Name
<-HostName|-h> Pc_Domain_HostName
<-PortNumber|-o> Pc_Domain_PortNumber
[<-UserName|-n> Domain_UserName]
[<-Password|-x> Domain_Password]
[<-SecurityDomain|-s> Pc_Repository_Security_domain]
genReuseReportFromPC 321
<-folderNames|-f> Pc_Folder_Names
<-SrcRelease|-srel> Pc_Release_version
[<-targetRelease|-trel> Target_Release_version]
[<-CodePage|-cp> Pc_Repository_code_page]
<-targetDir|-td> Target_Directory
<-authenticationType|-at> authentication_Type
[<-LogFile|-lf> Log_file_Name]
[<-Font> Font_to_use_for_PDF]
[<-ExecutionEnvironment|-execMode> Execution_Environment]
[<-BlockSize> Block_Size]
The following table describes infacmd ipc genreusereportfrompc command options and arguments:
-UserName Domain_UserNam Optional. User name of the PowerCenter domain. If you do not enter a user
-n e name, the command uses the value in the INFA_DEFAULT_DOMAIN_USER
environment variable.
Password Domain_Passwor Optional. Password of the PowerCenter domain. If you do not enter a user
-x d name, the command uses the value in the
INFA_DEFAULT_DOMAIN_PASSWORD environment variable.
-SecurityDomain Pc_Repository_Se Required if you use LDAP authentication. Name of the security domain that
-s curity_domain the user belongs to. If you do not enter a security domain, the command
uses the value in the INFA_DEFAULT_SECURITY_DOMAIN environment
variable.
You can use Native, LDAP, or SSO as the value.
The default value is Native.
-folderNames Pc_Folder_Names Required. PowerCenter folders that contain the objects to be reused. The
-f folder names can contain expressions. The folder names can contain * as
expressions.
Note: If you use the Linux environment, you cannot use $ in the folder
name.
-SrcRelease Pc_Release_versi Required. The release associated with the PowerCenter repository.
-srel on Enter the version in the following format:
10.x.x
For example, enter a version in the following format:
10.2.0
-targetRelease Target_Release_v Optional. The release associated with the Model repository. If you do not
-trel ersion enter a version, the command uses the product version. You can enter
versions from 10.0.0 and above.
Enter the version in the following format:
10.x.x
For example, enter a version in the following format:
10.2.1
-CodePage Pc_Repository_co Optional. Code page of the PowerCenter repository. Default is UTF-8.
-cp de_page
-targetDir Target_Directory Required. Location of the target directory on the machine on which the
-td infacmd client and server runs. You must have the read, write, and execute
permissions on the target directory folder.
For example, enter the infacmd client location in the following format:
installed_location_of_client\clients\DeveloperClient
\infacmd
For example, enter the infacmd server location in the following format:
installed_location_of_server\isp\bin
Note: On a Linux machine, you cannot use $ in the target directory name.
authenticationTyp authentication_Ty Required. The type of user authentication for the domain. Enter one of the
e pe following values: LDAP, Native, or Kerberos Single Sign On.
-at
-LogFile Log_file_Name Optional. Name of the generated log file. If you do not enter a name, the
-lf command prints the logs on the console. Uses the value of file_path/
file_name.
If you enter a file name, the log file with the same name appears in the
infacmd folder.
If you enter a directory path that is not valid, the log file with the path name
appears in the infacmd folder. For example, if you enter x as the directory
path, the log file named x appears in the infacmd folder.
-Font Font_to_use_for_ Optional. The location for the font file to have Unicode characters in the
PDF report.
genReuseReportFromPC 323
Option Argument Description
- Execution_Environ Optional. The run-time engine in the Hadoop environment. The report
ExecutionEnviron ment validates mappings based on the run-time engine that you choose. You can
ment use Blaze or Spark as the value. If you do not enter a value, the report will
-execMode run against all engines and include only the engine with the fewest errors.
-BlockSize Block_Size Optional. The number of mappings that you want to run the infacmd ipc
genReuseReportFromPC command against. If you do not enter a value, the
report runs and converts all the mappings within each folder at a time.
When the memory required to run the command is unavailable, use the
‑BlockSize option to control the number of mappings instead of running the
command on all the mappings in the repository.
This chapter includes the commands that you can use with the infacmd isp program.
AddAlertUser
Subscribes a user to alert notification emails. Before you can subscribe any user to alerts, you must
configure SMTP settings for the outgoing mail server. You can run infacmd isp AddAlertUser for any user.
When you subscribe to alerts, you receive domain and service notification emails for the objects on which
you have permission.
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
[<-SecurityDomain|-sdn> security_domain]
<-Password|-pd> password
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-AlertUser|-au> user_name
325
The following table describes infacmd isp AddAlertUser options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set the
-dn domain name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with both
methods, the -dn option takes precedence.
-UserName user_name Required if the domain uses Native or LDAP authentication. User
-un name to connect to the domain. You can set the user name with
the -un option or the environment variable
INFA_DEFAULT_DOMAIN_USER. If you set a user name with both
methods, the -un option takes precedence.
Optional if the domain uses Kerberos authentication. To run the
command with single sign-on, do not set the user name. If you
set the user name, the command runs without single sign-on.
-Password password Required if you specify the user name. Password for the user
-pd name. The password is case sensitive. You can set a password
with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password with
both methods, the password set with the -pd option takes
precedence.
-SecurityDomain security_domain Required if the domain uses LDAP authentication. Optional if the
-sdn domain uses native authentication or Kerberos authentication.
Name of the security domain to which the domain user belongs.
You can set a security domain with the -sdn option or the
environment variable INFA_DEFAULT_SECURITY_DOMAIN. If you
set a security domain name with both methods, the -sdn option
takes precedence. The security domain name is case sensitive.
If the domain uses native or LDAP authentication, the default is
Native. If the domain uses Kerberos authentication, the default is
the LDAP security domain created during installation. The name
of the security domain is the same as the user realm specified
during installation.
AddConnectionPermissions
Assigns connection permissions to a user or group.
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<<-RecipientUserName|-run> recipient_user_name|<RecipientGroupName|-rgn>
recipient_group_name>
<-RecipientSecurityDomain|-rsd> recipient_security_domain]
<-ConnectionName|-cn> connection_name
[<-Permission|-p> permission_READ|WRITE|EXECUTE|GRANT|ALL
The following table describes infacmd isp AddConnectionPermissions options and arguments:
AddConnectionPermissions 327
Option Argument Description
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-CustomLDAPTypeName|-lt> custom_LDAP_type_name
<-DisplayName|-dpn> display_name
<-Uid> uid
[<-GroupMembershipAttr|-gm> group_membership_attr]
[<-GroupDescriptionAttr|-gd> group_description_attr]
[<-UserSurnameAttr|-usn> user_surname_attr]
[<-UserGivenNameAttr|-ugn> user_given_name_attr]
[<-UserEmailAttr|-ue> user_email_attr]
[<-UserEnableAttr|-uen> user_enable_attr]
[<-UserTelephoneAttr|-utn> user_telephone_attr]
[<-UserDescriptionAttr|-ud> user_description_attr]
[<-CN> cn]
[<-FetchRangedAttr|-fr> fetch_ranged_attr]
addCustomLDAPType 329
The following table describes infacmd isp addCustomLDAPType options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set
-dn the domain name with the -dn option or the environment
variable INFA_DEFAULT_DOMAIN. If you set a domain
name with both methods, the -dn option takes
precedence.
-Password password Required if you specify the user name. Password for the
-pd user name. The password is case sensitive. You can set a
password with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a
password with both methods, the password set with the -
pd option takes precedence.
- -DisplayName display_name Required. Name of the custom LDAP type displayed in the
-dpn Administrator tool.
- User DescriptionAttrr user_description_attr Optional. Name of the attribute in the LDAP directory
-ud service that contains a description for a user.
- FetchRangedAttr fetch_ranged_attr Optional. Set to true to retrieve all of the values contained
-fr in multivalued attributes.
Use this option with Microsoft Active Directory only.
addCustomLDAPType 331
AddDomainLink
Adds a link to a domain. records connection properties to a remote, or linked, domain so that you can
exchange repository metadata between the local domain and the linked domain.
You may want to add a link to a domain if you need to access a PowerCenter Repository Service in that
domain.
You can add a link to another Informatica domain when you register or unregister a local repository with a
global repository in another Informatica domain.
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-LinkedDomainName|-ld> linked_domain_name
-DomainName domain_name Required. Name of the Informatica domain. You can set the
-dn domain name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with both
methods, the -dn option takes precedence.
-Password password Required if you specify the user name. Password for the user
-pd name. The password is case sensitive. You can set a
password with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password
with both methods, the password set with the -pd option takes
precedence.
-LinkedDomainName linked_domain_name Required. Name of the domain that you want to establish a
-ld connection with.
-DomainLink gateway_host1:port Required. The host names and port numbers for the gateway
-dl gateway_host2:port ... nodes in the linked domain.
AddDomainNode
Adds a node to the domain. Before you can start the node, you must define it by running infasetup
DefineGatewayNode or DefineWorkerNode on the node.
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-NodeName|-nn> node_name
[<-FolderPath|-fp> full_folder_path]
AddDomainNode 333
[<-EnableServiceRole|-esr> true|false]
[<-EnableComputeRole|-ecr> true|false]
The following table describes infacmd isp AddDomainNode options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set the
-dn domain name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with both
methods, the -dn option takes precedence.
-Password password Required if you specify the user name. Password for the user
-pd name. The password is case sensitive. You can set a password
with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password
with both methods, the password set with the -pd option takes
precedence.
-NodeName node_name Required. Name of the node you want to add to the domain.
-nn
-FolderPath full_folder_path Optional. Full path, excluding the domain name, to the folder in
-fp which you want to add the node. Must be in the following
format:
/parent_folder/child_folder
Default is “/” (the domain).
-EnableServiceRole true | false Optional. Enables the service role on the node. If true,
-esr application services can run on the node. If false, application
services cannot run on the node. Set to false only if the node is
assigned to a Data Integration Service grid and you want to
dedicate the node to running mappings.
Default is true.
-EnableComputeRole true | false Optional. Enables the compute role on the node. If true, the
-esr node can perform computations requested by remote
application services. If false, the node cannot perform
computations requested by remote application services.
A node requires the compute role when the Data Integration
Service runs jobs on the node.
If the Data Integration Service does not run jobs on the node,
you can disable the compute role. However, enabling or
disabling the compute role does not have a performance
impact.
Default is true.
AddGroupPrivilege
Assigns a privilege to a group in the domain. You can assign privileges to a group for the domain. You can
also assign group privileges for each application service in the domain.
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-GroupName|-gn> group_name
[<-GroupSecurityDomain|-gsf> group_security_domain]
<-ServiceName|-sn> service_name
<-PrivilegePath|-pp> path_of_privilege
AddGroupPrivilege 335
The following table describes infacmd isp AddGroupPrivilege options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set the
-dn domain name with the -dn option or the environment
variable INFA_DEFAULT_DOMAIN. If you set a domain name
with both methods, the -dn option takes precedence.
-Password password Required if you specify the user name. Password for the
-pd user name. The password is case sensitive. You can set a
password with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password
with both methods, the password set with the -pd option
takes precedence.
-GroupName group_name Required. Name of the group to which you are assigning the
-gn privilege. To enter a name that contains a space or other
non-alphanumeric character, enclose the name in quotation
marks.
-ServiceName service_name Required. Domain or application service name for which you
-sn want to view privileges.
addLDAPConnectivity
Configures a connection to an LDAP server. If you specify a security domain, the Service Manager imports
users and groups from the LDAP directory service into the security domain.
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-LDAPAddress|-la> ldap_server_address
[<-LDAPPrincipal|-lp> ldap_principal]
[<-LDAPCredential|-lc> ldap_credential]
[<-UseSSL|-us> use_ssl]
[<-TrustLDAPCertificate|-tc> trust_ldap_certificate]
[<-MaxSecurityDomainSize|-ms> Max_Security_Domain_size]
[<-GroupMembershipAttr|-gm> LDAP_Group_Membership_Attribute]
[<-LDAPNotCaseSensitive|-lnc> ldap_not_case_sensitive]
<-LDAPHostConfigurationName|-lcn> LDAP_host_configuration_name
addLDAPConnectivity 337
The following table describes infacmd isp addLDAPConnectivity options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set
-dn the domain name with the -dn option or the environment
variable INFA_DEFAULT_DOMAIN. If you set a domain
name with both methods, the -dn option takes
precedence.
-Password password Required if you specify the user name. Password for the
-pd user name. The password is case sensitive. You can set a
password with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a
password with both methods, the password set with the -
pd option takes precedence.
-LDAPAddress ldap_server_address Required. Host name and port number for the machine
-la hosting the LDAP directory service. Typically, the LDAP
server port number is 389. If the LDAP server uses SSL,
the LDAP server port number is 636.
-LDAPPrincipal ldap_principal Optional. Distinguished name (DN) for the principal user.
-lp Omit this option to log in as an anonymous user.
For more information, refer to the documentation for the
LDAP directory service.
-LDAPCredential ldap_credential Optional. Password for the principal user. You can set a
-lc password with the -lc option or the environment variable
INFA_PASSWORD. If you set a password with both
methods, the password set with the -lc option takes
precedence.
Omit this option to log in as an anonymous user.
-UseSSL use_ssl Optional. If you include the option, the LDAP directory
-us service uses Secure Socket Layer (SSL) protocol.
-LDAPNotCaseSensitive LDAP_Not_Case_Sensitive Optional. Indicates that the user names from the LDAP
-lnc directory service are not case sensitive.
Default is false.
addLDAPConnectivity 339
AddLicense
Adds a license to the domain. After you add a license, you can assign it to an application service using the
AssignLicense command. You must assign a license to a service before you can use the service.
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> securitydomain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-LicenseName|-ln> license_name
<-LicenseKeyFile|-lf> license_key_file
[<-FolderPath|-fp> full_folder_path]
The following table describes infacmd isp AddLicense options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set the domain
-dn name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with both
methods, the -dn option takes precedence.
-UserName user_name Required if the domain uses Native or LDAP authentication. User
-un name to connect to the domain. You can set the user name with the
-un option or the environment variable
INFA_DEFAULT_DOMAIN_USER. If you set a user name with both
methods, the -un option takes precedence.
Optional if the domain uses Kerberos authentication. To run the
command with single sign-on, do not set the user name. If you set
the user name, the command runs without single sign-on.
-Password password Required if you specify the user name. Password for the user name.
-pd The password is case sensitive. You can set a password with the -
pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password with
both methods, the password set with the -pd option takes
precedence.
-SecurityDomain security_domain Required if the domain uses LDAP authentication. Optional if the
-sdn domain uses native authentication or Kerberos authentication.
Name of the security domain to which the domain user belongs.
You can set a security domain with the -sdn option or the
environment variable INFA_DEFAULT_SECURITY_DOMAIN. If you set
a security domain name with both methods, the -sdn option takes
precedence. The security domain name is case sensitive.
If the domain uses native or LDAP authentication, the default is
Native. If the domain uses Kerberos authentication, the default is
the LDAP security domain created during installation. The name of
the security domain is the same as the user realm specified during
installation.
-LicenseName license_name Required. Name of the license. The name is not case sensitive and
-ln must be unique within the domain. The name cannot exceed 79
characters, have leading or trailing spaces, or contain carriage
returns, tabs, or the following characters:
/ * ? < > " |
-FolderPath full_folder_path Optional. Full path, excluding the domain name, to the folder in
-fp which you want to add the license. Must be in the following format:
/parent_folder/child_folder
Default is “/” (the domain).
AddNamespace
Creates an LDAP security domain and sets the filters to search for users or groups in the directory service.
Creates the LDAP security domain if the Informatica domain uses LDAP or Kerberos authentication.
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
AddNamespace 341
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-NameSpace|-ns> namespace
[<-UserSearchBase|-usb> usersearchbase]
[<-UserFilter|-uf> userfilter]
[<-GroupSearchBase|-gsb> groupsearchbase]
[<-GroupFilter|-gf> groupfilter]
<-LDAPHostConfigurationName|-lcn> LDAP_host_configuration_name
The following table describes infacmd isp AddNamespace options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set the
-dn domain name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with both
methods, the -dn option takes precedence.
-Password password Required if you specify the user name. Password for the user
-pd name. The password is case sensitive. You can set a
password with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password
with both methods, the password set with the -pd option
takes precedence.
-SecurityDomain security_domain Name of the security domain to which the domain user
-sdn belongs. You can set a security domain with the -sdn option
or the environment variable
INFA_DEFAULT_SECURITY_DOMAIN. If you set a security
domain name with both methods, the -sdn option takes
precedence. The security domain name is case sensitive.
You can specify a value for ‑sdn or use the default based on
the authentication mode:
- Required if the domain uses LDAP authentication. Default
is Native. To work with LDAP authentication, you need to
specify the value for -sdn.
- Optional if the domain uses native authentication or
Kerberos authentication. Default is native for native
authentication. If the domain uses Kerberos authentication,
the default is the LDAP security domain created during
installation. The name of the security domain is the same
as the user realm specified during installation.
-NameSpace namespace Required. Name of the LDAP or Kerberos security domain that
-ns you want to add. The name is not case sensitive and must be
unique within the domain. The name cannot contain spaces
or any of the following special characters:
,+/<>@;\%?
The name cannot exceed 128 characters. The name can
contain an ASCII space character except for the first and last
character. You cannot use any other space characters.
-UserSearchBase usersearchbase Distinguished name (DN) of the entry that serves as the
-usb starting point to search for user names in the LDAP directory
service. The LDAP directory service searches for an object in
the directory according to the path in the distinguished name
of the object.
For example, in Microsoft Active Directory, the distinguished
name of a user object might be
cn=UserName,ou=OrganizationalUnit,dc=DomainName. The
series of relative distinguished names denoted by
dc=DomainName identifies the DNS domain of the object.
-UserFilter userfilter An LDAP query string that specifies the search criteria to
-uf search for users in the directory service. The filter can
specify attribute types, assertion values, and matching
criteria.
For example: The filter (objectclass=*)searches all
objects. The filter(&(objectClass=user)(!
(cn=susan)))searches all user objects except “susan.” For
more information about search filters, see the documentation
for the LDAP directory service.
-GroupSearchBase groupsearchbase Distinguished name (DN) of the entry that serves as the
-gsb starting point to search for group names in the LDAP
directory service.
-GroupFilter groupfilter An LDAP query string that specifies the criteria for searching
-gf for groups in the directory service.
AddNamespace 343
AddNodeResource
Adds a custom resource or a file directory resource to a node.
When a PowerCenter Integration Service runs on a grid, the Load Balancer can use resources to distribute
Session, Command, and predefined Event-Wait tasks. If the PowerCenter Integration Service is configured to
check resources, the Load Balancer distributes tasks to nodes where the resources are added and enabled.
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-NodeName|-nn> node_name
<-ResourceName|-rn> resource_name
[<-ResourceValue|-rv> resource_value]
The following table describes infacmd isp AddNodeResource options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set the
-dn domain name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with both
methods, the -dn option takes precedence.
-UserName user_name Required if the domain uses Native or LDAP authentication. User
-un name to connect to the domain. You can set the user name with
the -un option or the environment variable
INFA_DEFAULT_DOMAIN_USER. If you set a user name with both
methods, the -un option takes precedence.
Optional if the domain uses Kerberos authentication. To run the
command with single sign-on, do not set the user name. If you
set the user name, the command runs without single sign-on.
-Password password Required if you specify the user name. Password for the user
-pd name. The password is case sensitive. You can set a password
with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password with
both methods, the password set with the -pd option takes
precedence.
-SecurityDomain security_domain Required if the domain uses LDAP authentication. Optional if the
-sdn domain uses native authentication or Kerberos authentication.
Name of the security domain to which the domain user belongs.
You can set a security domain with the -sdn option or the
environment variable INFA_DEFAULT_SECURITY_DOMAIN. If you
set a security domain name with both methods, the -sdn option
takes precedence. The security domain name is case sensitive.
If the domain uses native or LDAP authentication, the default is
Native. If the domain uses Kerberos authentication, the default is
the LDAP security domain created during installation. The name
of the security domain is the same as the user realm specified
during installation.
-NodeName node_name Required. Name of the node where you want to add a resource.
-nn
-ResourceName resource_name Required. Name of the resource. The name cannot exceed 79
-rn characters, have leading or trailing spaces, or contains carriage
returns, tabs, or the following characters:
\ / * ? < > " | $
AddNodeResource 345
AddRolePrivilege
Assigns a privilege to a role in the domain. You can assign privileges to a role for the domain. You can also
assign role privileges for each application service in the domain.
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-RoleName|-rn> role_name
<-PrivilegePath|-pp> path_of_privilege
The following table describes infacmd isp AddRolePrivilege options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set the
-dn domain name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with both
methods, the -dn option takes precedence.
-Password password Required if you specify the user name. Password for the user
-pd name. The password is case sensitive. You can set a password
with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password
with both methods, the password set with the -pd option takes
precedence.
-RoleName role_name Required. Name of the role to which you are assigning the
-rn privilege. To enter a name that contains a space or other non-
alphanumeric character, enclose the name in quotation marks.
AddRolePrivilege 347
AddServiceLevel
Adds a service level.
Service levels establish priority among tasks that are waiting to be dispatched. You can create different
service levels that a task developer can assign to workflows.
Each service level you create has a name, dispatch priority, and maximum dispatch wait time. The dispatch
priority is a number that establishes the priority for dispatch. The Load Balancer dispatches high priority
tasks before low priority tasks. The maximum dispatch wait time specifies the amount of time the Load
Balancer waits before it changes the dispatch priority for a task to the highest priority.
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> securitydomain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-ServiceLevelName|-ln> service_level_name
-DomainName domain_name Required. Name of the Informatica domain. You can set the
-dn domain name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with both
methods, the -dn option takes precedence.
-UserName user_name Required if the domain uses Native or LDAP authentication. User
-un name to connect to the domain. You can set the user name with
the -un option or the environment variable
INFA_DEFAULT_DOMAIN_USER. If you set a user name with both
methods, the -un option takes precedence.
Optional if the domain uses Kerberos authentication. To run the
command with single sign-on, do not set the user name. If you
set the user name, the command runs without single sign-on.
-Password password Required if you specify the user name. Password for the user
-pd name. The password is case sensitive. You can set a password
with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password with
both methods, the password set with the -pd option takes
precedence.
-SecurityDomain security_domain Required if the domain uses LDAP authentication. Optional if the
-sdn domain uses native authentication or Kerberos authentication.
Name of the security domain to which the domain user belongs.
You can set a security domain with the -sdn option or the
environment variable INFA_DEFAULT_SECURITY_DOMAIN. If you
set a security domain name with both methods, the -sdn option
takes precedence. The security domain name is case sensitive.
If the domain uses native or LDAP authentication, the default is
Native. If the domain uses Kerberos authentication, the default
is the LDAP security domain created during installation. The
name of the security domain is the same as the user realm
specified during installation.
-ServiceLevel option_name=value Required. The service level properties. You can set the following
-sl properties:
- DispatchPriority. The initial priority for dispatch. Smaller
numbers have higher priority. Priority 1 is the highest priority.
Default is 5.
- MaxDispatchWaitTime. The amount of time in seconds that
can elapse before the Load Balancer changes the dispatch
priority for a task to the highest priority. Default is 1800.
AddUserPrivilege
Assigns a privilege to a user in the domain. You can assign user privileges for each application in the domain.
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
AddUserPrivilege 349
<-ExistingUserName|-eu> existing_user_Name
[<-ExistingUserSecurityDomain|-esd> existing_user_security_domain]
<-ServiceName|-sn> service_name
<-PrivilegePath|-pp> path_of_privilege
The following table describes infacmd isp AddUserPrivilege options and arguments:
AddUserToGroup
Adds a native or LDAP user to a native group in the domain. The user inherits all permissions and privileges
associated with the group.
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
AddUserToGroup 351
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-ExistingUserName|-eu> existing_user_Name
[<-ExistingUserSecurityDomain|-esd> existing_user_security_domain]
<-GroupName|-gn> group_name
The following table describes infacmd isp AddUserToGroup options and arguments:
-Password password Required if you specify the user name. Password for
-pd the user name. The password is case sensitive. You
can set a password with the -pd option or the
environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a
password with both methods, the password set with
the -pd option takes precedence.
-GroupName group_name Required. Name of the group to which you want to add
-gn the user.
AssignDefaultOSProfile
Assigns a default operating system profile to a user or group.
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-OSProfileName|-on> OSProfile_name
<-RecipientName|-nm> recipient_name
<-RecipientSecurityDomain|-ns> security_domain_of_recipient
<-RecipientType|-ty> recipient_type
AssignDefaultOSProfile 353
The following table describes infacmd isp AssignDefaultOSProfile options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set
-dn the domain name with the -dn option or the environment
variable INFA_DEFAULT_DOMAIN. If you set a domain
name with both methods, the -dn option takes
precedence.
-Password password Required if you specify the user name. Password for the
-pd user name. The password is case sensitive. You can set
a password with the -pd option or the environment
variable INFA_DEFAULT_DOMAIN_PASSWORD. If you set
a password with both methods, the password set with
the -pd option takes precedence.
-RecipientSecurityDomain security_domain_of_recipient Required if you use LDAP authentication and you are
-ns granting user permissions. Name of the security domain
that the user belongs to.
AssignedToLicense
Lists the services assigned to a license. You can list services currently assigned to a license.
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-LicenseName|-ln> license_name
AssignedToLicense 355
The following table describes infacmd isp AssignedToLicense options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set the
-dn domain name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with both
methods, the -dn option takes precedence.
-UserName user_name Required if the domain uses Native or LDAP authentication. User
-un name to connect to the domain. You can set the user name with
the -un option or the environment variable
INFA_DEFAULT_DOMAIN_USER. If you set a user name with both
methods, the -un option takes precedence.
Optional if the domain uses Kerberos authentication. To run the
command with single sign-on, do not set the user name. If you set
the user name, the command runs without single sign-on.
-Password password Required if you specify the user name. Password for the user
-pd name. The password is case sensitive. You can set a password
with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password with
both methods, the password set with the -pd option takes
precedence.
-SecurityDomain security_domain Required if the domain uses LDAP authentication. Optional if the
-sdn domain uses native authentication or Kerberos authentication.
Name of the security domain to which the domain user belongs.
You can set a security domain with the -sdn option or the
environment variable INFA_DEFAULT_SECURITY_DOMAIN. If you
set a security domain name with both methods, the -sdn option
takes precedence. The security domain name is case sensitive.
If the domain uses native or LDAP authentication, the default is
Native. If the domain uses Kerberos authentication, the default is
the LDAP security domain created during installation. The name of
the security domain is the same as the user realm specified during
installation.
Permissions allow a group to access objects in a domain. Objects include the domain, folders, nodes, grids,
licenses, and application services. For example, if you assign a group permission on a folder, the group
inherits permission on all objects in the folder.
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-ExistingGroup|-eg> existing_group_name
[<-GroupSecurityDomain|-gsf> group_security_domain]
<-ObjectName|-on> object_name
<-ObjectType|-ot> object_type_SERVICE_LICENSE_NODE_GRID_FOLDER_OSPROFILE
The following table describes infacmd isp AssignGroupPermission options and arguments:
AssignGroupPermission 357
Option Argument Description
AssignISToMMService
Assigns the associated PowerCenter Integration Service for a Metadata Manager Service.
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> securitydomain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-ServiceName|-sn> service_name
<-IntegrationService|-is> integration_service_name
[<-RepositoryUserSecurityDomain|-rsdn> repository_user_security_domain]
<-RepositoryUser|-ru> repository_user
<-RepositoryPassword|-rp> repository_password
The following table describes infacmd isp AssignISToMMService options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set the
-dn domain name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with both
methods, the -dn option takes precedence.
-UserName user_name Required if the domain uses Native or LDAP authentication. User
-un name to connect to the domain. You can set the user name with
the -un option or the environment variable
INFA_DEFAULT_DOMAIN_USER. If you set a user name with both
methods, the -un option takes precedence.
Optional if the domain uses Kerberos authentication. To run the
command with single sign-on, do not set the user name. If you
set the user name, the command runs without single sign-on.
-Password password Required if you specify the user name. Password for the user
-pd name. The password is case sensitive. You can set a password
with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password with
both methods, the password set with the -pd option takes
precedence.
-SecurityDomain security_domain Required if the domain uses LDAP authentication. Optional if the
-sdn domain uses native authentication or Kerberos authentication.
Name of the security domain to which the domain user belongs.
You can set a security domain with the -sdn option or the
environment variable INFA_DEFAULT_SECURITY_DOMAIN. If you
set a security domain name with both methods, the -sdn option
takes precedence. The security domain name is case sensitive.
If the domain uses native or LDAP authentication, the default is
Native. If the domain uses Kerberos authentication, the default is
the LDAP security domain created during installation. The name
of the security domain is the same as the user realm specified
during installation.
AssignISToMMService 359
Option Argument Description
-ServiceName service_name Required. Name of the Metadata Manager Service to which you
-sn want to assign the Integration Service.
-IntegrationService integration_service_na Required. Name of the PowerCenter Integration Service that you
-is me want to associate with the Metadata Manager Service.
-RepositoryPassword repository_password Required. Password for the PowerCenter repository user. User
-rp password. You can set a password with the -rp option or the
environment variable INFA_REPOSITORY_PASSWORD. If you set
a password with both methods, the password set with the -rp
option takes precedence.
AssignLicense
Assigns a license to an application service. You must assign a license to an application service before you
can enable the service.
Note: You cannot assign a license to a service if the service is assigned to another license. To assign a
different license to a service, use the RemoveLicense command to remove the existing license from the
service, and then assign the new license to the service.
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-LicenseName|-ln> license_name
-DomainName domain_name Required. Name of the Informatica domain. You can set the
-dn domain name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with both
methods, the -dn option takes precedence.
-UserName user_name Required if the domain uses Native or LDAP authentication. User
-un name to connect to the domain. You can set the user name with
the -un option or the environment variable
INFA_DEFAULT_DOMAIN_USER. If you set a user name with both
methods, the -un option takes precedence.
Optional if the domain uses Kerberos authentication. To run the
command with single sign-on, do not set the user name. If you
set the user name, the command runs without single sign-on.
-Password password Required if you specify the user name. Password for the user
-pd name. The password is case sensitive. You can set a password
with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password with
both methods, the password set with the -pd option takes
precedence.
-SecurityDomain security_domain Required if the domain uses LDAP authentication. Optional if the
-sdn domain uses native authentication or Kerberos authentication.
Name of the security domain to which the domain user belongs.
You can set a security domain with the -sdn option or the
environment variable INFA_DEFAULT_SECURITY_DOMAIN. If you
set a security domain name with both methods, the -sdn option
takes precedence. The security domain name is case sensitive.
If the domain uses native or LDAP authentication, the default is
Native. If the domain uses Kerberos authentication, the default is
the LDAP security domain created during installation. The name
of the security domain is the same as the user realm specified
during installation.
AssignLicense 361
Option Argument Description
-LicenseName license_name Required. Name of the license you want to assign to a service.
-ln
-ServiceNames service_name1 Required. Names of the services for which you want to assign a
-sn service_name2 ... license. To enter a name that contains a space or other non-
alphanumeric character, enclose the name in quotation marks.
Restart the service to apply changes.
AssignRoleToGroup
Assigns a role to a group for a domain or an application service.
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-GroupName|-gn> group_name
[<-GroupSecurityDomain|-gsf> group_security_domain]
<-RoleName|-rn> role_name
<-ServiceName|-sn> service_name
The following table describes infacmd isp AssignRoleToGroup options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set the
-dn domain name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with both
methods, the -dn option takes precedence.
-Password password Required if you specify the user name. Password for the user
-pd name. The password is case sensitive. You can set a
password with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password
with both methods, the password set with the -pd option
takes precedence.
-GroupName group_name Required. Name of the group to which you are assigning the
-gn role. To enter a name that contains a space or other non-
alphanumeric character, enclose the name in quotation
marks.
-RoleName role_name Required. Name of the role you want to assign to the group.
-rn
-ServiceName service_name Required. Domain or application service name for which you
-sn want to assign the role. To enter a name that contains a
space or other non-alphanumeric character, enclose the name
in quotation marks.
AssignRoleToGroup 363
AssignRoleToUser
Assigns a role to a user for a domain or an application service.
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-ExistingUserName|-eu> existing_user_Name
[<-ExistingUserSecurityDomain|-esd> existing_user_security_domain]
<-RoleName|-rn> role_name
<-ServiceName|-sn> service_name
The following table describes infacmd isp AssignRoleToUser options and arguments:
-Password password Required if you specify the user name. Password for
-pd the user name. The password is case sensitive. You
can set a password with the -pd option or the
environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a
password with both methods, the password set with
the -pd option takes precedence.
-ExistingUserName existing_user_Name Required. User account to which you are assigning the
-eu role. To enter a name that contains a space or other
non-alphanumeric character, enclose the name in
quotation marks.
-RoleName role_name Required. Name of the role you want to assign to the
-rn user.
AssignRSToWSHubService
Associates a PowerCenter repository with a Web Services Hub in the domain.
AssignRSToWSHubService 365
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-ServiceName|-sn> service_name
<-NodeName|-nn> node_name
<-RepositoryService|-rs> repository_service_name
<-RepositoryUser|-ru> user
<-RepositoryPassword|-rp> password
The following table describes infacmd isp AssignRSToWSHubService options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set the
-dn domain name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with
both methods, the -dn option takes precedence.
-Password password Required if you specify the user name. Password for the
-pd user name. The password is case sensitive. You can set a
password with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password
with both methods, the password set with the -pd option
takes precedence.
-ServiceName service_name Required. Name of the Web Services Hub with which you
-sn want to associate a repository.
-NodeName node_name Required. Name of the node where you want the Web
-nn Services Hub process to run. If the PowerCenter
environment is configured for high availability, this option
specifies the name of the primary node.
-RepositoryPassword password Required. User password. User password. You can set a
-rp password with the -rp option or the environment variable
INFA_REPOSITORY_PASSWORD. If you set a password with
both methods, the password set with the -rp option takes
precedence.
AssignUserPermission
Assigns a user permission on an object.
Permissions allow a user to access objects in a domain. Objects include the domain, folders, nodes, grids,
licenses, and application services. For example, if you assign a user permission on a folder, the user inherits
permission on all objects in the folder.
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
AssignUserPermission 367
[<-SecurityDomain|-sdn> security_domain]
[[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-ExistingUserName|-eu> existing_user_name
[<-ExistingUserSecurityDomain|-esd> existing_user_security_domain]
<-ObjectName|-on> object_name
<-ObjectType|-ot> object_type_SERVICE_LICENSE_NODE_GRID_FOLDER_OSPROFILE
The following table describes infacmd isp AssignUserPermission options and arguments:
-Password password Required if you specify the user name. Password for
-pd the user name. The password is case sensitive. You
can set a password with the -pd option or the
environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a
password with both methods, the password set with
the -pd option takes precedence.
-ObjectName object_name Required. Name of the object that you want to assign
-on the user access permission.
ConvertLogFile
Converts binary log files to text files, XML files, or readable text on the screen.
<-InputFile|-in> input_file_name
[<-Format|-fm> format_TEXT_XML]
[<-OutputFile|-lo> output_file_name]
ConvertLogFile 369
The following table describes infacmd isp ConvertLogFile options and arguments:
-InputFile input_file_name Required. Name and path for the log file you want to convert.
-in By default, the Service Manager writes log files to the server\infa_shared
\log directory on the master gateway node.
-OutputFile output_file_name Optional. Name and file path for the output file.
-lo If you do not specify an output file name, infacmd displays the log events
on the screen.
convertUserActivityLogFile
Converts a binary user activity log file retrieved with the getUserActivityLog command to text or XML format.
<-InputFile|-in> input_file_name
[<-Format|-fm> format_TEXT_XML]
[<-OutputFile|-lo> output_file_name]
The following table describes infacmd isp convertUserActivityLogFile options and arguments:
-OutputFile output_file_name Optional. Name of the output file. If you do not specify an
-lo output file name, the command displays the log on the
command line.
To list connection options for an existing connection, run infacmd isp ListConnectionOptions.
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-ConnectionName|-cn> connection_name
[<-ConnectionId|-cid> connection_id]
<-ConnectionType|-ct> connection_type
[<-ConnectionUserName|-cun> connection_user_name]
[<-ConnectionPassword|-cpd> connection_password]
[<-VendorId|-vid> vendor_id]
-DomainName domain_name Required. Name of the Informatica domain. You can set the
-dn domain name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with both
methods, the -dn option takes precedence.
-Password password Required if you specify the user name. Password for the user
-pd name. The password is case sensitive. You can set a
password with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password
with both methods, the password set with the -pd option
takes precedence.
CreateConnection 371
Option Argument Description
-ConnectionName connection_na Name of the connection. The name is not case sensitive and
-cn me must be unique within the domain. It cannot exceed 128
characters, contain spaces, or contain the following special
characters:
~ ` ! $ % ^ & * ( ) - + = { [ } ] | \ : ; " '
< , > . ? /
- ConnectionId connection_id String that the Data Integration Service uses to identify the
-cid connection. The ID is not case sensitive. It must be 255
characters or less and must be unique in the domain. You
cannot change this property after you create the connection.
Default value is the connection name.
CreateConnection 373
Option Argument Description
-ConnectionPassword connection_pa Required. Password for the database user name. You can set
-cpd ssword a password with the -cpd option or the environment variable
INFA_DEFAULT_CONNECTION_PASSWORD, lf you set the
password with both options, the -cpd option takes
precedence.
If you are creating an ADABAS, DB2I, DB2Z, IMS, SEQ, or
VSAM connection, you can enter a valid PowerExchange
passphrase instead of a password. Passphrases for access
to databases and data sets on z/OS can be from 9 to 128
characters in length. Passphrases for access to DB2 for
i5/OS can be up to 31 characters in length. Passphrases can
contain the following characters:
- Uppercase and lowercase letters
- The numbers 0 to 9
- Spaces
- The following special characters:
’ - ; # \ , . / ! % & * ( ) _ + { } : @ | <
> ?
Note: The first character is an apostrophe.
Passphrases cannot include single quotation marks (‘),
double quotation marks (“), or currency symbols.
If a passphrase contains spaces, you must enclose it with
double-quotation marks ("), for example, "This is an
example passphrase". If a passphrase contains special
characters, you must enclose it with triple double-quotation
characters ("""), for example, """This passphrase
contains special characters ! % & *.""". If a
passphrase contains only alphanumeric characters without
spaces, you can enter it without delimiters.
Note: On z/OS, a valid RACF passphrase can be up to 100
characters in length. PowerExchange truncates passphrases
longer than 100 characters when passing them to RACF for
validation.
To use passphrases, ensure that the PowerExchange Listener
runs with a security setting of SECURITY=(1,N) or higher in
the DBMOVER member. For more information, see "SECURITY
Statement" in the PowerExchange Reference Manual.
To use passphrases for IMS connections, ensure that the
following additional requirements are met:
- You must configure ODBA access to IMS as described in
the PowerExchange Navigator User Guide.
- You must use IMS data maps that specify IMS ODBA as the
access method. Do not use data maps that specify the
DL/1 BATCH access method because this access method
requires the use of netport jobs, which do not support
passphrases.
- The IMS database must be online in the IMS control region
to use ODBA access to IMS.
-VendorId vendor_id Optional. ID of the external partner who built the adapter.
-vid
Option Description
CodePage Required. Code to read from or write to the database. Use the ISO code page name, such as
ISO-8859-6. The code page name is not case sensitive.
ArraySize Optional. Determines the number of records in the storage array for the threads when the
worker threads value is greater than 0. Valid values are from 1 through 5000. Default is 25.
Compression Optional. Compresses the data to decrease the amount of data Informatica applications write
over the network. True or false. Default is false.
EncryptionLevel Optional. Level of encryption. If you specify AES for the EncryptionType option, specify one of
the following values to indicate the level of AES encryption:
- 1. Use a 128-bit encryption key.
- 2. Use a 192-bit encryption key.
- 3. Use a 256-bit encryption key.
Default is 1.
Note: If you specify None for encryption type, the Data Integration Service ignores the
encryption level value.
EncryptionType Optional. Controls whether to use encryption. Specify one of the following values:
- None
- AES
Default is None.
InterpretAsRows Optional. If true, the pacing size value represents a number of rows. If false, the pacing size
represents kilobytes. Default is false.
Location Location of the PowerExchange Listener node that can connect to the database. The location
is defined in the first parameter of the NODE statement in the PowerExchange dbmover.cfg
configuration file.
CreateConnection 375
Option Description
OffLoadProcessing Optional. Moves bulk data processing from the source machine to the Data Integration
Service machine.
Enter one of the following values:
- Auto. The Data Integration Service determines whether to use offload processing.
- Yes. Use offload processing.
- No. Do not use offload processing.
Default is Auto.
PacingSize Optional. Slows the data transfer rate in order to reduce bottlenecks. The lower the value, the
greater the session performance. Minimum value is 0. Enter 0 for optimal performance.
Default is 0.
WorkerThread Optional. Number of threads that the Data Integration Service uses to process bulk data when
offload processing is enabled. For optimal performance, this value should not exceed the
number of available processors on the Data Integration Service machine. Valid values are 1
through 64. Default is 0, which disables multithreading.
EnableConnectionPo Optional. Enables connection pooling. When you enable connection pooling, the connection
ol pool retains idle connection instances in memory. When you disable connection pooling, the
Data Integration Service stops all pooling activity. True or false. Default is false.
ConnectionPoolSize Optional. Maximum number of idle connections instances that the Data Integration Service
maintains for a database connection. Set this value to be more than the minimum number of
idle connection instances. Default is 15.
ConnectionPoolMaxI Optional. Number of seconds that a connection exceeding the minimum number of
dleTime connection instances can remain idle before the connection pool drops it. The connection
pool ignores the idletime when it does not exceed the minimum number of idle connection
instances. Default is 120.
ConnectionPoolMinC Optional. Minimum number of idle connection instances that the pool maintains for a
onnections database connection. Set this value to be equal to or less than the idle connection pool size.
Default is 0.
The following table describes the Amazon Kinesis connection options for the infacmd isp CreateConnection:
Property Description
AWS_SECRET_ACCESS_KEY The secret access key for your Amazon AWS user account.
ConnectionTimeOut Number of milliseconds that the Integration service waits to establish a connection to
the Kinesis Stream or Kinesis Firehose after which it times out.
Region Region where the endpoint for your service is available. You can select one of the
following values:
- us-east-2. Indicates the US East (Ohio) region.
- us-east-1. Indicates the US East (N. Virginia) region.
- us-west-1. Indicates the US West (N. California) region.
- us-west-2. Indicates the US West (Oregon) region.
- ap-northeast-1. Indicates the Asia Pacific (Tokyo) region.
- ap-northeast-2. Indicates the Asia Pacific (Seoul) region.
- ap-northeast-3. Indicates the Asia Pacific (Osaka-Local) region.
- ap-south-1. Indicates the Asia Pacific (Mumbai) region.
- ap-southeast-1. Indicates the Asia Pacific (Singapore) region.
- ap-southeast-2. Indicates the Asia Pacific (Sydney) region.
- ca-central-1. Indicates the Canada (Central) region.
- cn-north-1. Indicates the China (Beijing) region.
- cn-northwest-1. Indicates the China (Ningxia) region.
- eu-central-1. Indicates the EU (Frankfurt) region.
- eu-west-1. Indicates the EU (Ireland) region.
- eu-west-2. Indicates the EU (London) region.
- eu-west-3. Indicates the EU (Paris) region.
- sa-east-1. Indicates the South America (São Paulo) region.
ServiceType The type of Kinesis Service that the connection is associated with.
Select one of the following service types:
- Kinesis Firehose. Select this service to write to Kinesis Firehose Delivery Stream.
- Kinesis Streams. Select this service to read from Kinesis Streams.
Profilename Required if you use the AWS credential profile authentication type. An AWS credential
profile defined in the credentials file. A mapping accesses the AWS credentials through
the profile name at run time.
If you do not provide an AWS credential profile name, the mapping uses the access key
ID and secret access key that you specify when you create the connection.
CreateConnection 377
Property Description
RoleArn Required if you use the cross-account IAM role authentication type. The Amazon
Resource Name specifying the role of an IAM user.
ExternalID Required if you use the cross-account IAM role authentication type and if the external ID
is defined by the AWS account. The external ID for an IAM role is an additional
restriction that you can use in an IAM role trust policy to designate who can assume the
IAM role.
The following table describes the mandatory Amazon Redshift connection options for the infacmd isp
CreateConnection and UpdateConnection commands:
Property Description
MasterSymmetricKey Optional. Provide a 256-bit AES encryption key in the Base64 format when you enable client-
side encryption. You can generate a key using a third-party tool.
If you specify a value, ensure that you specify the encryption type as client side encryption in
the advanced target properties.
Region Select the AWS region in which the bucket you want to access resides.
Select one of the following regions:
- Asia Pacific (Mumbai)
- Asia Pacific (Seoul)
- Asia Pacific (Singapore)
- Asia Pacific (Sydney)
- Asia Pacific (Tokyo)
- AWS GovCloud (US)
- Canada (Central)
- China (Beijing)
- China (Ningxia)
- EU (Ireland)
- EU (Frankfurt)
- EU (London)
- EU (Paris)
- South America (Sao Paulo)
- US East (Ohio)
- US East (N. Virginia)
- US West (N. California)
- US West (Oregon)
Default is None.
CustomerMasterKeyID Optional. Specify the customer master key ID or alias name generated by AWS Key
Management Service (AWS KMS). You must generate the customer master key corresponding
to the region where Amazon S3 bucket resides. You can specify any of the following values:
Customer generated customer master key
Enables client-side or server-side encryption. Only the administrator user of the account
can use the default customer master key ID to enable client-side encryption.
Note: You can use customer master key ID when you run a mapping in the native environment
or on the Spark engine.
CreateConnection 379
The following table describes the mandatory Amazon S3 connection options for the infacmd isp
CreateConnection and UpdateConnection commands:
Property Description
SecretKey The secret access key for access to Amazon account resources. The secret key is
associated with the access key and uniquely identifies the account.
Note: Required if you do not use AWS Identity and Access Management (IAM) authentication.
IAMRoleARN The ARN of the IAM role assumed by the user to use the dynamically generated temporary
security credentials.
Enter the value of this property if you want to use the temporary security credentials to
access the AWS resources.
If you want to use the temporary security credentials with IAM authentication, do not provide
the Access Key and Secret Key connection properties. If you want to use the temporary
security credentials without IAM authentication, you must enter the value of the Access Key
and Secret Key connection properties.
For more information about how to obtain the ARN of the IAM role, see the AWS
documentation.
FolderPath The complete path to Amazon S3 objects. The path must include the bucket name and any
folder name.
Do not use a slash at the end of the folder path. For example, <bucket name>/<my folder
name>.
MasterSymmetricKey Optional. Provide a 256-bit AES encryption key in the Base64 format when you enable client-
side encryption. You can generate a master symmetric key using a third-party tool.
RegionName Select the AWS region in which the bucket you want to access resides.
Select one of the following regions:
- Asia Pacific (Mumbai)
- Asia Pacific (Seoul)
- Asia Pacific (Singapore)
- Asia Pacific (Sydney)
- Asia Pacific (Tokyo)
- AWS GovCloud (US)
- Canada (Central)
- China (Beijing)
- China (Ningxia)
- EU (Ireland)
- EU (Frankfurt)
- EU (London)
- EU (Paris)
- South America (Sao Paulo)
- US East (Ohio)
- US East (N. Virginia)
- US West (N. California)
- US West (Oregon)
Default is US East (N. Virginia).
CustomerMasterKeyID Optional. Specify the customer master key ID or alias name generated by AWS Key
Management Service (AWS KMS). You must generate the customer master key for the same
region where Amazon S3 bucket reside.
You can specify any of the following values:
Customer generated customer master key
Enables client-side or server-side encryption. Only the administrator user of the account
can use the default customer master key ID to enable client-side encryption.
Note: Applicable when you run a mapping in the native environment or on the Spark engine.
CreateConnection 381
The following table describes blockchain connection options for infacmd isp CreateConnection and
UpdateConnection commands:
Property Description
swaggerFilePath The absolute path of the swagger file path that contains the REST API to communicate with
the blockchain. The swagger file must be a JSON file that is stored on the Data Integration
Service machine. If the swagger file is in a different file format, such as YAML, convert the
file to JSON format.
authType* Authentication method that the run-time engine uses to connect to the REST server. You can
use none, basic, digest, or OAuth.
authPassword* Password for the user name to authenticate to the REST server.
oAuthConsumerKey* Required for the OAuth authentication type. Client key that is associated with the REST
server.
oAuthConsumerSecret* Required for the OAuth authentication type. Client password to connect to the REST server.
oAuthToken* Required for the OAuth authentication type. Access token to connect to the REST server.
oAuthTokenSecret* Required for the OAuth authentication type. Password associated with the OAuth token.
proxyType* Type of proxy. You can use no proxy, platform proxy, or custom.
trustStoreFilePath* The absolute path of the truststore file that contains the SSL certificate.
keyStoreFilePath* The absolute path of the keystore file that contains the keys and certificates required to
establish a two-way secure connection with the REST server.
advancedProperties List of advanced properties to access an asset on the blockchain. Specify the advanced
properties using name-value pairs that are separated by a semicolon.
You can use the following advanced properties:
- baseUrl. Required if the swagger file does not contain the base URL. The base URL that is
used to access assets on the blockchain.
- X-API-KEY. Required if you authenticate to the REST server using an API key.
The advanced properties that you configure in the connection override the values for the
corresponding advanced properties in the blockchain data object. For example, if the
connection and the data object both specify a base URL, the value in the connection
overrides the value in the data object.
cookies Required based on how the REST API is implemented. List of cookie properties to specify
the cookie information that is passed to the REST server. Specify the properties using
name-value pairs that are separated by a semicolon.
The cookie properties that you configure in the connection override the values for the
corresponding cookie properties in the blockchain data object.
* The property is ignored. To use the functionality, configure the property as an advanced property and provide a name-
value pair based on the property name in the swagger file.
For example, configure the following name-value pair to use basic authorization:
Authorization=Basic <credentials>
The following table describes Cassandra connection options for infacmd isp CreateConnection and
UpdateConnection commands:
Property Description
Password Password corresponding to the user name to access the Cassandra server.
-cpd
CreateConnection 383
Property Description
SQLIDENTIFIERCHARACTER Type of character that the database uses to enclose delimited identifiers in SQL or
CQL queries. The available characters depend on the database type.
Specify None if the database uses regular identifiers. When the Data Integration
Service generates SQL or CQL queries, the service does not place delimited
characters around any identifiers.
Specify a character if the database uses delimited identifiers. When the Data
Integration Service generates SQL or CQL queries, the service encloses delimited
identifiers within this character.
AdditionalConnectionProperties Enter one or more JDBC connection parameters in the following format:
<param1>=<value>;<param2>=<value>;<param3>=<value>
PowerExchange for Cassandra JDBC supports the following JDBC connection
parameters:
- BinaryColumnLength
- DecimalColumnScale
- EnableCaseSensitive
- EnableNullInsert
- EnablePaging
- RowsPerPage
- StringColumnLength
- VTTableNameSeparator
To enter multiple options, separate them with a space. To enter a value that contains a space or other non-
alphanumeric character, enclose the value in quotation marks.
The following table describes Databricks connection options for the infacmd isp CreateConnection and
UpdateConnection commands:
Option Description
connectionId String that the Data Integration Service uses to identify the connection.
The ID is not case sensitive. It must be 255 characters or less and must
be unique in the domain. You cannot change this property after you
create the connection. Default value is the connection name.
name The name of the connection. The name is not case sensitive and must
be unique within the domain. You can change this property after you
create the connection. The name cannot exceed 128 characters,
contain spaces, or contain the following special characters:
~ ` ! $ % ^ & * ( ) - + = { [ } ] | \ : ; " ' < ,
> . ? /
databricksExecutionParameterList Advanced properties that are unique to the Databricks Spark engine.
To enter multiple properties, separate each name-value pair with the
following text: &:.
Use Informatica advanced properties only at the request of Informatica
Global Customer Support.
stagingDirectory The directory where the Databricks Spark engine stages run-time files.
If you specify a directory that does not exist, the Data Integration
Service creates it at run time.
If you do not provide a directory path, the run-time staging files are
written to /<cluster staging directory>/DATABRICKS.
To enter multiple options, separate them with a space. To enter a value that contains a space or other non-
alphanumeric character, enclose the value in quotation marks.
The following table describes DataSift connection options for infacmd isp CreateConnection and
UpdateConnection commands:
Option Description
apiKey API key. The Developer API key is displayed in the Dashboard or
Settings page in the DataSift account.
CreateConnection 385
The following table describes DB2 for i5/OS connection options for infacmd isp CreateConnection and
UpdateConnection commands:
Option Description
EnvironmentSQL Optional. SQL commands to set the database environment when you connect to the
database. The Data Integration Service executes the connection environment SQL each
time it connects to the database.
Note: Enclose special characters in double quotes.
CodePage Required. Code page used to read from a source database or write to a target database
or file.
ArraySize Optional. Determines the number of records in the storage array for the threads when the
worker threads value is greater than 0. Valid values are from 1 through 5000. Default is
25.
Compression Optional. Compresses the data to decrease the amount of data to write over the network.
Default is false.
EncryptionLevel Optional. Level of encryption. If you specify AES for the EncryptionType option, specify
one of the following values to indicate the level of AES encryption:
- 1. Use a 128-bit encryption key.
- 2. Use a 192-bit encryption key.
- 3. Use a 256-bit encryption key.
Default is 1.
Note: If you specify None for encryption type, the Data Integration Service ignores the
encryption level value.
EncryptionType Optional. Controls whether to use encryption. Specify one of the following values:
- None
- AES
Default is None.
InterpretAsRows Optional. Represent pacing size as a number of rows. If false, the pacing size represents
kilobytes. Default is false.
Location Location of the PowerExchange Listener node that can connect to the database. The
location is defined in the first parameter of the NODE statement in the PowerExchange
dbmover.cfg configuration file.
PacingSize Optional. Amount of data the source system can pass to the PowerExchange Listener.
Configure the pacing size if an external application, a database, or the Data Integration
Service node is a bottleneck. The lower the value, the faster the performance.
Minimum value is 0. Enter 0 for maximum performance. Default is 0.
RejectFile Optional. Enter the reject file name and path. Reject files contain rows that were not
written to the database.
DatabaseFileOverrides Specifies the i5/OS database file override. The format is:
from_file/to_library/to_file/to_member
Where:
- from_file is the file to be overridden
- to_library is the new library to use
- to_file is the file in the new library to use
- to_member is optional and is the member in the new library and file to use. *FIRST is
used if nothing is specified.
You can specify up to 8 unique file overrides on a single connection. A single override
applies to a single source or target. When you specify more than one file override,
enclose the string of file overrides in double quotes and include a space between each
file override.
Note: If both LibraryList and DatabaseFileOverrides are specified and a table exists in
both, DatabaseFileOverrides takes precedence.
IsolationLevel Commit scope of the transaction. Select one of the following values:
- None
- CS. Cursor stability.
- RR. Repeatable Read.
- CHG. Change.
- ALL
Default is CS.
LibraryList List of libraries that PowerExchange searches to qualify the table name for Select, Insert,
Delete, or Update statements. PowerExchange searches the list if the table name is
unqualified.
Separate libraries with commas.
Note: If both LibraryList and DatabaseFileOverrides are specified and a table exists in
both, DatabaseFileOverrides takes precedence.
EnableConnectionPool Optional. Enables parallel processing when loading data into a table in bulk mode. Used
for Oracle. True or false. Default is true.
ConnectionPoolSize Optional. Maximum number of idle connections instances that the Data Integration
Service maintains for a database connection. Set this value to be more than the minimum
number of idle connection instances.
CreateConnection 387
Option Description
ConnectionPoolMaxIdleTi Optional. Number of seconds that a connection exceeding the minimum number of
me connection instances can remain idle before the connection pool drops it. The
connection pool ignores the idletime when it does not exceed the minimum number of
idle connection instances.
ConnectionPoolMinConne Optional. Minimum number of idle connection instances that the pool maintains for a
ctions database connection. Set this value to be equal to or less than the idle connection pool
size. Default is 0.
The following table describes DB2Z connection options for infacmd isp CreateConnection and
UpdateConnection commands:
Option Description
EnvironmentSQL Optional. SQL commands to set the database environment when you connect to the
database. The Data Integration Service executes the connection environment SQL each
time it connects to the database.
Note: Enclose special characters in double quotes.
CodePage Required. Code page used to read from a source database or write to a target database
or file.
ArraySize Optional. Determines the number of records in the storage array for the threads when the
worker threads value is greater than 0. Valid values are from 1 through 5000. Default is
25.
Compression Optional. Compresses the data to decrease the amount of data to write over the network.
Default is false.
CorrelationID Optional. Label to apply to a DB2 task or query to allow DB2 for z/OS to account for the
resource. Enter up to 8 bytes of alphanumeric characters.
EncryptionLevel Optional. Level of encryption. If you specify AES for the EncryptionType option, specify
one of the following values to indicate the level of AES encryption:
- 1. Use a 128-bit encryption key.
- 2. Use a 192-bit encryption key.
- 3. Use a 256-bit encryption key.
Default is 1.
Note: If you specify None for encryption type, the Data Integration Service ignores the
encryption level value.
EncryptionType Optional. Controls whether to use encryption. Specify one of the following values:
- None
- AES
Default is None.
InterpretAsRows Optional. Represent pacing size as a number of rows. If false, the pacing size represents
kilobytes. Default is false.
Location Location of the PowerExchange listener node that can connect to the database. The node
is defined in the PowerExchange dbmover.cfg configuration file.
OffloadProcessing Optional. Moves bulk data processing from the VSAM source to the Data Integration
Service machine.
Enter one of the following values:
- Auto. The Data Integration Service determines whether to use offload processing.
- Yes. Use offload processing.
- No. Do not use offload processing.
Default is Auto.
PacingSize Optional. Amount of data the source system can pass to the PowerExchange Listener.
Configure the pacing size if an external application, a database, or the Data Integration
Service node is a bottleneck. The lower the value, the faster the performance.
Minimum value is 0. Enter 0 for maximum performance. Default is 0.
RejectFile Optional. Enter the reject file name and path. Reject files contain rows that were not
written to the database.
WorkerThread Optional. Number of threads that the Data Integration Service uses to process bulk data
when offload processing is enabled. For optimal performance, this value should not
exceed the number of available processors on the Data Integration Service machine.
Valid values are 1 through 64. Default is 0, which disables multithreading.
EnableConnectionPool Optional. Enables parallel processing when loading data into a table in bulk mode. Used
for Oracle. True or false. Default is true.
ConnectionPoolSize Optional. Maximum number of idle connections instances that the Data Integration
Service maintains for a database connection. Set this value to be more than the minimum
number of idle connection instances.
CreateConnection 389
Option Description
ConnectionPoolMaxIdleTi Optional. Number of seconds that a connection exceeding the minimum number of
me connection instances can remain idle before the connection pool drops it. The
connection pool ignores the idletime when it does not exceed the minimum number of
idle connection instances.
ConnectionPoolMinConne Optional. Minimum number of idle connection instances that the pool maintains for a
ctions database connection. Set this value to be equal to or less than the idle connection pool
size. Default is 0.
To enter multiple options, separate them with a space. To enter a value that contains a space or other non-
alphanumeric character, enclose the value in quotation marks.
The following table describes Facebook connection options for infacmd isp CreateConnection and
UpdateConnection commands:
Option Description
ConsumerKey The App ID that you get when you create the application in Facebook.
Facebook uses the key to identify the application.
ConsumerSecret The App Secret that you get when you create the application in
Facebook. Facebook uses the secret to establish ownership of the
consumer key.
AccessToken Access token that the OAuth Utility returns. Facebook uses this token
instead of the user credentials to access the protected resources.
Scope Permissions for the application. Enter the permissions you used to
configure OAuth.
To enter multiple options, separate them with a space. To enter a value that contains a space or other non-
alphanumeric character, enclose the value in quotation marks.
Option Description
UserName Required. User name with permissions to access the Greenplum database.
databaseName Required. Name of the database that you want to connect to.
enableSSL Required. Set this option to true to establish secure communication between the gpload utility
and the Greenplum server over SSL.
SSLCertificatePath Required if you enable SSL. Path where the SSL certificates for the Greenplum server are stored.
For example,
./infacmd.sh createconnection dn Domain_Google -un Administrator -pd Administrator -cn
GA_cmd -ct GOOGLEANALYTICS -o "SERVICEACCOUNTID=serviceaccount@api-
project-12345.iam.gserviceaccount.com SERVICEACCOUNTKEY='---BEGIN PRIVATE KEY---
\nabcd1234322dsa\n---END PRIVATE KEY----\n' PROJECTID=api-project-12333667"
CreateConnection 391
The following table describes Google Analytics connection options for infacmd isp CreateConnection and
UpdateConnection commands:
Property Description
SERVICEACCOUNTID Required. Specifies the client_email value present in the JSON file that you download after
you create a service account.
SERVICEACCOUNTKEY Required. Specifies the private_key value present in the JSON file that you download after
you create a service account.
For example,
./infacmd.sh createconnection dn Domain_Google -un Administrator -pd Administrator -cn
GBQ_cmd -ct BIGQUERY -o "CLIENTEMAIL=serviceaccount@api-
project-12345.iam.gserviceaccount.com PRIVATEKEY='---BEGIN PRIVATE KEY---\nabcd1234322dsa
\n---END PRIVATE KEY----\n' PROJECTID=api-project-80697026669 CONNECTORTYPE=Complex
SCHEMALOCATION='gs://01bucket' STORAGEPATH='gs://01bucket'"
The following table describes Google BigQuery connection options for infacmd isp CreateConnection and
UpdateConnection commands:
Property Description
CLIENTEMAIL Required. Specifies the client_email value present in the JSON file that you download after
you create a service account in Google BigQuery.
PRIVATEKEY Required. Specifies the private_key value present in the JSON file that you download after
you create a service account in Google BigQuery.
Connection Mode Required. The connection mode that you want to use to read data from or write data to
CONNECTORTYPE Google BigQuery.
Enter one of the following connection modes:
- Simple. Flattens each field within the Record data type field as a separate field in the
mapping.
- Hybrid. Displays all the top-level fields in the Google BigQuery table including Record data
type fields. PowerExchange for Google BigQuery displays the top-level Record data type
field as a single field of the String data type in the mapping.
- Complex. Displays all the columns in the Google BigQuery table as a single field of the
String data type in the mapping.
Default is Simple.
Schema Definition Required. Specifies a directory on the client machine where the PowerExchange for Google
File Path BigQuery must create a JSON file with the sample schema of the Google BigQuery table. The
SCHEMALOCATION JSON file name is the same as the Google BigQuery table name.
Alternatively, you can specify a storage path in Google Cloud Storage where the
PowerExchange for Google BigQuery must create a JSON file with the sample schema of the
Google BigQuery table. You can download the JSON file from the specified storage path in
Google Cloud Storage to a local machine.
PROJECTID Required. Specifies the project_id value present in the JSON file that you download after you
create a service account in Google BigQuery.
If you have created multiple projects with the same service account, enter the ID of the
project that contains the dataset that you want to connect to.
For example,
./infacmd.sh createconnection dn Domain_Google -un Administrator -pd Administrator -cn
Spanner_cmd -ct SPANNERGOOGLE -o "CLIENTEMAIL=serviceaccount@api-
project-12345.iam.gserviceaccount.com PRIVATEKEY='---BEGIN PRIVATE KEY---\nabcd1234322dsa
\n---END PRIVATE KEY----\n' INSTANCEID=spanner-testing PROJECTID=api-project-12333667"
The following table describes Google Cloud Spanner connection options for infacmd isp CreateConnection
and UpdateConnection commands:
Property Description
CLIENTEMAIL Required. Specifies the client_email value present in the JSON file that you download after you create
a service account in Google Cloud Spanner.
PRIVATEKEY Required. Specifies the private_key value present in the JSON file that you download after you create
a service account in Google Cloud Spanner.
PROJECTID Required. Specifies the project_id value present in the JSON file that you download after you create a
service account in Google Cloud Spanner.
If you have created multiple projects with the same service account, enter the ID of the project that
contains the dataset that you want to connect to.
INSTANCEID Required. Name of the instance that you created in Google Cloud Spanner.
CreateConnection 393
Google Cloud Storage Connection Options
Use connection options to define the Google Cloud Storage connection.
For example,
./infacmd.sh createconnection dn Domain_Google -un Administrator -pd Administrator -cn
GCS_cmd -ct GOOGLESTORAGEV2 -o "CLIENTEMAIL=serviceaccount@api-
project-12345.iam.gserviceaccount.com PRIVATEKEY='---BEGIN PRIVATE KEY---\nabcd1234322dsa
\n---END PRIVATE KEY----\n' PROJECTID=api-project-12333667"
The following table describes Google Cloud Storage connection options for infacmd isp CreateConnection
and UpdateConnection commands:
Property Description
CLIENTEMAIL Required. Specifies the client_email value present in the JSON file that you download after you create
a service account.
PRIVATEKEY Required. Specifies the private_key value present in the JSON file that you download after you create
a service account.
PROJECTID Required. Specifies the project_id value present in the JSON file that you download after you create a
service account.
If you have created multiple projects with the same service account, enter the ID of the project that
contains the bucket that you want to connect to.
Option Description
connectionId String that the Data Integration Service uses to identify the connection. The ID is
not case sensitive. It must be 255 characters or less and must be unique in the
domain. You cannot change this property after you create the connection. Default
value is the connection name.
name The name of the connection. The name is not case sensitive and must be unique
within the domain. You can change this property after you create the connection.
The name cannot exceed 128 characters, contain spaces, or contain the following
special characters:
~ ` ! $ % ^ & * ( ) - + = { [ } ] | \ : ; " ' < , > . ? /
blazeJobMonitorURL The host name and port number for the Blaze Job Monitor.
Use the following format:
<hostname>:<port>
Where
- <hostname> is the host name or IP address of the Blaze Job Monitor server.
- <port> is the port on which the Blaze Job Monitor listens for remote procedure
calls (RPC).
For example, enter: myhostname:9080
blazeYarnQueueName The YARN scheduler queue name used by the Blaze engine that specifies available
resources on a cluster. The name is case sensitive.
blazeMaxPort The maximum value for the port number range for the Blaze engine.
Default value is 12600
blazeMinPort The minimum value for the port number range for the Blaze engine.
Default value is 12300
blazeUserName The owner of the Blaze service and Blaze service logs.
When the Hadoop cluster uses Kerberos authentication, the default user is the
Data Integration Service SPN user. When the Hadoop cluster does not use
Kerberos authentication and the Blaze user is not configured, the default user is
the Data Integration Service user.
blazeStagingDirectory The HDFS file path of the directory that the Blaze engine uses to store temporary
files. Verify that the directory exists. The YARN user, Blaze engine user, and
mapping impersonation user must have write permission on this directory.
Default is /blaze/workdir. If you clear this property, the staging files are written
to the Hadoop staging directory /tmp/blaze_<user name>.
clusterConfigId The cluster configuration ID associated with the Hadoop cluster. You must enter a
configuration ID to set up a Hadoop connection.
CreateConnection 395
Option Description
hiveStagingDatabaseName Namespace for Hive staging tables. Use the name default for tables that do not
have a specified database name.
engineType Effective in version 10.2.2, Informatica dropped support for the Hive engine. Do
not configure the Hive pushdown configuration properties.
environmentSQL SQL commands to set the Hadoop environment. The Data Integration Service
executes the environment SQL at the beginning of each Hive script generated in a
Hive execution plan.
The following rules and guidelines apply to the usage of environment SQL:
- Use the environment SQL to specify Hive queries.
- Use the environment SQL to set the classpath for Hive user-defined functions
and then use environment SQL or PreSQL to specify the Hive user-defined
functions. You cannot use PreSQL in the data object properties to specify the
classpath. If you use Hive user-defined functions, you must copy the .jar files to
the following directory:<Informatica installation directory>/
services/shared/hadoop/<Hadoop distribution name>/extras/
hive-auxjars
- You can use environment SQL to define Hadoop or Hive parameters that you
want to use in the PreSQL commands or in custom queries.
hadoopRejDir The remote directory where the Data Integration Service moves reject files when
you run mappings.
Enable the reject directory using rejDirOnHadoop.
hiveWarehouseDirectoryOnHDFS Optional. The absolute HDFS file path of the default database for the warehouse
that is local to the cluster.
If you do not configure the Hive warehouse directory, the Hive engine first tries to
write to the directory specified in the cluster configuration property
hive.metastore.warehouse.dir. If the cluster configuration does not have
the property, the Hive engine writes to the default directory /user/hive/
warehouse.
metastoreDatabaseDriver Driver class name for the JDBC data store. For example, the following class name
specifies a MySQL driver:
com.mysql.jdbc.Driver
You can get the value for the Metastore Database Driver from hive-site.xml. The
Metastore Database Driver appears as the following property in hive-site.xml:
<property>
<name>javax.jdo.option.ConnectionDriverName</name>
<value>com.mysql.jdbc.Driver</value>
</property>
metastoreDatabaseURI The JDBC connection URI used to access the data store in a local metastore
setup. Use the following connection URI:
jdbc:<datastore type>://<node name>:<port>/<database name>
where
- <node name> is the host name or IP address of the data store.
- <data store type> is the type of the data store.
- <port> is the port on which the data store listens for remote procedure calls
(RPC).
- <database name> is the name of the database.
For example, the following URI specifies a local metastore that uses MySQL as a
data store:
jdbc:mysql://hostname23:3306/metastore
You can get the value for the Metastore Database URI from hive-site.xml. The
Metastore Database URI appears as the following property in hive-site.xml:
<property>
<name>javax.jdo.option.ConnectionURL</name>
<value>jdbc:mysql://MYHOST/metastore</value>
</property>
CreateConnection 397
Option Description
remoteMetastoreURI The metastore URI used to access metadata in a remote metastore setup. For a
remote metastore, you must specify the Thrift server details.
Use the following connection URI:
thrift://<hostname>:<port>
Where
- <hostname> is name or IP address of the Thrift metastore server.
- <port> is the port on which the Thrift server is listening.
For example, enter: thrift://myhostname:9083/
You can get the value for the Remote Metastore URI from hive-site.xml. The
Remote Metastore URI appears as the following property in hive-site.xml:
<property>
<name>hive.metastore.uris</name>
<value>thrift://<n.n.n.n>:9083</value>
<description> IP address or fully-qualified domain name and
port of the metastore host</description>
</property>
rejDirOnHadoop Enables hadoopRejDir. Used to specify a location to move reject files when you run
mappings.
If enabled, the Data Integration Service moves mapping files to the HDFS location
listed in hadoopRejDir.
By default, the Data Integration Service stores the mapping files based on the
RejectDir system parameter.
sparkEventLogDir Optional. The HDFS file path of the directory that the Spark engine uses to log
events.
sparkStagingDirectory The HDFS file path of the directory that the Spark engine uses to store temporary
files for running jobs. The YARN user, Data Integration Service user, and mapping
impersonation user must have write permission on this directory.
By default, the temporary files are written to the Hadoop staging directory /tmp/
spark_<user name>.
sparkYarnQueueName The YARN scheduler queue name used by the Spark engine that specifies available
resources on a cluster. The name is case sensitive.
stgDataCompressionCodecClas Codec class name that enables data compression and improves performance on
s temporary staging tables. The codec class name corresponds to the code type.
To enter multiple options, separate them with a space. To enter a value that contains a space or other non-
alphanumeric character, enclose the value in quotation marks.
CreateConnection 399
The following table describes the HBase connection options for infacmd isp CreateConnection and
UpdateConnection commands:
Option Description
DATABASETYPE Required when you create an HBase connection for a MapR-DB table. Set the value to MapR-DB.
Default is HBase.
clusterConfigId The cluster configuration ID associated with the Hadoop cluster. You must enter a configuration ID
to set up a Hadoop connection.
To enter multiple options, separate them with a space. To enter a value that contains a space or other non-
alphanumeric character, enclose the value in quotation marks.
The following table describes the HDFS connection options for infacmd isp CreateConnection and
UpdateConnection commands:
Option Description
clusterConfigId The cluster configuration ID associated with the Hadoop cluster. You
must enter a configuration ID to set up a Hadoop connection.
Option Description
name The name of the connection. The name is not case sensitive and must be unique
within the domain. You can change this property after you create the connection.
The name cannot exceed 128 characters, contain spaces, or contain the following
special characters:
~ ` ! $ % ^ & * ( ) - + = { [ } ] | \ : ; " ' < , > . ? /
relationalSourceAndTarget Hive connection mode. Set this option to true if you want to use the connection to
access the Hive data warehouse. If you want to access Hive target, you need to
enable the same connection or another Hive connection to run the mapping in the
Hadoop cluster.
If you enable relational source and target, you must provide the
metadataDatabaseString option.
pushDownMode Hive connection mode. Set this option to true if you want to use the connection to
run mappings in the Hadoop cluster.
If you enable the connection for pushdown mode, you must provide the options to
run the Informatica mappings in the Hadoop cluster.
environmentSQL SQL commands to set the Hadoop environment. In native environment type, the
Data Integration Service executes the environment SQL each time it creates a
connection to Hive metastore. If the Hive connection is used to run mappings in
the Hadoop cluster, the Data Integration Service executes the environment SQL at
the beginning of each Hive session.
The following rules and guidelines apply to the usage of environment SQL in both
the connection modes:
- Use the environment SQL to specify Hive queries.
- Use the environment SQL to set the classpath for Hive user-defined functions
and then use either environment SQL or PreSQL to specify the Hive user-defined
functions. You cannot use PreSQL in the data object properties to specify the
classpath. If you use Hive user-defined functions, you must copy the .jar files to
the following directory:
<Informatica installation directory>/services/shared/hadoop/
<Hadoop distribution name>/extras/hive-auxjars
- You can also use environment SQL to define Hadoop or Hive parameters that
you intend to use in the PreSQL commands or in custom queries.
If the Hive connection is used to run mappings in the Hadoop cluster, only the
environment SQL of the Hive connection is executed. The different environment
SQL commands for the connections of the Hive source or target are not executed,
even if the Hive sources and targets are on different clusters.
quoteChar The type of character used to identify special characters and reserved SQL
keywords, such as WHERE. The Data Integration Service places the selected
character around special characters and reserved SQL keywords. The Data
Integration Service also uses this character for the Support mixed-case identifiers
property.
clusterConfigId The cluster configuration ID associated with the Hadoop cluster. You must enter a
configuration ID to set up a Hadoop connection.
CreateConnection 401
Properties to Access Hive as Source or Target
The following table describes the mandatory options for infacmd isp CreateConnection and
UpdateConnection commands that you configure when you want to use the Hive connection to access Hive
data:
Property Description
metadataConnString The JDBC connection URI used to access the metadata from the Hadoop server.
The connection string uses the following format:
jdbc:hive://<hostname>:<port>/<db>
Where
- hostname is name or IP address of the machine on which the Hive server is
running.
- port is the port on which the Hive server is listening.
- db is the database to which you want to connect. If you do not provide the
database details, the Data Integration Service uses the default database
details.
To connect to HiveServer 2, use the connection string format that Apache Hive
implements for that specific Hadoop Distribution. For more information about
Apache Hive connection string formats, see the Apache Hive documentation.
If the Hadoop cluster uses SSL or TLS authentication, you must add ssl=true to
the JDBC connection URI. For example: jdbc:hive2://
<hostname>:<port>/<db>;ssl=true
If you use self-signed certificate for SSL or TLS authentication, ensure that the
certificate file is available on the client machine and the Data Integration Service
machine. For more information, see the Informatica Big Data Management Cluster
Integration Guide.
bypassHiveJDBCServer JDBC driver mode. Enable this option to use the embedded JDBC driver
(embedded mode).
To use the JDBC embedded mode, perform the following tasks:
- Verify that Hive client and Informatica Services are installed on the same
machine.
- Configure the Hive connection properties to run mappings in the Hadoop
cluster.
If you choose the non-embedded mode, you must configure the Data Access
Connection String.
The JDBC embedded mode is preferred to the non-embedded mode.
sqlAuthorized When you select the option to observe fine-grained SQL authentication in a Hive
source, the mapping observes row and column-level restrictions on data access.
If you do not select the option, the Blaze run-time engine ignores the restrictions,
and results include restricted data.
Applicable to Hadoop clusters where Sentry or Ranger security modes are
enabled.
connectString The connection string used to access data from the Hadoop data store. The non-
embedded JDBC mode connection string must be in the following format:
jdbc:hive://<hostname>:<port>/<db>
Where
- hostname is name or IP address of the machine on which the Hive server is
running.
- port is the port on which the Hive server is listening. Default is 10000.
- db is the database to which you want to connect. If you do not provide the
database details, the Data Integration Service uses the default database
details.
To connect to HiveServer 2, use the connection string format that Apache Hive
implements for that specific Hadoop Distribution. For more information about
Apache Hive connection string formats, see the Apache Hive documentation.
If the Hadoop cluster uses SSL or TLS authentication, you must add ssl=true to
the JDBC connection URI. For example: jdbc:hive2://
<hostname>:<port>/<db>;ssl=true
If you use self-signed certificate for SSL or TLS authentication, ensure that the
certificate file is available on the client machine and the Data Integration Service
machine. For more information, see the Informatica Big Data Management Cluster
Integration Guide.
CreateConnection 403
Properties to Run Mappings in the Hadoop Cluster
The following table describes the mandatory options for infacmd isp CreateConnection and
UpdateConnection commands that you configure when you want to use the Hive connection to run
Informatica mappings in the Hadoop cluster:
Property Description
databaseName Namespace for tables. Use the name default for tables that do not have a
specified database name.
stgDataCompressionCodecClass Codec class name that enables data compression and improves performance
on temporary staging tables. The codec class name corresponds to the code
type.
Option Description
PassThruEnabled Optional. Enables pass-through security for the connection. When you enable pass-
through security for a connection, the domain uses the client user name and password to
log into the corresponding database, instead of the credentials defined in the connection
object.
MetadataAccessConnect Required. JDBC connection URL used to access metadata from the database.
String jdbc:informatica:db2://<host name>:<port>;DatabaseName=<database
name>
When you import a table from the Developer tool or Analyst tool, by default, all tables are
displayed under the default schema name. To view tables under a specific schema instead
of the default schema, you can specify the schema name from which you want to import
the table. Include the ischemaname parameter in the URL to specify the schema name. For
example, use the following syntax to import a table from a specific schema:
jdbc:informatica:db2://<host name>:<port>;DatabaseName=<database
name>;ischemaname=<schema_name>
To search for a table in multiple schemas and import it, you can specify multiple schema
names in the ischemaname parameter. The schema name is case sensitive. You cannot
use special characters when you specify multiple schema names. Use the pipe (|)
character to separate multiple schema names. For example, use the following syntax to
search for a table in three schemas and import it:
jdbc:informatica:db2://<host name>:<port>;DatabaseName=<database
name>;ischemaname=<schema_name1>|<schema_name2>|<schema_name3>
AdvancedJDBCSecurityO Optional. Database parameters for metadata access to a secure database. Informatica
ptions treats the value of the AdvancedJDBCSecurityOptions field as sensitive data and encrypts
the parameter string.
To connect to a secure database, include the following parameters:
- EncryptionMethod. Required. Indicates whether data is encrypted when transmitted over
the network. This parameter must be set to SSL.
- ValidateServerCertificate. Optional. Indicates whether Informatica validates the
certificate that is sent by the database server.
If this parameter is set to True, Informatica validates the certificate that is sent by the
database server. If you specify the HostNameInCertificate parameter, Informatica also
validates the host name in the certificate.
If this parameter is set to false, Informatica does not validate the certificate that is sent
by the database server. Informatica ignores any truststore information that you specify.
- HostNameInCertificate. Optional. Host name of the machine that hosts the secure
database. If you specify a host name, Informatica validates the host name included in
the connection string against the host name in the SSL certificate.
- TrustStore. Required. Path and file name of the truststore file that contains the SSL
certificate for the database.
- TrustStorePassword. Required. Password for the truststore file for the secure database.
Note: For a complete list of the secure JDBC parameters, see the DataDirect JDBC
documentation.
Informatica appends the secure JDBC parameters to the connection string. If you include
the secure JDBC parameters directly in the connection string, do not enter any parameters
in the AdvancedJDBCSecurityOptions field.
CreateConnection 405
Option Description
CodePage Required. Code page used to read from a source database or write to a target database.
EnvironmentSQL Optional. SQL commands to set the database environment when you connect to the
database. The Data Integration Service executes the connection environment SQL each
time it connects to the database.
For example, ALTER SESSION SET CURRENT_SCHEMA=INFA_USR;
Note: Enclose special characters in double quotes.
TransactionSQL Optional. SQL commands to execute before each transaction. The Data Integration Service
executes the transaction SQL at the beginning of each transaction.
For example, SET TRANSACTION ISOLATION LEVEL SERIALIZABLE;
Note: Enclose special characters in double quotes.
QuoteChar Optional. The character that you will use for quotes in this connection.
The type of character used to identify special characters and reserved SQL keywords, such
as WHERE. The Data Integration Service places the selected character around special
characters and reserved SQL keywords. The Data Integration Service also uses this
character for the QuoteChar property. Default is 0.
EnableConnectionPool Optional. Enables connection pooling. When you enable connection pooling, the
connection pool retains idle connection instances in memory. When you disable
connection pooling, the Data Integration Service stops all pooling activity. Valid values are
True or False. Default is True.
ConnectionPoolSize Optional. Maximum number of idle connections instances that the Data Integration
Service maintains for a database connection. Set this value to be more than the minimum
number of idle connection instances. Default is 15.
ConnectionPoolMaxIdleT Optional. Number of seconds that a connection exceeding the minimum number of
ime connection instances can remain idle before the connection pool drops it. The connection
pool ignores the idletime when it does not exceed the minimum number of idle connection
instances. Default is 120.
ConnectionPoolMinConn Optional. Minimum number of idle connection instances that the pool maintains for a
ections database connection. Set this value to be equal to or less than the idle connection pool
size. Default is 0.
Option Description
CodePage Required. Code to read from or write to the database. Use the ISO code page name, such as
ISO-8859-6. The code page name is not case sensitive.
ArraySize Optional. Determines the number of records in the storage array for the threads when the
worker threads value is greater than 0. Valid values are from 1 through 5000. Default is 25.
Compression Optional. Compresses the data to decrease the amount of data Informatica applications write
over the network. True or false. Default is false.
EncryptionLevel Optional. Level of encryption. If you specify AES for the EncryptionType option, specify one of
the following values to indicate the level of AES encryption:
- 1. Use a 128-bit encryption key.
- 2. Use a 192-bit encryption key.
- 3. Use a 256-bit encryption key.
Default is 1.
Note: If you specify None for encryption type, the Data Integration Service ignores the
encryption level value.
EncryptionType Optional. Controls whether to use encryption. Specify one of the following values:
- None
- AES
Default is None.
InterpretAsRows Optional. If true, the pacing size value represents a number of rows. If false, the pacing size
represents kilobytes. Default is false.
Location Location of the PowerExchange Listener node that can connect to the database. The location
is defined in the first parameter of the NODE statement in the PowerExchange dbmover.cfg
configuration file.
OffLoadProcessing Optional. Moves bulk data processing from the source machine to the Data Integration
Service machine.
Enter one of the following values:
- Auto. The Data Integration Service determines whether to use offload processing.
- Yes. Use offload processing.
- No. Do not use offload processing.
Default is Auto.
PacingSize Optional. Slows the data transfer rate in order to reduce bottlenecks. The lower the value, the
greater the session performance. Minimum value is 0. Enter 0 for optimal performance.
Default is 0.
WorkerThread Optional. Number of threads that the Data Integration Service uses to process bulk data when
offload processing is enabled. For optimal performance, this value should not exceed the
number of available processors on the Data Integration Service machine. Valid values are 1
through 64. Default is 0, which disables multithreading.
CreateConnection 407
Option Description
EnableConnectionPo Optional. Enables connection pooling. When you enable connection pooling, the connection
ol pool retains idle connection instances in memory. When you disable connection pooling, the
Data Integration Service stops all pooling activity. True or false. Default is false.
ConnectionPoolSize Optional. Maximum number of idle connections instances that the Data Integration Service
maintains for a database connection. Set this value to be more than the minimum number of
idle connection instances. Default is 15.
ConnectionPoolMaxI Optional. Number of seconds that a connection exceeding the minimum number of
dleTime connection instances can remain idle before the connection pool drops it. The connection
pool ignores the idletime when it does not exceed the minimum number of idle connection
instances. Default is 120.
ConnectionPoolMinC Optional. Minimum number of idle connection instances that the pool maintains for a
onnections database connection. Set this value to be equal to or less than the idle connection pool size.
Default is 0.
To enter multiple options, separate options with spaces. To enter a value that contains a space or other non-
alphanumeric character, enclose the value in quotation marks.
Option Description
JDBCDriverClassName The Java class that you use to connect to the database.
The following list provides the driver class name that you can enter for the applicable
database type:
- DataDirect JDBC driver class name for Oracle:
com.informatica.jdbc.oracle.OracleDriver
- DataDirect JDBC driver class name for IBM DB2:
com.informatica.jdbc.db2.DB2Driver
- DataDirect JDBC driver class name for Microsoft SQL Server:
com.informatica.jdbc.sqlserver.SQLServerDriver
- DataDirect JDBC driver class name for Sybase ASE:
com.informatica.jdbc.sybase.SybaseDriver
- DataDirect JDBC driver class name for Informix:
com.informatica.jdbc.informix.InformixDriver
- DataDirect JDBC driver class name for MySQL:
com.informatica.jdbc.mysql.MySQLDriver
For more information about which driver class to use with specific databases, see the vendor
documentation.
EnvironmentSQL Optional. SQL commands to set the database environment when you connect to the
database. The Data Integration Service executes the connection environment SQL each time
it connects to the database.
For example, ALTER SESSION SET CURRENT_SCHEMA=INFA_USR;
Note: Enclose special characters in double quotation marks.
TransactionSQL Optional. SQL commands to execute before each transaction. The Data Integration Service
executes the transaction SQL at the beginning of each transaction.
For example, SET TRANSACTION ISOLATION LEVEL SERIALIZABLE;
Note: Enclose special characters in double quotes.
CreateConnection 409
Option Description
QuoteChar Optional. The character that you will use for quotes in this connection.
The type of character used to identify special characters and reserved SQL keywords, such
as WHERE. The Data Integration Service places the selected character around special
characters and reserved SQL keywords. The Data Integration Service also uses this character
for the QuoteChar property. Default is DOUBLE_QUOTE.
hadoopConnector Required if you want to enable Sqoop connectivity for the data object that uses the JDBC
connection. The Data Integration Service runs the mapping in the Hadoop run-time
environment through Sqoop.
You can configure Sqoop connectivity for relational data objects, customized data objects,
and logical data objects that are based on a JDBC-compliant database.
Set the value to SQOOP_146 to enable Sqoop connectivity.
hadoopConnectorArgs Optional. Enter the arguments that Sqoop must use to connect to the database. Enclose the
Sqoop arguments within single quotes. Separate multiple arguments with a space.
For example, hadoopConnectorArgs='--<Sqoop argument 1> --<Sqoop argument
2>'
To read data from or write data to Teradata through Teradata Connector for Hadoop (TDCH)
specialized connectors for Sqoop, define the TDCH connection factory class in the
hadoopConnectorArgs argument. The connection factory class varies based on the TDCH
Sqoop Connector that you want to use.
- To use Cloudera Connector Powered by Teradata, configure the hadoopConnectorArgs
argument as follows:
hadoopConnectorArgs='-
Dsqoop.connection.factories=com.cloudera.connector.teradata.Teradata
ManagerFactory'
- To use Hortonworks Connector for Teradata (powered by the Teradata Connector for
Hadoop), configure the hadoopConnectorArgs argument as follows:
hadoopConnectorArgs='-
Dsqoop.connection.factories=org.apache.sqoop.teradata.TeradataManage
rFactory'
If you do not enter Sqoop arguments, the Data Integration Service constructs the Sqoop
command based on the JDBC connection properties.
For example,
./infacmd.sh createConnection -dn Domain_irl63ppd06 -un Administrator -pd SAM123 -cn
PostgreSQL -cid PostgreSQL -ct JDBC_V2 -cun
adaptersX1 -cpd adaptersX1 -o "connectionstring=' jdbc:postgresql://aurorapostgres-
appsdk.c5wj9sntucrg.ap-south-1.rds.amazonaws.com:5432/
JDBCV2' jdbcdriverclassname='org.postgresql.Driver' schemaname='public'
subtype='PostgreSQL' supportmixedcaseidentifier='true'
quoteChar='(quotes)'"
The following table describes JDBC V2 connection options for infacmd isp CreateConnection and
UpdateConnection commands:
Option Description
CreateConnection 411
Option Description
supportmixedcaseidentifier Enable if the database uses case-sensitive identifiers. When enabled, the Data
Integration Service encloses all identifiers within the character selected for the SQL
Identifier Character property.
For example, PostgreSQL database supports mixed-cased characters. You must enable
this property to connect to the PostgreSQL database.
When the SQL Identifier Character property is set to none, the Support Mixed-case
Identifiers property is disabled.
quoteChar Type of character that the database uses to enclose delimited identifiers in SQL
queries. The available characters depend on the database type.
Select (None) if the database uses regular identifiers. When the Data Integration Service
generates SQL queries, the service does not place delimited characters around any
identifiers.
Select a character if the database uses delimited identifiers. When the Data Integration
Service generates SQL queries, the service encloses delimited identifiers within this
character.
For example,
infacmd.bat createConnection -dn DomainName -un Domain_UserName -pd Domain_Pwd -cn
conName -cid
conID -ct JDEE1 -o userName=JDEE1_DB_UserName password=JDEE1_DB_Pwd
enterpriseServer=JDE_ServerName
enterprisePort=JDE_DB_Port environment=JDE_Environment role=role
JDBCUserName=JDEE1_DB_UserName
JDBCPassword=JDEE1_DB_Pwd JDBCCONNECTIONSTRING='DB connection string'
JDBCDriverClassName='jdbc driver classname'
To enter multiple options, separate them with a space. To enter a value that contains a space or other
nonalphanumeric character, enclose the value in quotation marks.
The following table describes the mandatory JD Edwards EnterpriseOne connection options for the infacmd
isp CreateConnection and UpdateConnection commands:
Property Description
password Password for the JD Edwards EnterpriseOne user name. The password is case
sensitive.
enterpriseServer The host name of the JD Edwards EnterpriseOne server that you want to access.
environment Name of the JD Edwards EnterpriseOne environment you want to connect to.
To enter multiple options, separate them with a space. To enter a value that contains a space or other non-
alphanumeric character, enclose the value in quotation marks.
The following table describes Kafka connection options for infacmd isp CreateConnection and
UpdateConnection commands:
Option Description
connectionId String that the Data Integration Service uses to identify the connection.
The ID is not case sensitive. It must be 255 characters or less and must
be unique in the domain. You cannot change this property after you
create the connection. Default value is the connection name.
name Required. The name of the connection. The name is not case sensitive
and must be unique within the domain. You can change this property
after you create the connection. The name cannot exceed 128
characters, contain spaces, or contain the following special characters:
~ ` ! $ % ^ & * ( ) - + = { [ } ] | \ : ; " ' < ,
> . ? /
kafkaBrokerVersion The version of the Kafka messaging broker. You can enter one of the
following values:
- 0.10.1.x-2.0.0
kfkBrkList The IP address and port combinations of the Kafka messaging system
broker list. The IP address and port combination has the following
format:
<IP Address>:<port>
CreateConnection 413
... -o option_name=value option_name=value ...
For example,
infacmd.sh createConnection -dn DomainName -un Domain_UserName -pd Domain_Pwd -cn
conname -cid conname -ct ldap -o
hostName=hostIPAddress port=port_number userName=ldapUserName password=LDAPPWD
To enter multiple options, separate them with a space. To enter a value that contains a space or other
nonalphanumeric character, enclose the value in quotation marks.
The following table describes the mandatory LDAP connection options for the infacmd isp CreateConnection
and UpdateConnection commands:
Property Description
hostName The host name of the LDAP directory server that you want to access.
password Password for the LDAP user name. The password is case sensitive.
To enter multiple options, separate them with a space. To enter a value that contains a space or other non-
alphanumeric character, enclose the value in quotation marks.
The following table describes LinkedIn connection options for infacmd isp CreateConnection and
UpdateConnection commands:
Option Description
ConsumerKey The API key that you get when you create the application in LinkedIn.
LinkedIn uses the key to identify the application.
ConsumerSecret The Secret key that you get when you create the application in LinkedIn.
LinkedIn uses the secret to establish ownership of the consumer key.
AccessToken Access token that the OAuth Utility returns. The LinkedIn application
uses this token instead of the user credentials to access the protected
resources.
AccessSecret Access secret that the OAuth Utility returns. The secret establishes
ownership of a token.
The following table describes the HBase connection options for MapR-DB for the infacmd isp
CreateConnection and UpdateConnection commands:
Option Description
DATABASETYPE Required. Set the value to MapR-DB and enclose the value in single quotes.
clusterConfigId The cluster configuration ID associated with the Hadoop cluster. You must enter a configuration ID
to set up an HBase connection for MapR-DB.
maprdbpath Required. Set the value to the database path that contains the MapR-DB table that you want to
connect to. Enter a valid MapR cluster path. Enclose the value in single quotes.
When you create an HBase data object for MapR-DB, you can browse only tables that exist in the
path that you specify in this option. You cannot access tables that are available in sub-directories
in the specified path.
For example, if you specify the maprdbpath as /user/customers/, you can access the tables in
the customers directory. However, if the customers directory contains a sub-directory named
regions, you cannot access the tables in the following directory:
/user/customers/regions
To enter multiple options, separate them with a space. To enter a value that contains a space or non-
alphanumeric character, enclose the value in quotation marks.
The following table describes the Microsoft Azure Blob Storage Connection options for the infacmd isp
CreateConnection and UpdateConnection commands:
Option Description
authenticationtype Authorization type. You can select any of the following authorization mechanisms:
- Shared Key Authorization
- Shared Access Signatures
enspointSuffix Type of Microsoft Azure end-points. You can specify any of the following end-points:
- core.windows.net: Default
- core.usgovcloudapi.net: To select the US government Microsoft Azure end-points
- core.chinacloudapi.cn: Not applicable
CreateConnection 415
Microsoft Azure Data Lake Storage Gen1 Connection Options
Use connection options to define a Microsoft Azure Data Lake Storage Gen1 Connection.
To enter multiple options, separate them with a space. To enter a value that contains a space or non-
alphanumeric character, enclose the value in quotation marks.
The following table describes the Microsoft Azure Data Lake Storage Gen1 Connection options for the
infacmd isp CreateConnection and UpdateConnection commands:
Option Description
ADLSAccountName Microsoft Azure Data Lake Storage Gen1 account name or the service name.
ClientId The ID of your application to complete the OAuth Authentication in the Active Directory.
ClientSecret The client secret key to complete the OAuth Authentication in the Active Directory.
Directory Path of an existing directory under given file system. The default is root directory.
AuthEndpoint The OAuth 2.0 token endpoint from where access code is generated based on the Client ID and
Client secret is completed.
For more information about creating a client ID and client secret, contact the Azure administrator or see
Microsoft Azure Data Lake Storage Gen1 documentation.
To enter multiple options, separate them with a space. To enter a value that contains a space or non-
alphanumeric character, enclose the value in quotation marks.
The following table describes the Microsoft Azure Data Lake Storage Gen2 Connection options for the
infacmd isp CreateConnection and UpdateConnection commands:
Option Description
accountName Microsoft Azure Data Lake Storage Gen2 account name or the service name.
clientID The ID of your application to complete the OAuth Authentication in the Active Directory.
clientSecret Client secret key to complete the OAuth Authentication in the Active Directory.
fileSystemName Name of an existing file system in Microsoft Azure Data Lake Storage Gen2.
directoryPath Path of an existing directory under given file system. The default is root directory.
For more information about creating a client ID, client secret, tenant ID, and file system name, contact the
Azure administrator or see Microsoft Azure Data Lake Storage Gen2 documentation.
To enter multiple options, separate them with a space. To enter a value that contains a space or non-
alphanumeric character, enclose the value in quotation marks.
The following table describes the Microsoft Azure SQL Data Warehouse Connection options for the infacmd
isp CreateConnection and UpdateConnection commands:
Option Description
JdbcUrl Microsoft Azure SQL Data Warehouse JDBC connection string. For example, you can enter the
following connection string:
jdbc:sqlserver://<Server>.database.windows.net:1433;database=<Database>
JdbcUsername User name to connect to the Microsoft Azure SQL Data Warehouse account.
JdbcPassword Password to connect to the Microsoft Azure SQL Data Warehouse account.
BlobAccountName Name of the Microsoft Azure Storage account to stage the files.
EndPointSuffix Type of Microsoft Azure end-points. You can specify any of the following end-points:
- core.windows.net: Default
- core.usgovcloudapi.net: To select the US government Microsoft Azure end-points
- core.chinacloudapi.cn: Not applicable
VNetRule Enable to connect to a Microsoft Azure SQL Data Warehouse endpoint residing in a virtual
network (VNet).
CreateConnection 417
To enter multiple options, separate them with a space. To enter a value that contains a space or other non-
alphanumeric character, enclose the value in quotation marks.
The following table describes Microsoft SQL Server connection options for the infacmd isp CreateConnection
and UpdateConnection commands:
Option Description
UseTrustedConnection Optional. The Integration Service uses Windows authentication to access the
Microsoft SQL Server database. The user name that starts the Integration Service must
be a valid Windows user with access to the Microsoft SQL Server database. True or
false. Default is false.
PassThruEnabled Optional. Enables pass-through security for the connection. When you enable pass-
through security for a connection, the domain uses the client user name and password
to log into the corresponding database, instead of the credentials defined in the
connection object.
AdvancedJDBCSecurityOpti Optional. Database parameters for metadata access to a secure database. Informatica
ons treats the value of the AdvancedJDBCSecurityOptions field as sensitive data and
encrypts the parameter string.
To connect to a secure database, include the following parameters:
- EncryptionMethod. Required. Indicates whether data is encrypted when transmitted
over the network. This parameter must be set to SSL.
- ValidateServerCertificate. Optional. Indicates whether Informatica validates the
certificate that is sent by the database server.
If this parameter is set to True, Informatica validates the certificate that is sent by
the database server. If you specify the HostNameInCertificate parameter,
Informatica also validates the host name in the certificate.
If this parameter is set to false, Informatica does not validate the certificate that is
sent by the database server. Informatica ignores any truststore information that you
specify.
- HostNameInCertificate. Optional. Host name of the machine that hosts the secure
database. If you specify a host name, Informatica validates the host name included
in the connection string against the host name in the SSL certificate.
- TrustStore. Required. Path and file name of the truststore file that contains the SSL
certificate for the database.
- TrustStorePassword. Required. Password for the truststore file for the secure
database.
Note: For a complete list of the secure JDBC parameters, see the DataDirect JDBC
documentation.
Informatica appends the secure JDBC parameters to the connection string. If you
include the secure JDBC parameters directly to the connection string, do not enter any
parameters in the AdvancedJDBCSecurityOptions field.
DataAccessConnectString Required. Connection string used to access data from the database.
Enter the connection string in the following format:
<server name>@<database name>
DomainName Optional. The name of the domain where Microsoft SQL Server is running.
PacketSize Optional. Increase the network packet size to allow larger packets of data to cross the
network at one time.
CodePage Required. Code to read from or write to the database. Use the ISO code page name,
such as ISO-8859-6. The code page name is not case sensitive.
UseDSN Required. Determines whether the Data Integration Service must use the Data Source
Name for the connection.
If you set the option value to true, the Data Integration Service retrieves the database
name and server name from the DSN.
If you set the option value to false, you must enter the database name and server
name.
ProviderType Required. The connection provider that you want to use to connect to the Microsoft
SQL Server database.
You can define one of the following values:
- 0. Set the value to 0 if you want to use the ODBC provider type. Default is 0.
- 1. Set the value to 1 if you want to use the OLEDB provider type.
CreateConnection 419
Option Description
SchemaName Optional. The name of the schema in the database. You must specify the schema
name for the Profiling Warehouse if the schema name is different from the database
user name. You must specify the schema name for the data object cache database if
the schema name is different from the database user name and if you configure user-
managed cache tables.
EnvironmentSQL Optional. SQL commands to set the database environment when you connect to the
database. The Data Integration Service executes the connection environment SQL each
time it connects to the database.
For example, ALTER SESSION SET CURRENT_SCHEMA=INFA_USR;
Note: Enclose special characters in double quotes.
TransactionSQL Optional. SQL commands to execute before each transaction. The Data Integration
Service executes the transaction SQL at the beginning of each transaction.
For example, SET TRANSACTION ISOLATION LEVEL SERIALIZABLE;
Note: Enclose special characters in double quotes.
QuoteChar Optional. The character that you will use for quotes in this connection.
The type of character used to identify special characters and reserved SQL keywords,
such as WHERE. The Data Integration Service places the selected character around
special characters and reserved SQL keywords. The Data Integration Service also uses
this character for the QuoteChar property. Default is 0.
EnableConnectionPool Optional. Enables connection pooling. When you enable connection pooling, the
connection pool retains idle connection instances in memory. When you disable
connection pooling, the Data Integration Service stops all pooling activity. Valid values
are True or False. Default is True.
ConnectionPoolSize Optional. Maximum number of idle connections instances that the Data Integration
Service maintains for a database connection. Set this value to be more than the
minimum number of idle connection instances. Default is 15.
ConnectionPoolMaxIdleTim Optional. Number of seconds that a connection exceeding the minimum number of
e connection instances can remain idle before the connection pool drops it. The
connection pool ignores the idletime when it does not exceed the minimum number of
idle connection instances. Default is 120.
ConnectionPoolMinConnecti Optional. Minimum number of idle connection instances that the pool maintains for a
ons database connection. Set this value to be equal to or less than the idle connection
pool size. Default is 0.
The following table describes Microsoft Dynamics CRM connection options for infacmd isp
CreateConnection and UpdateConnection commands:
Option Description
AuthenticationType Required. Authentication type for the connection. Provide one of the following
authentication types:
- Passport. Often used for online deployment and online deployment combined
with Internet-facing deployment of Microsoft Dynamics CRM.
- Claims-based. Often used for on-premise and Internet-facing deployment of
Microsoft Dynamics CRM.
- Active directory. Often used for on-premise deployment of Microsoft
Dynamics CRM.
Domain Required. Domain to which the user belongs. You must provide the complete
domain name. For example, msd.sampledomain.com.
Configure domain for active directory and claims-based authentication.
Note: If you select Passport authentication type, you must provide a dummy
value for Domain.
OrganizationName Required. Microsoft Dynamics CRM organization name. Organization names are
case sensitive.
For Microsoft Live authentication, use the Microsoft Live Organization Unique
Name.
To find the Organization Unique Name, log in to the Microsoft Live instance and
click Settings > Customization > Developer Resources
SecurityTokenService Required. Microsoft Dynamics CRM security token service URL. For example,
https://sts1.<company>.com.
Configure for claims-based authentication.
Note: If you select Passport or Active Directory authentication type, you must
provide a dummy value for SecurityTokenService.
CreateConnection 421
Option Description
UseMetadataConfigForDataAccess Select this option if the configuration file and server file are in the same
directory.
If the server file is in a different directory, uncheck this option and specify the
directory path in the Data Access field. Provide one of the following values:
- true for checked
- false for unchecked
KeyStoreFileName Contains the keys and certificates required for secure communication.
If you want to use the Java cacerts file, clear this field.
TrustStoreFileName Set the INFA_TRUSTSTORE in the environment variables. The directory must
contain the truststore file infa_truststore.jks. If the file is not available at
the path specified, the Data Integration Service checks for the certificate in the
Java cacerts file.
If you want to use the Java cacerts file, clear this field.
To enter multiple options, separate them with a space. To enter a value that contains a space or other non-
alphanumeric character, enclose the value in quotation marks.
The following table describes the Netezza connection options for infacmd isp CreateConnection and
UpdateConnection commands:
Option Description
connectionString Required. Name of the ODBC data source that you create to connect to the Netezza database.
jdbcUrl Required. JDBC URL that the Developer tool must use when it connects to the Netezza database.
Use the following format:
jdbc:netezza://<hostname>:<port>/<database name>
username Required. User name with the appropriate permissions to access the Netezza database.
timeout Required. Number of seconds that the Developer tool waits for a response from the Netezza
database before it closes the connection.
To enter multiple options, separate them with a space. To enter a value that contains a space or other non-
alphanumeric character, enclose the value in quotation marks.
The following table describes the OData connection options for infacmd isp CreateConnection and
UpdateConnection commands:
Property Description
URL Required. OData service root URL that exposes the data that you want to read.
securityType Optional. Security protocol that the Developer tool must use to establish a secure connection
with the OData server.
Enter one of the following values:
- None
- SSL
- TLS
CreateConnection 423
The following table describes ODBC connection options for infacmd isp CreateConnection and
UpdateConnection commands:
Option Description
PassThruEnabled Optional. Enables pass-through security for the connection. When you
enable pass-through security for a connection, the domain uses the client
user name and password to log into the corresponding database, instead
of the credentials defined in the connection object.
CodePage Required. Code page used to read from a source database or write to a
target database or file.
EnvironmentSQL Optional. SQL commands to set the database environment when you
connect to the database. The Data Integration Service executes the
connection environment SQL each time it connects to the database.
For example, ALTER SESSION SET CURRENT_SCHEMA=INFA_USR;
Note: Enclose special characters in double quotes.
TransactionSQL Optional. SQL commands to execute before each transaction. The Data
Integration Service executes the transaction SQL at the beginning of each
transaction.
For example, SET TRANSACTION ISOLATION LEVEL SERIALIZABLE;
Note: Enclose special characters in double quotes.
QuoteChar Optional. The character that you will use for quotes in this connection.
The type of character used to identify special characters and reserved SQL
keywords, such as WHERE. The Data Integration Service places the
selected character around special characters and reserved SQL keywords.
The Data Integration Service also uses this character for the QuoteChar
property. Default is 4.
ODBC Provider Optional. The type of database to which the Data Integration Service
connects using ODBC. For pushdown optimization, specify the database
type to enable the Data Integration Service to generate native database
SQL. The options are as follows:
- Other
- Sybase
- Microsoft_SQL_Server
- Teradata
- Netezza
- Greenplum
Default is Other.
ConnectionPoolSize Optional. Maximum number of idle connections instances that the Data
Integration Service maintains for a database connection. Set this value to
be more than the minimum number of idle connection instances. Default is
15.
ConnectionPoolMinConnections Optional. Minimum number of idle connection instances that the pool
maintains for a database connection. Set this value to be equal to or less
than the idle connection pool size. Default is 0.
The following table describes Oracle connection options for infacmd isp CreateConnection and
UpdateConnection commands:
Option Description
PassThruEnabled Optional. Enables pass-through security for the connection. When you enable
pass-through security for a connection, the domain uses the client user name
and password to log into the corresponding database, instead of the credentials
defined in the connection object.
MetadataAccessConnectString JDBC connection URL used to access metadata from the database.
jdbc:informatica:oracle://<host_name>:<port>;SID=<database name>
CreateConnection 425
Option Description
CodePage Required. Code page used to read from a source database or write to a target
database or file.
EnvironmentSQL Optional. SQL commands to set the database environment when you connect to
the database. The Data Integration Service executes the connection
environment SQL each time it connects to the database.
For example, ALTER SESSION SET CURRENT_SCHEMA=INFA_USR;
Note: Enclose special characters in double quotes.
TransactionSQL Optional. SQL commands to execute before each transaction. The Data
Integration Service executes the transaction SQL at the beginning of each
transaction.
For example, SET TRANSACTION ISOLATION LEVEL SERIALIZABLE;
Note: Enclose special characters in double quotes.
EnableParallelMode Optional. Enables parallel processing when loading data into a table in bulk
mode. Used for Oracle. True or false. Default is false.
QuoteChar Optional. The character that you will use for quotes in this connection.
The type of character used to identify special characters and reserved SQL
keywords, such as WHERE. The Data Integration Service places the selected
character around special characters and reserved SQL keywords. The Data
Integration Service also uses this character for the QuoteChar property. Default
is 0.
EnableConnectionPool Optional. Enables connection pooling. When you enable connection pooling, the
connection pool retains idle connection instances in memory. When you disable
connection pooling, the Data Integration Service stops all pooling activity. Valid
values are True or False. Default is True.
ConnectionPoolSize Optional. Maximum number of idle connections instances that the Data
Integration Service maintains for a database connection. Set this value to be
more than the minimum number of idle connection instances. Default is 15.
ConnectionPoolMaxIdleTime Optional. Number of seconds that a connection exceeding the minimum number
of connection instances can remain idle before the connection pool drops it.
The connection pool ignores the idletime when it does not exceed the minimum
number of idle connection instances. Default is 120.
ConnectionPoolMinConnections Optional. Minimum number of idle connection instances that the pool maintains
for a database connection. Set this value to be equal to or less than the idle
connection pool size. Default is 0.
CreateConnection 427
To enter multiple options, separate them with a space. To enter a value that contains a space or other non-
alphanumeric character, enclose the value in quotation marks.
The following table describes Salesforce connection options for infacmd isp CreateConnection and
UpdateConnection commands:
Option Description
Password Password for the Salesforce user name. The password is case sensitive.
To access Salesforce outside the trusted network of your organization, you must
append a security token to your password to log in to the API or a desktop client.
To receive or reset your security token, log in to Salesforce and click Setup > My
Personal Information > Reset My Security Token.
Refresh Token For OAuth Salesforce connection. The Refresh Token of Salesforce generated using
the Consumer Key and Consumer Secret.
Consumer Key For OAuth Salesforce connection. The Consumer Key obtained from Salesforce,
required to generate the Refresh Token. For more information about how to generate
the Consumer Key, see the Salesforce documentation.
Consumer Secret For OAuth Salesforce connection. The Consumer Secret obtained from Salesforce,
required to generate the Refresh Token. For more information about how to generate
the Consumer Secret, see the Salesforce documentation.
Service URL URL of the Salesforce service that you want to access. In a test or development
environment, you might want to access the Salesforce Sandbox testing environment.
For more information about the Salesforce Sandbox, see the Salesforce
documentation.
To enter multiple options, separate them with a space. To enter a value that contains a space or other non-
alphanumeric character, enclose the value in quotation marks.
The following table describes Salesforce Marketing Cloud connection options for infacmd.sh
createConnection, updateConnection, and remove commands:
Domain Name Informatica domain where you want to create the connection.
Connection ID The Data Integration Service uses the ID to identify the connection.
Salesforce Marketing Cloud Url The URL that the Data Integration Service uses to connect to the
Salesforce Marketing Cloud WSDL.
The following URL is an example for OAuth 1.0 URL:
https://webservice.s7.exacttarget.com/etframework.wsdl
The following URL is an example for OAuth 2.0 URL:
https://<SUBDOMAIN>.soap.marketingcloudapis.com/
etframework.wsdl
Informatica recommends that you upgrade to OAuth 2.0 before Salesforce
Marketing Cloud drops support for OAuth 1.0.
Enable Logging When you enable logging you can see the session log for the tasks.
UTC Offset The Secure Agent uses the UTC offset connection property to read data
from and write data to Salesforce Marketing Cloud in UTC offset time
zone.
Batch Size Number of rows that the Secure Agent writes in a batch to the target.
When you insert or update data and specify the contact key, the data
associated with the specified contact ID is inserted or updated in a batch
to Salesforce Marketing Cloud. When you upsert data to Salesforce
Marketing Cloud, do not specify the contact key.
CreateConnection 429
SAPAPPLICATIONS Connection Options
Use connection options to define the SAPAPPLICATIONS connection.
The following table describes SAPAPPLICATIONS connection options for infacmd isp CreateConnection and
UpdateConnection commands:
Option Description
The following table describes SEQ connection options for infacmd isp CreateConnection and
UpdateConnection commands:
Option Description
CodePage Required. Code to read from or write to the sequential file. Use the ISO code page name,
such as ISO-8859-6. The code page name is not case sensitive.
ArraySize Optional. Determines the number of records in the storage array for the threads when the
worker threads value is greater than 0. Valid values are from 1 through 5000. Default is 25.
Compression Optional. Compresses the data to decrease the amount of data that Informatica
applications write over the network. True or false. Default is false.
EncryptionLevel Optional. Level of encryption. If you specify AES for the EncryptionType option, specify one
of the following values to indicate the level of AES encryption:
- 1. Use a 128-bit encryption key.
- 2. Use a 192-bit encryption key.
- 3. Use a 256-bit encryption key.
Default is 1.
Note: If you specify None for encryption type, the Data Integration Service ignores the
encryption level value.
EncryptionType Optional. Enter one of the following values for the encryption type:
- None
- AES
Default is None.
Optional. Controls whether to use encryption. Specify one of the following values:
- None
- AES
Default is None.
InterpretAsRows Optional. If true, the pacing size value represents a number of rows. If false, the pacing
size represents kilobytes. Default is false.
Location Location of the PowerExchange Listener node that can connect to the data source. The
location is defined in the first parameter of the NODE statement in the PowerExchange
dbmover.cfg configuration file.
OffLoadProcessing Optional. Moves bulk data processing from the data source machine to the Data
Integration Service machine.
Enter one of the following values:
- Auto. The Data Integration Service determines whether to use offload processing.
- Yes. Use offload processing.
- No. Do not use offload processing.
Default is Auto.
PacingSize Optional. Slows the data transfer rate in order to reduce bottlenecks. The lower the value,
the greater the session performance. Minimum value is 0. Enter 0 for optimal performance.
Default is 0.
WorkerThread Optional. Number of threads that the Data Integration Service uses to process bulk data
when offload processing is enabled. For optimal performance, this value should not
exceed the number of available processors on the Data Integration Service machine. Valid
values are 1 through 64. Default is 0, which disables multithreading.
EnableConnectionPool Optional. Enables connection pooling. When you enable connection pooling, the
connection pool retains idle connection instances in memory. When you disable
connection pooling, the Data Integration Service stops all pooling activity. True or false.
Default is false.
CreateConnection 431
Option Description
ConnectionPoolSize Optional. Maximum number of idle connections instances that the Data Integration Service
maintains for a database connection. Set this value to be more than the minimum number
of idle connection instances. Default is 15.
ConnectionPoolMaxIdle Optional. Number of seconds that a connection exceeding the minimum number of
Time connection instances can remain idle before the connection pool drops it. The connection
pool ignores the idletime when it does not exceed the minimum number of idle connection
instances. Default is 120.
ConnectionPoolMinCon Optional. Minimum number of idle connection instances that the pool maintains for a
nections database connection. Set this value to be equal to or less than the idle connection pool
size. Default is 0.
For example,
./infacmd.sh createconnection -dn Domain_Snowflake -un Administartor -pd Administrator -
cn Snowflake_CLI -ct SNOWFLAKE -o "user=INFAADPQA password=passwd account=informatica
role=ROLE_PC_AUTO warehouse=QAAUTO_WH"
To enter multiple options, separate them with a space. To enter a value that contains a space or other
nonalphanumeric character, enclose the value in quotation marks.
The following table describes the mandatory Snowflake connection options for the infacmd isp
CreateConnection and UpdateConnection commands:
Property Description
connectionId String that the Data Integration Service uses to identify the connection.
additionalparam Enter one or more JDBC connection parameters in the following format:
<param1>=<value>&<param2>=<value>&<param3>=<value>....
For example:
user=jon&warehouse=mywh&db=mydb&schema=public
The following table describes the mandatory Tableau connection options for the infacmd isp
CreateConnection and UpdateConnection commands:
Connection Description
Property
Tableau Product The name of the Tableau product to which you want to connect.
You can choose one of the following Tableau products to publish the TDE or TWBX file:
- Tableau Desktop. Creates a TDE file in the Data Integration Service machine. You can then
manually import the TDE file to Tableau Desktop.
- Tableau Server. Publishes the generated TDE or TWBX file to Tableau Server.
- Tableau Online. Publishes the generated TDE or TWBX file to Tableau Online.
Connection URL URL of Tableau Server or Tableau Online to which you want to publish the TDE or TWBX file. The
URL has the following format: http://<Host name of Tableau Server or Tableau
Online>:<port>
User Name User name of the Tableau Server or Tableau Online account.
Content URL The name of the site on Tableau Server or Tableau Online where you want to publish the TDE or
TWBX file.
Contact the Tableau administrator to provide the site name.
CreateConnection 433
For example,
./infacmd.sh createConnection -dn Domain -un Username -pd Password -cn Connection name -
ct tableau_server -ct TABLEAU V3 -o "connectionURL= site= password=
tableauProduct='Tableau Server' username="
To enter multiple options, separate options with spaces. To enter a value that contains a space or other non-
alphanumeric character, enclose the value in quotation marks.
The following table describes the mandatory Tableau V3 connection options for the infacmd isp
CreateConnection and UpdateConnection commands:
Connection Description
Property
Tableau Product The name of the Tableau product to which you want to connect.
You can choose one of the following Tableau products to publish the .hyper or TWBX file:
Tableau Desktop
Creates a .hyper file in the Data Integration Service machine. You can then manually import
the .hyper file to Tableau Desktop.
Tableau Server
Tableau Online
Publishes the generated .hyper or TWBX file to Tableau Online.
Connection URL The URL of Tableau Server or Tableau Online to which you want to publish the .hyper or TWBX
file.
Enter the URL in the following format: http://<Host name of Tableau Server or Tableau
Online>:<port>
User Name The user name of the Tableau Server or Tableau Online account.
Password The password for the Tableau Server or Tableau Online account.
Site ID The ID of the site on Tableau Server or Tableau Online where you want to publish the or TWBX file.
Note: Contact the Tableau administrator to provide the site ID.
Schema File The path to a sample .hyper file from where the Data Integration Service imports the Tableau
Path metadata.
Enter one of the following options for the schema file path:
- Absolute path to the .hyper file.
- Directory path for the .hyper files.
- Empty directory path.
The path you specify for the schema file becomes the default path for the target .hyper file. If
you do not specify a file path, the Data Integration Service uses the following default file path for
the target .hyper file:
<Data Integration Service installation directory>/apps/
Data_Integration_Server/<latest version>/bin/rtdm
To enter multiple options, separate them with a space. To enter a value that contains a space or other non-
alphanumeric character, enclose the value in quotation marks.
The following table describes Teradata PT connection options for infacmd isp CreateConnection and
UpdateConnection commands:
Option Description
UserName Required. Teradata database user name with the appropriate write
permissions to access the database.
Tenacity Optional. Number of hours that Teradata PT API continues trying to log on
when the maximum number of operations run on the Teradata database.
Must be a positive, non-zero integer. Default is 4.
MinSessions Optional. Minimum number of Teradata PT API sessions required for the
Teradata PT API job to continue.
Must be a positive integer between 1 and the Max Sessions value. Default is
1.
Sleep Optional. Number of minutes that Teradata PT API pauses before it retries to
log on when the maximum number of operations run on the Teradata
database.
Must be a positive, non-zero integer. Default is 6.
useMetadataJdbcUrl Optional.
Set this option to true to Indicate that the Teradata Connector for Hadoop
(TDCH) must use the JDBC URL that you specified in the connection string.
Set this option to false to specify a different JDBC URL that TDCH must use
when it runs the mapping.
CreateConnection 435
Option Description
tdchJdbcUrl Required.
JDBC URL that TDCH must use when it runs the mapping.
dataEncryption Required.
Enables full security encryption of SQL requests, responses, and data on
Windows.
To enable data encryption on Unix, add the command
UseDataEncryption=Yes to the DSN in the odbc.ini file.
hadoopConnector Required if you want to enable Sqoop connectivity for the data object that
uses the JDBC connection. The Data Integration Service runs the mapping in
the Hadoop run-time environment through Sqoop.
You can configure Sqoop connectivity for relational data objects, customized
data objects, and logical data objects that are based on a JDBC-compliant
database.
Set the value to SQOOP_146 to enable Sqoop connectivity.
hadoopConnectorArgs Optional. Enter the arguments that Sqoop must use to connect to the
database. Enclose the Sqoop arguments within single quotes. Separate
multiple arguments with a space.
For example, hadoopConnectorArgs='--<Sqoop argument 1> --
<Sqoop argument 2>'
To read data from or write data to Teradata through Teradata Connector for
Hadoop (TDCH) specialized connectors for Sqoop, define the TDCH
connection factory class in the hadoopConnectorArgs argument. The
connection factory class varies based on the TDCH Sqoop Connector that
you want to use.
- To use Cloudera Connector Powered by Teradata, configure the
hadoopConnectorArgs argument as follows:
hadoopConnectorArgs='-
Dsqoop.connection.factories=com.cloudera.connector.terad
ata.TeradataManagerFactory'
- To use Hortonworks Connector for Teradata (powered by the Teradata
Connector for Hadoop), configure the hadoopConnectorArgs argument as
follows:
hadoopConnectorArgs='-
Dsqoop.connection.factories=org.apache.sqoop.teradata.Te
radataManagerFactory'
If you do not enter Sqoop arguments, the Data Integration Service constructs
the Sqoop command based on the JDBC connection properties.
To enter multiple options, separate them with a space. To enter a value that contains a space or other non-
alphanumeric character, enclose the value in quotation marks.
The following table describes Twitter connection options for infacmd isp CreateConnection and
UpdateConnection commands:
Option Description
ConsumerKey The consumer key that you get when you create the application in
Twitter. Twitter uses the key to identify the application.
ConsumerSecret The consumer secret that you get when you create the Twitter
application. Twitter uses the secret to establish ownership of the
consumer key.
AccessToken Access token that the OAuth Utility returns. Twitter uses this token
instead of the user credentials to access the protected resources.
AccessSecret Access secret that the OAuth Utility returns. The secret establishes
ownership of a token.
To enter multiple options, separate them with a space. To enter a value that contains a space or other non-
alphanumeric character, enclose the value in quotation marks.
The following table describes Twitter Streaming connection options for infacmd isp CreateConnection and
UpdateConnection commands:
Option Description
HoseType Streaming API methods. You can specify the following methods:
- Filter. The Twitter statuses/filter method returns public
statuses that match the search criteria.
- Sample. The Twitter statuses/sample method returns a random
sample of all public statuses.
CreateConnection 437
The following table describes VSAM connection options for infacmd isp CreateConnection and
UpdateConnection commands:
Option Description
CodePage Required. Code to read from or write to the VSAM file. Use the ISO code page name, such
as ISO-8859-6. The code page name is not case sensitive.
ArraySize Optional. Determines the number of records in the storage array for the threads when the
worker threads value is greater than 0. Valid values are from 1 through 5000. Default is 25.
Compression Optional. Compresses the data to decrease the amount of data Informatica applications
write over the network. True or false. Default is false.
EncryptionLevel Optional. Level of encryption. If you specify AES for the EncryptionType option, specify one
of the following values to indicate the level of AES encryption:
- 1. Use a 128-bit encryption key.
- 2. Use a 192-bit encryption key.
- 3. Use a 256-bit encryption key.
Default is 1.
Note: If you specify None for encryption type, the Data Integration Service ignores the
encryption level value.
EncryptionType Optional. Controls whether to use encryption. Specify one of the following values:
- None
- AES
Default is None.
InterpretAsRows Optional. If true, the pacing size value represents a number of rows. If false, the pacing
size represents kilobytes. Default is false.
Location Location of the PowerExchange listener node that can connect to VSAM. The node is
defined in the PowerExchange dbmover.cfg configuration file.
OffLoadProcessing Optional. Moves bulk data processing from the VSAM source to the Data Integration
Service machine.
Enter one of the following values:
- Auto. The Data Integration Service determines whether to use offload processing.
- Yes. Use offload processing.
- No. Do not use offload processing.
Default is Auto.
PacingSize Optional. Slows the data transfer rate in order to reduce bottlenecks. The lower the value,
the greater the session performance. Minimum value is 0. Enter 0 for optimal performance.
Default is 0.
WorkerThread Optional. Number of threads that the Data Integration Service uses to process bulk data
when offload processing is enabled. For optimal performance, this value should not
exceed the number of available processors on the Data Integration Service machine. Valid
values are 1 through 64. Default is 0, which disables multithreading.
EnableConnectionPool Optional. Enables connection pooling. When you enable connection pooling, the
connection pool retains idle connection instances in memory. When you disable
connection pooling, the Data Integration Service stops all pooling activity. True or false.
Default is false.
ConnectionPoolSize Optional. Maximum number of idle connections instances that the Data Integration Service
maintains for a database connection. Set this value to be more than the minimum number
of idle connection instances. Default is 15.
ConnectionPoolMaxIdle Optional. Number of seconds that a connection exceeding the minimum number of
Time connection instances can remain idle before the connection pool drops it. The connection
pool ignores the idletime when it does not exceed the minimum number of idle connection
instances. Default is 120.
ConnectionPoolMinCon Optional. Minimum number of idle connection instances that the pool maintains for a
nections database connection. Set this value to be equal to or less than the idle connection pool
size. Default is 0.
To enter multiple options, separate them with a space. To enter a value that contains a space or other non-
alphanumeric character, enclose the value in quotation marks.
The following table describes Web Content-Kapow Katalyst connection options for infacmd isp
CreateConnection and UpdateConnection commands:
Option Description
ManagementConsoleURL URL of the Local Management Console where the robot is uploaded.
The URL must start with http or https. For example, http://localhost:50080.
RQLServicePort The port number where the socket service listens for the RQL service.
Enter a value from 1 through 65535. Default is 50000.
CreateConnection 439
CreateFolder
Creates a folder in the domain. When you create a folder, infacmd creates the folder in the domain or folder
you specify.
You can use folders to organize objects and to manage security. Folders can contain nodes, services, grids,
licenses, and other folders.
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-FolderName|-fn> folder_name
<-FolderPath|-fp> full_folder_path
[<-FolderDescription|-fd> description_of_folder]
The following table describes infacmd isp CreateFolder options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set the
-dn domain name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with both
methods, the -dn option takes precedence.
-UserName user_name Required if the domain uses Native or LDAP authentication. User
-un name to connect to the domain. You can set the user name with
the -un option or the environment variable
INFA_DEFAULT_DOMAIN_USER. If you set a user name with both
methods, the -un option takes precedence.
Optional if the domain uses Kerberos authentication. To run the
command with single sign-on, do not set the user name. If you
set the user name, the command runs without single sign-on.
-Password password Required if you specify the user name. Password for the user
-pd name. The password is case sensitive. You can set a password
with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password
with both methods, the password set with the -pd option takes
precedence.
-SecurityDomain security_domain Required if the domain uses LDAP authentication. Optional if the
-sdn domain uses native authentication or Kerberos authentication.
Name of the security domain to which the domain user belongs.
You can set a security domain with the -sdn option or the
environment variable INFA_DEFAULT_SECURITY_DOMAIN. If you
set a security domain name with both methods, the -sdn option
takes precedence. The security domain name is case sensitive.
If the domain uses native or LDAP authentication, the default is
Native. If the domain uses Kerberos authentication, the default
is the LDAP security domain created during installation. The
name of the security domain is the same as the user realm
specified during installation.
-FolderName folder_name Required. Name of the folder. Folder names must be unique
-fn within a folder or the domain. It cannot contain spaces or
exceed 79 characters in length.
-FolderPath full_folder_path Required. Full path, excluding the domain name, where you want
-fp to create the folder. Must be in the following format:
/parent_folder/child_folder
CreateGrid
Creates a grid in the domain and assigns nodes to the grid. Create a grid to distribute jobs to service
processes running on nodes in the grid.
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
CreateGrid 441
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-GridName|-gn> grid_name
[<-FolderPath|-fp> full_folder_path]
The following table describes infacmd isp CreateGrid options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set the
-dn domain name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with both
methods, the -dn option takes precedence.
-UserName user_name Required if the domain uses Native or LDAP authentication. User
-un name to connect to the domain. You can set the user name with
the -un option or the environment variable
INFA_DEFAULT_DOMAIN_USER. If you set a user name with both
methods, the -un option takes precedence.
Optional if the domain uses Kerberos authentication. To run the
command with single sign-on, do not set the user name. If you
set the user name, the command runs without single sign-on.
-Password password Required if you specify the user name. Password for the user
-pd name. The password is case sensitive. You can set a password
with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password
with both methods, the password set with the -pd option takes
precedence.
-SecurityDomain security_domain Required if the domain uses LDAP authentication. Optional if the
-sdn domain uses native authentication or Kerberos authentication.
Name of the security domain to which the domain user belongs.
You can set a security domain with the -sdn option or the
environment variable INFA_DEFAULT_SECURITY_DOMAIN. If you
set a security domain name with both methods, the -sdn option
takes precedence. The security domain name is case sensitive.
If the domain uses native or LDAP authentication, the default is
Native. If the domain uses Kerberos authentication, the default
is the LDAP security domain created during installation. The
name of the security domain is the same as the user realm
specified during installation.
-NodeList node1 node2 ... Required. Names of the nodes you want to assign to the grid.
-nl
-FolderPath full_folder_path Optional. Full path, excluding the domain name, to the folder in
-fp which you want to create the grid. Must be in the following
format:
/parent_folder/child_folder
Default is “/” (the domain).
CreateGroup
Creates a group in the native security domain. You can assign roles, permissions, and privileges to a group in
the native or an LDAP security domain. The roles, permissions, and privileges assigned to the group
determines the tasks that users in the group can perform within the domain.
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-GroupName|-gn> group_name
[<-GroupDescription|-ds> group_description]
The following table describes infacmd isp CreateGroup options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set the
-dn domain name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with both
methods, the -dn option takes precedence.
-UserName user_name Required if the domain uses Native or LDAP authentication. User
-un name to connect to the domain. You can set the user name with
the -un option or the environment variable
INFA_DEFAULT_DOMAIN_USER. If you set a user name with both
methods, the -un option takes precedence.
Optional if the domain uses Kerberos authentication. To run the
command with single sign-on, do not set the user name. If you
set the user name, the command runs without single sign-on.
CreateGroup 443
Option Argument Description
-Password password Required if you specify the user name. Password for the user
-pd name. The password is case sensitive. You can set a password
with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password with
both methods, the password set with the -pd option takes
precedence.
-SecurityDomain security_domain Required if the domain uses LDAP authentication. Optional if the
-sdn domain uses native authentication or Kerberos authentication.
Name of the security domain to which the domain user belongs.
You can set a security domain with the -sdn option or the
environment variable INFA_DEFAULT_SECURITY_DOMAIN. If you
set a security domain name with both methods, the -sdn option
takes precedence. The security domain name is case sensitive.
If the domain uses native or LDAP authentication, the default is
Native. If the domain uses Kerberos authentication, the default
is the LDAP security domain created during installation. The
name of the security domain is the same as the user realm
specified during installation.
-GroupName group_name Required. Name of the group. The group name is not case
-gn sensitive and can be between 1 and 80 characters long. It
cannot include a tab, newline character, or the following special
characters:
, + " \ < > ; / * % ?
The name can include an ASCII space character except for the
first and last character. All other space characters are not
allowed.
CreateIntegrationService
Creates a PowerCenter Integration Service in a domain.
By default, the PowerCenter Integration Service is enabled when you create it.
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-ServiceName|-sn> service_name
[<-FolderPath|-fp> full_folder_path]
<-RepositoryService|-rs> repository_service_name
[<-RepositoryUser|-ru> repository_user]
[<-RepositoryPassword|-rp> repository_password]
[<-RepositoryUserSecurityDomain|-rsdn> repository_user_security_domain]
[<-ServiceDisable|-sd>]
[<-LicenseName|-ln> license_name]
Note: For infacmd isp CreateIntegrationService, you must not use the -ru, -rp, and the -rsdn options in
Kerberos authentication. If you use these options in Kerberos mode, the command will fail.
The following table describes infacmd isp CreateIntegrationService options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set
-dn the domain name with the -dn option or the environment
variable INFA_DEFAULT_DOMAIN. If you set a domain
name with both methods, the -dn option takes
precedence.
CreateIntegrationService 445
Option Argument Description
-Password password Required if you specify the user name. Password for the
-pd user name. The password is case sensitive. You can set
a password with the -pd option or the environment
variable INFA_DEFAULT_DOMAIN_PASSWORD. If you set
a password with both methods, the password set with
the -pd option takes precedence.
-FolderPath full_folder_path Optional. Full path, excluding the domain name, to the
-fp folder in which you want to create the Integration
Service. Must be in the following format:
/parent_folder/child_folder
Default is “/” (the domain).
-NodeName node_name Required if you do not specify the grid name. Name of
-nn the node where you want the PowerCenter Integration
Service process to run. If the PowerCenter environment
is configured for high availability, this option specifies
the name of the primary node.
To apply changes, restart the Integration Service.
-GridName grid_name Required if you do not specify the node name. Name of
-gn the grid where you want the PowerCenter Integration
Service process to run.
To apply changes, restart the PowerCenter Integration
Service.
-BackupNodes node1 node2 ... Optional. Nodes on which the service can run if the
-bn primary node is unavailable. You can configure backup
nodes if you have high availability.
CreateIntegrationService 447
Option Argument Description
Option Description
ClientStore Optional. Enter the value for ClientStore using the following syntax:
<path>/<filename>
For example:
./Certs/client.keystore
CreateIndicatorFiles Optional. Creates indicator files when you run a workflow with a
flat file target. Default is No.
DateDisplayFormat Optional. Date format the Integration Service uses in log entries.
Default is DY MON DD HH 24:MI:SS YYYY.
ErrorSeverityLevel Optional. Minimum level of error logging for the Integration Service
logs:
- Fatal
- Error
- Warning
- Info
- Trace
- Debug
Default is Info.
CreateIntegrationService 449
Option Description
LogsInUTF8 Optional. Writes all logs using the UTF-8 character set. Default is
Yes (Unicode) or No (ASCII).
OperatingModeOnFailover Optional. Operating mode for the Integration Service when the
service process fails over:
- Normal
- Safe
Default is Normal.
OutputMetaDataForFF Optional. Writes column headers to flat file targets. Default is No.
CreateIntegrationService 451
Option Description
TrustStore Optional. Enter the value for TrustStore using the following syntax:
<path>/<filename>
For example:
./Certs/trust.keystore
UseOperatingSystemProfiles Optional. Enables use of operating system profiles. Use this option
if the Integration Service runs on UNIX.
XMLWarnDupRows Optional. Writes duplicate row warnings and duplicate rows for
XML targets to the session log. Default is Yes.
Option Description
$PMBadFileDir Optional. Default directory for reject files. It cannot include the following special
characters:
*?<>"|,
Default is $PMRootDir/BadFiles.
$PMCacheDir Optional. Default directory for index and data cache files. It cannot include the
following special characters:
*?<>"|,
Default is $PMRootDir/Cache.
$PMExtProcDir Optional. Default directory for external procedures. It cannot include the following
special characters:
*?<>"|,
Default is $PMRootDir/ExtProc.
$PMLookupFileDir Optional. Default directory for lookup files. It cannot include the following special
characters:
*?<>"|,
Default is $PMRootDir/LkpFiles.
$PMRootDir Optional. Root directory accessible by the node. It cannot include the following special
characters:
*?<>"|,
Default is C:\Informatica\PowerCenter8.6\server\infa_shared.
$PMSessionLogDir Optional. Default directory for session logs. It cannot include the following special
characters:
*?<>"|,
Default is $PMRootDir/SessLogs.
$PMSourceFileDir Optional. Default directory for source files. It cannot include the following special
characters:
*?<>"|,
Default is $PMRootDir/SrcFiles.
$PMStorageDir Optional. Default directory for run-time files. It cannot include the following special
characters:
*?<>"|,
Default is $PMRootDir/Storage.
$PMTargetFileDir Optional. Default directory for target files. It cannot include the following special
characters:
*?<>"|,
Default is $PMRootDir/TgtFiles.
$PMTempDir Optional. Default directory for temporary files. It cannot include the following special
characters:
*?<>"|,
Default is $PMRootDir/Temp.
$PMWorkflowLogDir Optional. Default directory for workflow logs. It cannot include the following special
characters:
*?<>"|,
Default is $PMRootDir/WorkflowLogs.
Codepage_ID Required. Code page ID number for the Integration Service process.
JVMMaxMemory Optional. Maximum amount of memory the Java SDK uses during a PowerCenter
session. Default is 64 MB.
JVMMinMemory Optional. Minimum amount of memory the Java SDK uses during a PowerCenter
session. Default is 32 MB.
CreateIntegrationService 453
CreateMMService
Creates a Metadata Manager Service in the domain. By default, the Metadata Manager Service is disabled
when you create it. Run infacmd EnableService to enable the Metadata Manager Service.
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-ServiceName|-sn> service_name
<-NodeName|-nn> node_name
[<-LicenseName|-ln> license_name]
[<-FolderPath|-fp> full_folder_path]
The following table describes infacmd isp CreateMMService options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set the
-dn domain name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with both
methods, the -dn option takes precedence.
-Password password Required if you specify the user name. Password for the user
-pd name. The password is case sensitive. You can set a password
with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password
with both methods, the password set with the -pd option takes
precedence.
-NodeName node_name Required. Name of the node where you want the Metadata
-nn Manager application to run.
-ServiceOptions option_name=value Optional. Service properties that define how the Metadata
-so Manager Service runs.
-LicenseName license_name Required. Name of the license you want to assign to the
-ln Metadata Manager Service.
-FolderPath full_folder_path Optional. Full path, excluding the domain name, to the folder in
-fp which you want to create the Metadata Manager Service. Must
be in the following format:
/parent_folder/child_folder
CreateMMService 455
To enter multiple options, separate them with a space. To enter a value that contains a space or other non-
alphanumeric character, enclose the value in quotation marks.
Option Description
AgentPort Required. Port number for the Metadata Manager Agent. The agent uses this port to
communicate with metadata source repositories. Default is 10251.
CodePage Required. Code page description for the Metadata Manager repository. To enter a
code page description that contains a space or other non-alphanumeric character,
enclose the name in quotation marks.
ConnectString Required. Native connect string for the Metadata Manager repository database.
DBUser Required. User account for the Metadata Manager repository database.
DBPassword Required. Password for the Metadata Manager repository database user. User
password. You can set a password with the -so option or the environment variable
INFA_DEFAULT_DATABASE_PASSWORD. If you set a password with both methods,
the password set with the -so option takes precedence.
DatabaseHostname Required. Host name for the Metadata Manager repository database.
DatabaseName Required. Full service name or SID for Oracle databases. Service name for IBM DB2
databases. Database name for Microsoft SQL Server database.
DatabasePort Required. Port number for the Metadata Manager repository database.
ErrorSeverityLevel Optional. Level of error messages written to the Metadata Manager Service log.
Default is ERROR.
FileLocation Required. Location of the files used by the Metadata Manager application.
MaxHeapSize Optional. Amount of RAM in megabytes allocated to the Java Virtual Manager (JVM)
that runs Metadata Manager. Default is 512.
MaxQueueLength Optional. Maximum queue length for incoming connection requests when all
possible request processing threads are in use by the Metadata Manager
application. Default is 500.
MaximumWaitTime Optional. Amount of time in seconds that Metadata Manager holds database
connection requests in the connection pool. Default is 180.
MetadataTreeMaxFolderChilds Optional. Number of child objects that appear in the Metadata Manager metadata
catalog for any parent object. Default is 100.
ODBCConnectionMode Connection mode the Integration Service uses to connect to metadata sources and
the Metadata Manager repository when loading resources. Value can be true or
false.
You must set this property to True if the Integration Service runs on a UNIX machine
and you want to load metadata from a Microsoft SQL Server database or if you use a
Microsoft SQL Server database for the Metadata Manager repository.
OracleConnType Required if you select Oracle for the DatabaseType. Oracle connection type. You can
enter one of the following options:
- OracleSID
- OracleServiceName
PortNumber Required. Port number the Metadata Manager application runs on. Default is 10250.
StagePoolSize Optional. Maximum number of resources that Metadata Manager can load
simultaneously. Default is 3.
TablespaceName Tablespace name for the Metadata Manager repository on IBM DB2.
TimeoutInterval Optional. Amount of time in minutes that Metadata Manager holds a failed resource
load in the load queue. Default is 30.
URLScheme Required. Indicates the security protocol that you configure for the Metadata
Manager application: HTTP or HTTPS.
keystoreFile Required if you use HTTPS. Keystore file that contains the keys and certificates
required if you use the SSL security protocol with the Metadata Manager application.
CreateOSProfile
Creates an operating system profile in the domain. Before you run workflows that use operating system
profiles, you must configure the PowerCenter Integration Service to use operating system profiles.
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
CreateOSProfile 457
[<-Gateway|-hp> gateway_host1:port gateway_host2:port...]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-OSProfileName|-on> OSProfile_name
<-SystemName|-sn> system_username
[<-HadoopImpersonationProperties|-hipr> hadoop_impersonation_properties]
[<-HadoopImpersonationUser|-hu> hadoop_impersonation_user]
[<-UseLoggedInUserAsProxy|-ip> use_logged_in_user_as_proxy]
[<-ProductExtensionName|-pe> product_extension_name]
-DomainName domain_name Required. Name of the Informatica domain. You can set
-dn the domain name with the -dn option or the environment
variable INFA_DEFAULT_DOMAIN. If you set a domain
name with both methods, the -dn option takes
precedence.
-Password password Required if you specify the user name. Password for the
-pd user name. The password is case sensitive. You can set
a password with the -pd option or the environment
variable INFA_DEFAULT_DOMAIN_PASSWORD. If you set
a password with both methods, the password set with
the -pd option takes precedence.
-DISProcessVariables option_name=value Optional. Service process properties that define how the
-diso Data Integration Service runs.
CreateOSProfile 459
Option Argument Description
-HadoopImpersonationUser hadoop_impersonation_user Optional. Enter a user name for the Data Integration
-hu Service to impersonate when it runs jobs in a Hadoop
environment.
-ProductOptions optionGroupName.optionName=Value Required. Name and value of each option that you set.
-o Use the option to create a flat file cache directory that
the operating system profile can use.
For example, the following command sets the cache
directory to $PMRootDir/OSPCache:
infacmd isp createOSProfile ... -o
'runTimeVariables.flatFileCacheDirectory'="
$PMRootDir/OSPCache"
The following table describes the Data Integration Service process options:
Option Description
$DISRootDir Root directory accessible by the node. This is the root directory for other service process
variables. It cannot include the following special characters:
*?<>"|,[]
$DISTempDir Directory for temporary files created when jobs are run. It cannot include the following special
characters:
*?<>"|,[]
Default is <root directory>/disTemp.
$DISCacheDir Directory for index and data cache files for transformations. It cannot include the following
special characters:
*?<>"|,[]
Default is <root directory>/cache.
$DISSourceDir Directory for source flat files used in a mapping. It cannot include the following special
characters:
*?<>"|,[]
Default is <root directory>/source.
$DISTargetDir Directory for target flat files used in a mapping. It cannot include the following special
characters:
*?<>"|,[]
Default is <root directory>/target.
$DISRejectedFilesDir Directory for reject files. Reject files contain rows that were rejected when running a mapping.
It cannot include the following special characters:
*?<>"|,[]
Default is <root directory>/reject.
$DISLogDir Directory for logs. It cannot include the following special characters:
*?<>"|,[]
Default is <root directory>/disLogs.
The following table describes the PowerCenter Integration Service process options:
Option Description
$PMBadFileDir Optional. Directory for reject files. It cannot include the following special characters:
*?<>"|,
Default is $PMRootDir/BadFiles.
$PMCacheDir Optional. Directory for index and data cache files. It cannot include the following special
characters:
*?<>"|,
Default is $PMRootDir/Cache.
$PMExtProcDir Optional. Directory for external procedures. It cannot include the following special characters:
*?<>"|,
Default is $PMRootDir/ExtProc.
$PMLookupFileDir Optional. Directory for lookup files. It cannot include the following special characters:
*?<>"|,
Default is $PMRootDir/LkpFiles.
CreateOSProfile 461
Option Description
$PMRootDir Optional. Root directory accessible by the node. It cannot include the following special
characters:
*?<>"|,
Default is C:\Informatica\PowerCenter\server\infa_shared.
$PMSessionLogDir Optional. Directory for session logs. It cannot include the following special characters:
*?<>"|,
Default is $PMRootDir/SessLogs.
$PMSourceFileDir Optional. Directory for source files. It cannot include the following special characters:
*?<>"|,
Default is $PMRootDir/SrcFiles.
$PMStorageDir Optional. Directory for run-time files. It cannot include the following special characters:
*?<>"|,
Default is $PMRootDir/Storage.
$PMTargetFileDir Optional. Directory for target files. It cannot include the following special characters:
*?<>"|,
Default is $PMRootDir/TgtFiles.
$PMTempDir Optional. Directory for temporary files. It cannot include the following special characters:
*?<>"|,
Default is $PMRootDir/Temp.
CreateRepositoryService
Creates a PowerCenter Repository Service in a domain.
By default, the PowerCenter Repository Service is enabled when you create it.
A PowerCenter Repository Service manages one repository. It performs all metadata transactions between
the repository and repository clients.
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-ServiceName|-sn> service_name
<-NodeName|-nn> node_name
[<-ServiceDisable|-sd>]
[<-LicenseName|-ln> license_name]
[<-FolderPath|-fp> full_folder_path]
The following table describes infacmd isp CreateRepositoryService options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set the domain
-dn name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with both
methods, the -dn option takes precedence.
-UserName user_name Required if the domain uses Native or LDAP authentication. User
-un name to connect to the domain. You can set the user name with
the -un option or the environment variable
INFA_DEFAULT_DOMAIN_USER. If you set a user name with both
methods, the -un option takes precedence.
Optional if the domain uses Kerberos authentication. To run the
command with single sign-on, do not set the user name. If you set
the user name, the command runs without single sign-on.
-Password password Required if you specify the user name. Password for the user
-pd name. The password is case sensitive. You can set a password
with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password with
both methods, the password set with the -pd option takes
precedence.
-SecurityDomain security_domain Required if the domain uses LDAP authentication. Optional if the
-sdn domain uses native authentication or Kerberos authentication.
Name of the security domain to which the domain user belongs.
You can set a security domain with the -sdn option or the
environment variable INFA_DEFAULT_SECURITY_DOMAIN. If you
set a security domain name with both methods, the -sdn option
takes precedence. The security domain name is case sensitive.
If the domain uses native or LDAP authentication, the default is
Native. If the domain uses Kerberos authentication, the default is
the LDAP security domain created during installation. The name of
the security domain is the same as the user realm specified during
installation.
CreateRepositoryService 463
Option Argument Description
-ServiceName service_name Required. Name of the PowerCenter Repository Service. The name
-sn is not case sensitive and must be unique within the domain. The
characters must be compatible with the code page of the
associated repository. The name cannot have leading or trailing
spaces, include carriage returns or tabs, exceed 79 characters, or
contain the following characters:
\ / : * ? < > " |
-NodeName node_name Required. Name of the node where you want the PowerCenter
-nn Repository Service process to run. If the PowerCenter environment
is configured for high availability, this option specifies the name of
the primary node.
-BackupNodes node1 node2 ... Optional. Nodes on which the service can run if the primary node is
-bn unavailable. You can configure backup nodes if you have high
availability.
-ServiceDisable - Optional. Creates a disabled service. You must enable the service
-sd before you can run it.
-ServiceOptions option_name=value Required. Service properties that define how the PowerCenter
-so Repository Service runs.
-LicenseName license_name Required if you create an enabled service. Name of the license you
-ln want to assign to the PowerCenter Repository Service.
-FolderPath full_folder_path Optional. Full path, excluding the domain name, to the folder in
-fp which you want to create the PowerCenter Repository Service.
Must be in the following format:
/parent_folder/child_folder
Default is “/” (the domain).
Option Description
AllowWritesWithRACaching Optional. Uses PowerCenter Client tools to modify metadata in the repository
when repagent caching is enabled. Default is Yes.
CheckinCommentsRequired Optional. Requires users to add comments when checking in repository objects.
Default is Yes. To apply changes, restart the PowerCenter Repository Service.
CodePage Required. Code page description for the database. To enter a code page
description that contains a space or other non-alphanumeric character, enclose
the name in quotation marks.
DBPassword Required. Repository database password corresponding to the database user. You
can set a password with the -so option or the environment variable
INFA_DEFAULT_DATABASE_PASSWORD. If you set a password with both methods,
the password set with the -so option takes precedence.
To apply changes, restart the PowerCenter Repository Service.
DBPoolExpiryThreshold Optional. The minimum number of idle database connections allowed by the
PowerCenter Repository Service. For example, if there are 20 idle connections, and
you set this threshold to 5, the PowerCenter Repository Service closes no more
than 15 connections. Minimum is 3. Default is 5.
DBPoolExpiryTimeout Optional. The interval, in seconds, at which the PowerCenter Repository Service
checks for idle database connections. If a connection is idle for a period of time
greater than this value, the PowerCenter Repository Service can close the
connection. Minimum is 300. Maximum is 2,592,000 (30 days). Default is 3,600 (1
hour).
DBUser Required. Account for the database containing the repository. To apply changes,
restart the PowerCenter Repository Service.
DatabaseArrayOperationSize Optional. Number of rows to fetch each time an array database operation is
issued, such as insert or fetch. Default is 100. To apply changes, restart the
PowerCenter Repository Service.
DatabaseConnectionTimeout Optional. Amount of time in seconds that the PowerCenter Repository Service
attempts to establish a connection to the database management system. Default
is 180.
DatabasePoolSize Optional. Maximum number of connections to the repository database that the
PowerCenter Repository Service can establish. Minimum is 20. Default is 500.
DatabaseType Required. Type of database that stores the repository metadata. To apply changes,
restart the PowerCenter Repository Service.
EnableRepAgentCaching Optional. Enables the repository agent caching feature. Default is Yes.
ErrorSeverityLevel Optional. Minimum level of error messages written to the PowerCenter Repository
Service log:
- Fatal
- Error
Warning
- Info
- Trace
- Debug
Default is Info.
HeartBeatInterval Optional. Interval at which the PowerCenter Repository Service verifies its
connections with clients of the service. Default is 60 seconds.
MaxResilienceTimeout Optional. Maximum amount of time in seconds that the service holds on to
resources for resilience purposes. Default is 180.
CreateRepositoryService 465
Option Description
MaximumConnections Optional. Maximum number of connections the repository accepts from repository
clients. Default is 200.
MaximumLocks Optional. Maximum number of locks the repository places on metadata objects.
Default is 50,000.
OptimizeDatabaseSchema Optional. Optimizes the repository database schema when you create repository
contents or back up and restore an IBM DB2 or Microsoft SQL Server repository.
When enabled, the PowerCenter Repository Service tries to create repository
tables that contain Varchar columns with a precision of 2000 instead of CLOB
columns. Use Varchar columns to increase repository performance. When you use
Varchar columns, you reduce disk input and output, and the database can cache
the columns.
To use this option, verify the page size requirements for the following repository
databases:
- IBM DB2. Database page size 4 KB or greater. At least one temporary
tablespace with page size 16 KB or greater.
- Microsoft SQL Server. Database page size 8 KB or greater.
Default is disabled.
PreserveMXData Optional. Preserves MX data for prior versions of mappings. Default is disabled.
RACacheCapacity Optional. Number of objects that the cache can contain when repository agent
caching is enabled. Default is 10,000.
SecurityAuditTrail Optional. Tracks changes made to users, groups, privileges, and permissions.
Default is No.
ServiceResilienceTimeout Optional. Amount of time in seconds that the service tries to establish or
reestablish a connection to another service. Default is 180. To apply changes,
restart the PowerCenter Repository Service.
TableOwnerName Optional. Name of the owner of the repository tables for an IBM DB2 repository.
TablespaceName Optional. Tablespace name for IBM DB2 repositories. To apply changes, restart the
PowerCenter Repository Service.
TrustedConnection Optional. Uses Windows authentication to access the Microsoft SQL Server
database. Default is No. To apply changes, restart the PowerCenter Repository
Service.
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
[<-SecurityDomain|-sdn> securitydomain]
<-Password|-pd> password
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-RoleName|-rn> role_name
[<-RoleDescription|-rd> role_description]
The following table describes infacmd isp CreateRole options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set the
-dn domain name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with both
methods, the -dn option takes precedence.
-UserName user_name Required if the domain uses Native or LDAP authentication. User
-un name to connect to the domain. You can set the user name with
the -un option or the environment variable
INFA_DEFAULT_DOMAIN_USER. If you set a user name with both
methods, the -un option takes precedence.
Optional if the domain uses Kerberos authentication. To run the
command with single sign-on, do not set the user name. If you
set the user name, the command runs without single sign-on.
-Password password Required if you specify the user name. Password for the user
-pd name. The password is case sensitive. You can set a password
with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password with
both methods, the password set with the -pd option takes
precedence.
-SecurityDomain security_domain Required if the domain uses LDAP authentication. Optional if the
-sdn domain uses native authentication or Kerberos authentication.
Name of the security domain to which the domain user belongs.
You can set a security domain with the -sdn option or the
environment variable INFA_DEFAULT_SECURITY_DOMAIN. If you
set a security domain name with both methods, the -sdn option
takes precedence. The security domain name is case sensitive.
If the domain uses native or LDAP authentication, the default is
Native. If the domain uses Kerberos authentication, the default
is the LDAP security domain created during installation. The
name of the security domain is the same as the user realm
specified during installation.
CreateRole 467
Option Argument Description
-RoleName role_name Required. Name of the role. The role name is case insensitive
-rn and can be between 1 and 80 characters long. It cannot include
a tab, newline character, or the following special characters:
, + " \ < > ; / * % ?
The name can include an ASCII space character except for the
first and last character. All other space characters are not
allowed.
-RoleDescription role_description Optional. Description of the role. The description can have a
-rd maximum of 1,000 characters and cannot include a tab, newline
character, or the following special characters:
< > "
To enter a description that contains spaces or other non-
alphanumeric characters, enclose it in quotation marks.
CreateSAPBWService
Creates an SAP BW Service in the domain. By default, the SAP BW Service is enabled when you create it.
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-ServiceName|-sn> service_name
<-NodeName|-nn> node_name
<-IntegrationService|-is> integration_service_name
<-RepositoryUser|-ru> user
<-RepositoryPassword|-rp> password
[<-ServiceDisable|-sd>]
[<-LicenseName|-ln> license_name]
[<-FolderPath|-fp> full_folder_path]
The following table describes infacmd isp CreateSAPBWService options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set
-dn the domain name with the -dn option or the
environment variable INFA_DEFAULT_DOMAIN. If you
set a domain name with both methods, the -dn option
takes precedence.
-Password password Required if you specify the user name. Password for
-pd the user name. The password is case sensitive. You
can set a password with the -pd option or the
environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a
password with both methods, the password set with the
-pd option takes precedence.
CreateSAPBWService 469
Option Argument Description
-NodeName node_name Required. Name of the node where you want the SAP
-nn BW Service process to run. If the PowerCenter
environment is configured for high availability, this
option specifies the name of the primary node.
-ServiceOptions option_name=value Optional. Service properties that define how the SAP
-so BW Service runs.
-FolderPath full_folder_path Optional. Full path, excluding the domain name, to the
-fp folder in which you want to create the SAP BW Service.
Must be in the following format:
/parent_folder/child_folder
Default is “/” (the domain).
Option Description
BWSystemConxString Optional. DEST entry defined in the sapnwrfc.ini file for a connection to an
RFC server program. Edit this property if you have created a different DEST
entry in the sapnwrfc.ini file for the SAP BW Service.
RetryPeriod Optional. Number of seconds the SAP BW Service waits before trying to
connect to the BW system if a previous connection attempt failed. Default is
5.
Option Description
CreateSAPBWService 471
CreateUser
Creates a user account in the native security domain. You can then assign roles, permissions, and privileges
to a user account. The roles, permissions, and privileges assigned to the user determine the tasks that the
user can perform within the domain.
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-NewUserName|-nu> new_user_name
<-NewUserPassword|-np> new_user_password
[<-NewUserFullName|-nf> new_user_full_name]
[<-NewUserDescription|-ds> new_user_description]
[<-NewUserEMailAddress|-em> new_user_email_address]
[<-NewUserPhoneNumber|-pn> new_user_phone_number]
The following table describes infacmd isp CreateUser options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set the
-dn domain name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with both
methods, the -dn option takes precedence.
-Password password Required if you specify the user name. Password for the user
-pd name. The password is case sensitive. You can set a
password with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password
with both methods, the password set with the -pd option
takes precedence.
-NewUserName new_user_name Required. Login name for the user account. The login name
-nu for a user account must be unique within the security domain
to which it belongs.
The login name is not case sensitive and can be between 1
and 80 characters long. It cannot include a tab, newline
character, or the following special characters:
, + " \ < > ; / * & % ?
The name can include an ASCII space character except for
the first and last character. All other space characters are not
allowed.
-NewUserPassword new_user_password Required. Password for the user account. You can set a
-np password with the -np option or the environment variable
INFA_PASSWORD. If you set a password with both these
methods, the password set with the -np option takes
precedence.
For a native user account, if you enable password complexity,
use the following guidelines when you create or change a
password:
- The length of the password must be at least eight
characters.
- It must be a combination of an alphabet character, a
numeric character and a non-alphanumeric character, such
as:
! \ " # $ % & ' ( ) * + , - . / : ; < = > ? @
[ ] ^ _ ` { | } ~
When you use special characters in a password, the shell
sometimes interprets them differently. For example, $ is
interpreted as a variable. In this case, use an escape
character to escape the special character.
CreateUser 473
Option Argument Description
-NewUserFullName new_user_full_name Optional. Full name for the user account. To enter a name
-nf that contains spaces or other non-alphanumeric characters,
enclose the name in quotation marks. The full name cannot
include the following special characters:
< > “
-NewUserEMailAddress new_user_email_addre Optional. Email address for the user. To enter an address that
-em ss contains spaces or other non-alphanumeric characters,
enclose it in quotation marks.
The email address cannot include the following special
characters:
< > “
Enter the email address in the format UserName@Domain.
CreateWSHubService
Creates a Web Services Hub in the domain. By default, the Web Services Hub is enabled when you create it.
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-ServiceName|-sn> service_name
[<-FolderPath|-fp> full_folder_path]
<-NodeName|-nn> node_name
<-RepositoryUser|-ru> repository_user
<-RepositoryPassword|-rp> repository_password
[<-RepositoryUserSecurityDomain|-rsdn> repository_user_security_domain]
[<-ServiceDisable|-sd>]
<-LicenseName|-ln> license_name
The following table describes infacmd isp CreateWSHubService options and arguments:
-UserName user_name Required if the domain uses Native or LDAP authentication. User
-un name to connect to the domain. You can set the user name with
the -un option or the environment variable
INFA_DEFAULT_DOMAIN_USER. If you set a user name with both
methods, the -un option takes precedence.
Optional if the domain uses Kerberos authentication. To run the
command with single sign-on, do not set the user name. If you
set the user name, the command runs without single sign-on.
-Password password Required if you specify the user name. Password for the user
-pd name. The password is case sensitive. You can set a password
with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password with
both methods, the password set with the -pd option takes
precedence.
-SecurityDomain security_domain Required if the domain uses LDAP authentication. Optional if the
-sdn domain uses native authentication or Kerberos authentication.
Name of the security domain to which the domain user belongs.
You can set a security domain with the -sdn option or the
environment variable INFA_DEFAULT_SECURITY_DOMAIN. If you
set a security domain name with both methods, the -sdn option
takes precedence. The security domain name is case sensitive.
If the domain uses native or LDAP authentication, the default is
Native. If the domain uses Kerberos authentication, the default
is the LDAP security domain created during installation. The
name of the security domain is the same as the user realm
specified during installation.
CreateWSHubService 475
Option Argument Description
-ServiceName service_name Name of the Web Services Hub you want to create.
-sn The name is not case sensitive and must be unique within the
domain. The characters must be compatible with the code page
of the associated repository. The name cannot have leading or
trailing spaces, include carriage returns or tabs, exceed 79
characters, or contain the following characters:
/ * ? < > " |
-FolderPath full_folder_path Optional. Full path, excluding the domain name, to the folder in
-fp which you want to create the Web Services Hub. Must be in the
following format:
/parent_folder/child_folder
Default is “/” (the domain).
-NodeName node_name Required. Name of the node where you want to run the Web
-nn Services Hub process.
‑RepositoryService repository_service_ Required. Name of the Repository Service that the Web Services
-rs name Hub depends on.
To enter a name that contains a space or other non-
alphanumeric character, enclose the name in quotation marks.
-RepositoryPassword repository_password Required. User password. You can set a password with the -rp
-rp option or the environment variable
INFA_REPOSITORY_PASSWORD. If you set a password with both
methods, the password that you set with the -rp option takes
precedence.
-ServiceOptions option_name=value ... Optional. Service properties that define how the Web Services
-so Hub runs.
-LicenseName license_name Required. Name of the license you want to assign to the Web
-ln Services Hub.
Option Description
ErrorSeverityLevel Optional. Minimum level of error logging for the Web Services Hub logs:
- Fatal
- Error
- Warning
- Info
- Trace
- Debug
Default is Info.
HubHostName Optional. Name of the machine hosting the Web Services Hub. Default is localhost.
To apply changes, restart the Web Services Hub.
HubPortNumber(http) Optional. Port number on which the Web Services Hub runs in Tomcat. Default is
7333. To apply changes, restart the Web Services Hub.
HubPortNumber (https) Port number on which the Web Services Hub runs in Tomcat. Required if you
choose to run the Web Services Hub on HTTPS. Default is 7343.
InternalHostName Optional. Host name at which the Web Services Hub listens for connections from
the Integration Service. Default is localhost. To apply changes, restart the Web
Services Hub.
InternalPortNumber Optional. Port number at which the Web Services Hub listens for connections from
the Integration Service. Default is 15555. To apply changes, restart the Web
Services Hub.
MaxLMConnections Optional. Maximum number of connections to the Integration Service that can be
open at one time for the Web Services Hub. Default is 20.
MaxQueueLength Optional. Maximum queue length for incoming connection requests when all
possible request processing threads are in use. Default is 5000.
SessionExpiryPeriod Optional. Number of seconds that a session can remain unused before its session
ID becomes invalid. Default is 3600 seconds.
URLScheme Optional. Security protocol that you configure for the Web Services Hub: HTTP or
HTTPS. Default is HTTP. To apply changes, restart the Web Services Hub.
CreateWSHubService 477
Option Description
WSH_ENCODING Optional. Character encoding for the Web Services Hub. Default is UTF-8. To apply
changes, restart the Web Services Hub.
KeystoreFile Optional. Keystore file that contains the keys and certificates required if you use
the SSL security protocol with the Web Services Hub.
DeleteNamespace
Deletes an LDAP security domain and the users and groups in the security domain. Deletes the LDAP security
domain if the Informatica domain uses LDAP or Kerberos authentication.
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-NameSpace|-ns> namespace
The following table describes infacmd isp DeleteNamespace options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set the
-dn domain name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with both
methods, the -dn option takes precedence.
-Password password Required if you specify the user name. Password for the user
-pd name. The password is case sensitive. You can set a
password with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password
with both methods, the password set with the -pd option
takes precedence.
-SecurityDomain security_domain Name of the security domain that you want to create to which
-sdn the domain user belongs. You can set a security domain with
the -sdn option or the environment variable
INFA_DEFAULT_SECURITY_DOMAIN. If you set a security
domain name with both methods, the -sdn option takes
precedence. The security domain name is case sensitive.
You can specify a value for ‑sdn or use the default based on
the authentication mode:
- Required if the domain uses LDAP authentication. Default
is Native. To work with LDAP authentication, you need to
specify the value for -sdn.
- Optional if the domain uses native authentication or
Kerberos authentication. Default is native for native
authentication. If the domain uses Kerberos authentication,
the default is the LDAP security domain created during
installation. The name of the security domain is the same
as the user realm specified during installation.
DisableNodeResource
Disables an Informatica resource. Informatica resources include file directory resources, custom resources,
and connection resources. Disable the resources that are not available to prevent the Load Balancer from
dispatching a task to a node that does not have the required resources.
You can disable file directory resources, custom resources, and connection resources.
When a PowerCenter Integration Service runs on a grid, the Load Balancer can use resources to distribute
Session, Command, and predefined Event-Wait tasks. If the PowerCenter Integration Service is configured to
check resources, the Load Balancer distributes tasks to nodes with available resources.
DisableNodeResource 479
The infacmd isp DisableNodeResource command uses the following syntax:
DisableNodeResource
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-NodeName|-nn> node_name
<-ResourceName|-rn> resource_name
The following table describes infacmd isp DisableNodeResource options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set the
-dn domain name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with both
methods, the -dn option takes precedence.
-UserName user_name Required if the domain uses Native or LDAP authentication. User
-un name to connect to the domain. You can set the user name with
the -un option or the environment variable
INFA_DEFAULT_DOMAIN_USER. If you set a user name with both
methods, the -un option takes precedence.
Optional if the domain uses Kerberos authentication. To run the
command with single sign-on, do not set the user name. If you set
the user name, the command runs without single sign-on.
-Password password Required if you specify the user name. Password for the user
-pd name. The password is case sensitive. You can set a password
with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password with
both methods, the password set with the -pd option takes
precedence.
-SecurityDomain security_domain Required if the domain uses LDAP authentication. Optional if the
-sdn domain uses native authentication or Kerberos authentication.
Name of the security domain to which the domain user belongs.
You can set a security domain with the -sdn option or the
environment variable INFA_DEFAULT_SECURITY_DOMAIN. If you
set a security domain name with both methods, the -sdn option
takes precedence. The security domain name is case sensitive.
If the domain uses native or LDAP authentication, the default is
Native. If the domain uses Kerberos authentication, the default is
the LDAP security domain created during installation. The name of
the security domain is the same as the user realm specified during
installation.
-NodeName node_name Required. Name of the node where the resource is defined.
-nn
DisableService
Disables the application service corresponding to the service name. When you disable a service, all service
processes stop.
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-ServiceName|-sn> service_name
<-Mode|-mo> disable_mode
DisableService 481
The following table describes infacmd isp DisableService options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set the domain
-dn name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with both
methods, the -dn option takes precedence.
-UserName user_name Required. User name to connect to the domain. You can set the
-un user name with the -un option or the environment variable
INFA_DEFAULT_DOMAIN_USER. If you set a user name with both
methods, the -un option takes precedence.
-Password password Required if you specify the user name. Password for the user name.
-pd The password is case sensitive. You can set a password with the -
pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password with
both methods, the password set with the -pd option takes
precedence.
-SecurityDomain security_domain Required if the domain uses LDAP authentication. Optional if the
-sdn domain uses native authentication or Kerberos authentication.
Name of the security domain to which the domain user belongs.
You can set a security domain with the -sdn option or the
environment variable INFA_DEFAULT_SECURITY_DOMAIN. If you set
a security domain name with both methods, the -sdn option takes
precedence. The security domain name is case sensitive.
If the domain uses native or LDAP authentication, the default is
Native. If the domain uses Kerberos authentication, the default is
the LDAP security domain created during installation. The name of
the security domain is the same as the user realm specified during
installation.
-ServiceName service_name Required. Name of the service you want to disable. To enter a name
-sn that contains a space or other non-alphanumeric character, enclose
the name in quotation marks.
DisableServiceProcess
Disables the service process on a specified node.
You can disable a service process on a specified node if the node requires maintenance.
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-ServiceName|-sn> service_name
<-NodeName|-nn> node_name
<-Mode|-mo> disable_mode
The following table describes infacmd isp DisableServiceProcess options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set the
-dn domain name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with both
methods, the -dn option takes precedence.
-UserName user_name Required if the domain uses Native or LDAP authentication. User
-un name to connect to the domain. You can set the user name with
the -un option or the environment variable
INFA_DEFAULT_DOMAIN_USER. If you set a user name with both
methods, the -un option takes precedence.
Optional if the domain uses Kerberos authentication. To run the
command with single sign-on, do not set the user name. If you set
the user name, the command runs without single sign-on.
-Password password Required if you specify the user name. Password for the user
-pd name. The password is case sensitive. You can set a password
with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password with
both methods, the password set with the -pd option takes
precedence.
DisableServiceProcess 483
Option Argument Description
-SecurityDomain security_domain Required if the domain uses LDAP authentication. Optional if the
-sdn domain uses native authentication or Kerberos authentication.
Name of the security domain to which the domain user belongs.
You can set a security domain with the -sdn option or the
environment variable INFA_DEFAULT_SECURITY_DOMAIN. If you
set a security domain name with both methods, the -sdn option
takes precedence. The security domain name is case sensitive.
If the domain uses native or LDAP authentication, the default is
Native. If the domain uses Kerberos authentication, the default is
the LDAP security domain created during installation. The name of
the security domain is the same as the user realm specified during
installation.
-ServiceName service_name Required. Name of the service associated with the process you
-sn want to disable. To enter a name that contains a space or other
non-alphanumeric character, enclose the name in quotation marks.
-NodeName node_name Required. Name of the node where the service process is running.
-nn
DisableUser
Disables a user account in the domain. If you do not want a user to access the domain temporarily, you can
disable the user account.
When you disable a user account, the user cannot log in to the PowerCenter applications.
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-ExistingUserName|-eu> existing_user_Name
[<-ExistingUserSecurityDomain|-esd> existing_user_security_domain]
The following table describes infacmd isp DisableUser options and arguments:
-Password password Required if you specify the user name. Password for
-pd the user name. The password is case sensitive. You
can set a password with the -pd option or the
environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a
password with both methods, the password set with
the -pd option takes precedence.
DisableUser 485
Option Argument Description
EditUser
Edits the general properties for a user account in the native security domain.
You cannot modify the properties of user accounts in the LDAP security domains.
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-ExistingUserName|-eu> existing_user_Name
[<-ExistingUserFullName|-ef> Existing_user_full_name]
[<-ExistingUserDescription|-ds> Existing_user_description]
[<-ExistingUserEMailAddress|-em> Existing_user_email_address]
[<-ExistingUserPhoneNumber|-pn> Existing_user_phone_number]
EditUser 487
Option Argument Description
-ExistingUserFullName existing_user_full_name Optional. Changed full name for the user account.
-sf To enter a name that contains spaces or other
non-alphanumeric characters, enclose the name
in quotation marks. The full name cannot include
the following special characters:
< > “
EnableNodeResource
Enables an Informatica resource. Informatica resources include file or directory, custom, and connection
resources. When you enable a resource on a node, you allow the Load Balancer to distribute tasks that
require the resource to that node.
When a PowerCenter Integration Service runs on a grid, the Load Balancer can use resources to distribute
Session, Command, and predefined Event-Wait tasks. If the PowerCenter Integration Service is configured to
check resources, the Load Balancer distributes tasks to nodes where the resources are added and enabled.
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-NodeName|-nn> node_name
<-ResourceName|-rn> resource_name
The following table describes infacmd isp EnableNodeResource options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set the domain
-dn name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with both
methods, the -dn option takes precedence.
-UserName user_name Required if the domain uses Native or LDAP authentication. User
-un name to connect to the domain. You can set the user name with
the -un option or the environment variable
INFA_DEFAULT_DOMAIN_USER. If you set a user name with both
methods, the -un option takes precedence.
Optional if the domain uses Kerberos authentication. To run the
command with single sign-on, do not set the user name. If you set
the user name, the command runs without single sign-on.
-Password password Required if you specify the user name. Password for the user
-pd name. The password is case sensitive. You can set a password
with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password with
both methods, the password set with the -pd option takes
precedence.
-SecurityDomain security_domain Required if the domain uses LDAP authentication. Optional if the
-sdn domain uses native authentication or Kerberos authentication.
Name of the security domain to which the domain user belongs.
You can set a security domain with the -sdn option or the
environment variable INFA_DEFAULT_SECURITY_DOMAIN. If you
set a security domain name with both methods, the -sdn option
takes precedence. The security domain name is case sensitive.
If the domain uses native or LDAP authentication, the default is
Native. If the domain uses Kerberos authentication, the default is
the LDAP security domain created during installation. The name of
the security domain is the same as the user realm specified during
installation.
EnableNodeResource 489
Option Argument Description
-NodeName node_name Required. Name of the node where the resource is defined.
-nn
EnableService
Enables the application service corresponding to the service name.
Enables any application service type, including system services. You can also enable the Informatica
Administrator.
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-ServiceName|-sn> service_name
-DomainName domain_name Required. Name of the Informatica domain. You can set the domain
-dn name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with both
methods, the -dn option takes precedence.
-UserName user_name Required if the domain uses Native or LDAP authentication. User
-un name to connect to the domain. You can set the user name with the
-un option or the environment variable
INFA_DEFAULT_DOMAIN_USER. If you set a user name with both
methods, the -un option takes precedence.
Optional if the domain uses Kerberos authentication. To run the
command with single sign-on, do not set the user name. If you set
the user name, the command runs without single sign-on.
-Password password Required if you specify the user name. Password for the user name.
-pd The password is case sensitive. You can set a password with the -
pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password with
both methods, the password set with the -pd option takes
precedence.
-SecurityDomain security_domain Required if the domain uses LDAP authentication. Optional if the
-sdn domain uses native authentication or Kerberos authentication.
Name of the security domain to which the domain user belongs. You
can set a security domain with the -sdn option or the environment
variable INFA_DEFAULT_SECURITY_DOMAIN. If you set a security
domain name with both methods, the -sdn option takes precedence.
The security domain name is case sensitive.
If the domain uses native or LDAP authentication, the default is
Native. If the domain uses Kerberos authentication, the default is
the LDAP security domain created during installation. The name of
the security domain is the same as the user realm specified during
installation.
-ServiceName service_name Required. Name of the service you want to enable. To enter a name
-sn that contains a space or other non-alphanumeric character, enclose
the name in quotation marks.
To start the Administrator tool, enter _adminconsole.
EnableService 491
EnableServiceProcess
Enables a service process on a specified node.
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-ServiceName|-sn> service_name
<-NodeName|-nn> node_name
The following table describes infacmd isp EnableServiceProcess options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set the domain
-dn name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with both
methods, the -dn option takes precedence.
-UserName user_name Required if the domain uses Native or LDAP authentication. User
-un name to connect to the domain. You can set the user name with the
-un option or the environment variable
INFA_DEFAULT_DOMAIN_USER. If you set a user name with both
methods, the -un option takes precedence.
Optional if the domain uses Kerberos authentication. To run the
command with single sign-on, do not set the user name. If you set
the user name, the command runs without single sign-on.
-Password password Required if you specify the user name. Password for the user name.
-pd The password is case sensitive. You can set a password with the -
pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password with
both methods, the password set with the -pd option takes
precedence.
-SecurityDomain security_domain Required if the domain uses LDAP authentication. Optional if the
-sdn domain uses native authentication or Kerberos authentication.
Name of the security domain to which the domain user belongs. You
can set a security domain with the -sdn option or the environment
variable INFA_DEFAULT_SECURITY_DOMAIN. If you set a security
domain name with both methods, the -sdn option takes precedence.
The security domain name is case sensitive.
If the domain uses native or LDAP authentication, the default is
Native. If the domain uses Kerberos authentication, the default is
the LDAP security domain created during installation. The name of
the security domain is the same as the user realm specified during
installation.
-ServiceName service_name Required. Name of the service associated with the process you want
-sn to enable. To enter a name that contains a space or other non-
alphanumeric character, enclose the name in quotation marks.
-NodeName node_name Required. Name of the node where you want to enable a service
-nn process.
EnableUser
Enables a user account in the domain.
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-ExistingUserName|-eu> existing_user_Name
[<-ExistingUserSecurityDomain|-esd> existing_user_security_domain]
EnableUser 493
The following table describes infacmd isp EnableUser options and arguments:
ExportDomainObjects
Exports native users, native groups, roles, connections, and cluster configurations from the Informatica
domain to an XML file.
If you do not want to export all objects in the domain, use an infacmd export control file to filter the objects
that you want to export.
Use the ExportDomainObjects and ImportDomainObjects commands to migrate objects between two
different domains of the same version. To export native users and groups from domains of different versions,
use the infacmd isp ExportUsersAndGroups command.
When you export a group, you export all subgroups and users in the group.
You cannot export the Administrator user, the Administrator group, users in the Administrator group, the
Everyone group, or the LDAP users or groups. To replicate LDAP users and groups in an Informatica domain,
import the LDAP users and groups directly from the LDAP directory service.
If the command fails with a Java memory error, increase the system memory available for infacmd. To
increase the system memory, set the -Xmx value in the ICMD_JAVA_OPTS environment variable.
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
ExportDomainObjects 495
<-ExportFile|-fp> export_file_name
[<-ExportControlFile|-cp> export_control_file_name]
[<-RetainPassword|-rp> retain_password]
[<-Force|-f>]
The following table describes infacmd isp ExportDomainObjects options and arguments:
-Password password Required if you specify the user name. Password for
-pd the user name. You can set a password with the -pd
option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a
password with both methods, the password set with
the -pd option takes precedence.
For a native user account, if you enable password
complexity, use the following guidelines when you
create or change a password:
- The length of the password must be at least eight
characters.
- It must be a combination of an alphabet character, a
numeric character and a non-alphanumeric
character, such as:
! \ " # $ % & ' ( ) * + , - . / : ; < =
> ? @ [ ] ^ _ ` { | } ~
When you use special characters in a password, the
shell sometimes interprets them differently. For
example, $ is interpreted as a variable. In this case,
use an escape character to escape the special
character.
-ExportFile export_file_name Required. Path and file name of the export file.
-fp If you do not specify the file path, infacmd creates the
file in the directory where you run infacmd.
-ExportControlFile export_control_file Optional.Name and path for the export control file that
-cp filters the objects that are exported.
ExportUsersAndGroups
Exports native users and groups to an XML file.
If the command fails with a Java memory error, increase the system memory available for infacmd. To
increase the system memory, set the -Xmx value in the ICMD_JAVA_OPTS environment variable.
ExportUsersAndGroups 497
The infacmd isp ExportUsersAndGroups command uses the following syntax:
ExportUsersAndGroups
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-ExportFile|-ef> export_file_name
[<-Force|-f>]
The following table describes infacmd isp ExportUsersAndGroups options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set the
-dn domain name with the -dn option or the environment
variable INFA_DEFAULT_DOMAIN. If you set a domain name
with both methods, the -dn option takes precedence.
-Password password Required if you specify the user name. Password for the
-pd user name. You can set a password with the -pd option or
the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password
with both methods, the password set with the -pd option
takes precedence.
For a native user account, if you enable password
complexity, use the following guidelines when you create or
change a password:
- The length of the password must be at least eight
characters.
- It must be a combination of an alphabet character, a
numeric character and a non-alphanumeric character,
such as:
! \ " # $ % & ' ( ) * + , - . / : ; < = > ?
@ [ ] ^ _ ` { | } ~
When you use special characters in a password, the shell
sometimes interprets them differently. For example, $ is
interpreted as a variable. In this case, use an escape
character to escape the special character.
-ExportFile export_file_name Required. Name and file path where you want to write the
-ef export file.
If you do not specify the file path, infacmd creates the
backup file in the directory where you run infacmd.
-Force - Optional. Overwrites the export file, if a file with the same
-f name already exists. If you omit this option, the command
prompts you for a confirmation before it deletes the file.
Related Topics:
• “ImportUsersAndGroups” on page 529
GetFolderInfo
Gets folder information. Folder information includes folder path, name, and description.
To run the infacmd isp GetFolderInfo command, you must have permission on the folder.
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
GetFolderInfo 499
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-FolderPath|-fp> full_folder_path
The following table describes infacmd isp GetFolderInfo options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set the
-dn domain name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with both
methods, the -dn option takes precedence.
-Password password Required if you specify the user name. Password for the user
-pd name. The password is case sensitive. You can set a
password with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password
with both methods, the password set with the -pd option
takes precedence.
-FolderPath full_folder_path Required. Full path, excluding the domain name, to the folder.
-fp Must be in the format:
/parent_folder/child_folder
GetLastError
Gets the most recent error messages for an application service running on a node.
The error messages are log events that have a severity level of error or fatal. This command does not return
errors that occurred before Informatica Services were last started.
You can fetch error messages in a file or display them on the screen.
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-ServiceName|-sn> service_name
<-NodeName|-nn> node_name
[<-Format|-fm> format_TEXT_XML]
[<-MaxEvents|-me> maximum_number_of_error_events]
GetLastError 501
The following table describes infacmd isp GetLastError options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set the
-dn domain name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with both
methods, the -dn option takes precedence.
-UserName user_name Required if the domain uses Native or LDAP authentication. User
-un name to connect to the domain. You can set the user name with
the -un option or the environment variable
INFA_DEFAULT_DOMAIN_USER. If you set a user name with both
methods, the -un option takes precedence.
Optional if the domain uses Kerberos authentication. To run the
command with single sign-on, do not set the user name. If you set
the user name, the command runs without single sign-on.
-Password password Required if you specify the user name. Password for the user
-pd name. The password is case sensitive. You can set a password
with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password with
both methods, the password set with the -pd option takes
precedence.
-SecurityDomain security_domain Required if the domain uses LDAP authentication. Optional if the
-sdn domain uses native authentication or Kerberos authentication.
Name of the security domain to which the domain user belongs.
You can set a security domain with the -sdn option or the
environment variable INFA_DEFAULT_SECURITY_DOMAIN. If you
set a security domain name with both methods, the -sdn option
takes precedence. The security domain name is case sensitive.
If the domain uses native or LDAP authentication, the default is
Native. If the domain uses Kerberos authentication, the default is
the LDAP security domain created during installation. The name of
the security domain is the same as the user realm specified during
installation.
-ServiceName service_name Optional. Name of the service for which you want to fetch error
-sn messages. To enter a name that contains a space or other non-
alphanumeric character, enclose the name in quotation marks.
-NodeName node_name Required. Name of the node where the service runs.
-nn
-Format format Optional. Format for error messages. Valid types include:
-fm - Text
- XML
If you do not specify a format, infacmd displays the messages in
text format with lines wrapped at 80 characters.
GetLog
Gets log events. You can get log events for a domain or services. You can write log events to a file or display
them on the screen.
To fetch log events for a domain, you must have permission on the domain. To fetch log events for a service,
you must have permission on the service.
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
[<-StartDate|-sd> start_date_time]
[<-EndDate|-ed> end_date_time]
[<-ReverseOrder|-ro>]
[<-Format|-fm> format_TEXT_XML_BIN]
[<-OutputFile|-lo> output_file_name]
[<-ServiceName|-sn> service_name]
[<-Severity|-svt> FATAL_ERROR_WARNING_INFO_TRACE_DEBUG]
GetLog 503
The following table describes infacmd isp GetLog options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set the
-dn domain name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with both
methods, the -dn option takes precedence.
-UserName user_name Required if the domain uses Native or LDAP authentication. User
-un name to connect to the domain. You can set the user name with
the -un option or the environment variable
INFA_DEFAULT_DOMAIN_USER. If you set a user name with both
methods, the -un option takes precedence.
Optional if the domain uses Kerberos authentication. To run the
command with single sign-on, do not set the user name. If you set
the user name, the command runs without single sign-on.
-Password password Required if you specify the user name. Password for the user
-pd name. The password is case sensitive. You can set a password
with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password with
both methods, the password set with the -pd option takes
precedence.
-SecurityDomain security_domain Required if the domain uses LDAP authentication. Optional if the
-sdn domain uses native authentication or Kerberos authentication.
Name of the security domain to which the domain user belongs.
You can set a security domain with the -sdn option or the
environment variable INFA_DEFAULT_SECURITY_DOMAIN. If you
set a security domain name with both methods, the -sdn option
takes precedence. The security domain name is case sensitive.
If the domain uses native or LDAP authentication, the default is
Native. If the domain uses Kerberos authentication, the default is
the LDAP security domain created during installation. The name of
the security domain is the same as the user realm specified during
installation.
-StartDate start_date_time Optional. Returns log events starting from this date and time.
-sd Enter date and time in one of the following formats:
- MM/dd/yyyy_hh:mm:ssa_Z
- MM/dd/yyyy_hh:mma_Z
- MM/dd/yyyy_hh:mm:ssa
- MM/dd/yyyy_hh:mma
- yyyy-MM-dd_HH:mm:ss_Z
- yyyy-MM-dd_HH:mm_Z
- yyyy-MM-dd_HH:mm:ss
- yyyy-MM-dd_HH:mm
- MM/dd/yyyy hh:mm:ssa Z
- MM/dd/yyyy hh:mma Z
- MM/dd/yyyy hh:mm:ssa
- MM/dd/yyyy hh:mma
- yyyy-MM-dd HH:mm:ss_Z
- yyyy-MM-dd HH:mm_Z
- yyyy-MM-dd HH:mm:ss
- yyyy-MM-dd HH:mm
- MM/dd/yyyy
- yyyy-MM-dd
Where “a” is an am/pm marker (“a” for a.m. and “p” for p.m.) and
“Z” is a time zone marker (for example,“-0800” or “GMT”).
-EndDate end_date_time Optional. Returns log events ending by this date and time. Enter
-ed date and time in the same format as the StartDate option.
If you enter an end date that is before the start date, GetLog
returns no log events.
-Format format Optional. Format for log events. Valid types include:
-fm - Text
- XML
- Bin (binary)
If you choose binary, then you must specify a file name using the
OutputFile option.
If you do not specify a format, infacmd uses text format with lines
wrapped at 80 characters.
-OutputFile output_file_name Name and file path where you want to write the log file. By default,
-lo the Service Manager uses the server\infa_shared\log directory on
the master gateway node.
Omit this option to display the log events on the screen.
If you choose binary as the output file type, you must specify a file
name using this option.
GetLog 505
Option Argument Description
-ServiceType service_type Optional. Type of service for which you want to fetch log events.
-st You can specify one service type.
Omit this option to fetch log events for all service types.
Service types include:
- AS. Analyst Service
- BW. SAP BW Service
- CMS. Content Management Service
- DIS. Data Integration Service
- ES. Email Service
- IS. PowerCenter Integration Service
- MM. Metadata Manager Service
- MRS. Model Repository Service
- RMS. Resource Manager Service
- RS. PowerCenter Repository Service
- SCH. Scheduler Service
- SEARCH. Search Service
- TDM. Test Data Manager Service
- TDW. Test Data Warehouse Service
- WS. Web Services Hub
- DOMAIN. Domain
-ServiceName service_name Optional. Name of the service for which you want to fetch log
-sn events. To enter a name that contains a space or other non-
alphanumeric character, enclose the name in quotation marks.
GetNodeName
Returns the name of a node.
Gets the node name from the nodemeta.xml file on the node. You must enter this command on the node for
which you want to fetch the name.
-DomainName domain_name Required. Name of the Informatica domain. You can set the
-dn domain name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with both
methods, the -dn option takes precedence.
-UserName user_name Required if the domain uses Native or LDAP authentication. User
-un name to connect to the domain. You can set the user name with
the -un option or the environment variable
INFA_DEFAULT_DOMAIN_USER. If you set a user name with both
methods, the -un option takes precedence.
-Password password Required if you specify the user name. Password for the user
-pd name. The password is case sensitive. You can set a password
with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password with
both methods, the password set with the -pd option takes
precedence.
-SecurityDomain security_domain Required if the domain uses LDAP authentication. Optional if the
-sdn domain uses native authentication. Name of the security domain
to which the domain user belongs. You can set a security domain
with the -sdn option or the environment variable
INFA_DEFAULT_SECURITY_DOMAIN. If you set a security domain
name with both methods, the -sdn option takes precedence. The
security domain name is case sensitive.
If the domain uses native or LDAP authentication, the default is
Native. The name of the security domain is the same as the user
realm specified during installation.
GetPasswordComplexityConfig 507
getDomainSamlConfig
Returns the Secure Assertion Markup Language (SAML) authentication status for an Informatica domain. If
SAML authentication is enabled, the command also returns the identity provider URL and the allowed time
difference between the identity provider host system clock and the system clock on the master gateway
node.
Run the command on any gateway node within the Informatica domain. You must have the administrator role
to run this command.
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
[<-SecurityDomain|-sdn> security_domain]
<-Password|-pd> password
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
The following table describes infacmd isp getDomainSamlConfig options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set the
-dn domain name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with both
methods, the -dn option takes precedence.
-UserName user_name Required if the domain uses Native or LDAP authentication. User
-un name to connect to the domain. You can set the user name with
the -un option or the environment variable
INFA_DEFAULT_DOMAIN_USER. If you set a user name with both
methods, the -un option takes precedence.
Optional if the domain uses Kerberos authentication. To run the
command with single sign-on, do not set the user name. If you
set the user name, the command runs without single sign-on.
-Password password Required if you specify the user name. Password for the user
-pd name. The password is case sensitive. You can set a password
with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password with
both methods, the password set with the -pd option takes
precedence.
-SecurityDomain security_domain Required if the domain uses LDAP authentication. Optional if the
-sdn domain uses native authentication or Kerberos authentication.
Name of the security domain to which the domain user belongs.
You can set a security domain with the -sdn option or the
environment variable INFA_DEFAULT_SECURITY_DOMAIN. If you
set a security domain name with both methods, the -sdn option
takes precedence. The security domain name is case sensitive.
If the domain uses native or LDAP authentication, the default is
Native. If the domain uses Kerberos authentication, the default is
the LDAP security domain created during installation. The name
of the security domain is the same as the user realm specified
during installation.
GetServiceOption
Gets the value of a service property for a PowerCenter Integration Service, PowerCenter Repository Service,
SAP BW Service, or Web Services Hub. For Data Integration Service or Analyst Service options, run infacmd
dis or infacmd as ListServiceOptions.
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-ServiceName|-sn> service_name
<-OptionName|-op> option_name
GetServiceOption 509
The following table describes infacmd isp GetServiceOption options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set the domain
-dn name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with both
methods, the -dn option takes precedence.
-UserName user_name Required if the domain uses Native or LDAP authentication. User
-un name to connect to the domain. You can set the user name with the
-un option or the environment variable
INFA_DEFAULT_DOMAIN_USER. If you set a user name with both
methods, the -un option takes precedence.
Optional if the domain uses Kerberos authentication. To run the
command with single sign-on, do not set the user name. If you set
the user name, the command runs without single sign-on.
-Password password Required if you specify the user name. Password for the user name.
-pd The password is case sensitive. You can set a password with the -
pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password with
both methods, the password set with the -pd option takes
precedence.
-SecurityDomain security_domain Required if the domain uses LDAP authentication. Optional if the
-sdn domain uses native authentication or Kerberos authentication.
Name of the security domain to which the domain user belongs.
You can set a security domain with the -sdn option or the
environment variable INFA_DEFAULT_SECURITY_DOMAIN. If you set
a security domain name with both methods, the -sdn option takes
precedence. The security domain name is case sensitive.
If the domain uses native or LDAP authentication, the default is
Native. If the domain uses Kerberos authentication, the default is
the LDAP security domain created during installation. The name of
the security domain is the same as the user realm specified during
installation.
-ServiceName service_name Required. Name of the service for which you want to fetch a value.
-sn To enter a name that contains a space or other non-alphanumeric
character, enclose the name in quotation marks.
-OptionName option_name Required. Name of the option for which you want to retrieve a value.
-op The options you specify depend on the service type:
- For more information about Integration Service options, see
“Integration Service Options” on page 448.
- For an SAP BW Service, specify “BWSystemConXString” (the SAP
Destination R type) or “RetryPeriod” (the retry period in seconds).
- For more information about Web Services Hub options, see “Web
Services Hub Options” on page 477.
GetServiceProcessOption
Gets the value for a property on a PowerCenter Integration Service process running on a node.
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-ServiceName|-sn> service_name
<-NodeName|-nn> node_name
<-OptionName|-op> option_name
GetServiceProcessOption 511
The following table describes infacmd isp GetServiceProcessOption options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set the
-dn domain name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with both
methods, the -dn option takes precedence.
-UserName user_name Required if the domain uses Native or LDAP authentication. User
-un name to connect to the domain. You can set the user name with
the -un option or the environment variable
INFA_DEFAULT_DOMAIN_USER. If you set a user name with both
methods, the -un option takes precedence.
Optional if the domain uses Kerberos authentication. To run the
command with single sign-on, do not set the user name. If you set
the user name, the command runs without single sign-on.
-Password password Required if you specify the user name. Password for the user
-pd name. The password is case sensitive. You can set a password
with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password with
both methods, the password set with the -pd option takes
precedence.
-SecurityDomain security_domain Required if the domain uses LDAP authentication. Optional if the
-sdn domain uses native authentication or Kerberos authentication.
Name of the security domain to which the domain user belongs.
You can set a security domain with the -sdn option or the
environment variable INFA_DEFAULT_SECURITY_DOMAIN. If you
set a security domain name with both methods, the -sdn option
takes precedence. The security domain name is case sensitive.
If the domain uses native or LDAP authentication, the default is
Native. If the domain uses Kerberos authentication, the default is
the LDAP security domain created during installation. The name of
the security domain is the same as the user realm specified during
installation.
-ServiceName service_name Required. Name of the service for which you want to fetch a value.
-sn To enter a name that contains a space or other non-alphanumeric
character, enclose the name in quotation marks.
-NodeName node_name Required. Name of the node where the service process is running.
-nn
-OptionName option_name Required. Name of the option for which you want to retrieve a
-op value.
GetServiceProcessStatus
Gets the status of an application service process on a node. A service process can be enabled or disabled.
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-ServiceName|-sn> service_name
<-NodeName|-nn> node_name
The following table describes infacmd isp GetServiceProcessStatus options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set the
-dn domain name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with both
methods, the -dn option takes precedence.
-UserName user_name Required if the domain uses Native or LDAP authentication. User
-un name to connect to the domain. You can set the user name with
the -un option or the environment variable
INFA_DEFAULT_DOMAIN_USER. If you set a user name with both
methods, the -un option takes precedence.
Optional if the domain uses Kerberos authentication. To run the
command with single sign-on, do not set the user name. If you set
the user name, the command runs without single sign-on.
-Password password Required if you specify the user name. Password for the user
-pd name. The password is case sensitive. You can set a password
with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password with
both methods, the password set with the -pd option takes
precedence.
GetServiceProcessStatus 513
Option Argument Description
-SecurityDomain security_domain Required if the domain uses LDAP authentication. Optional if the
-sdn domain uses native authentication or Kerberos authentication.
Name of the security domain to which the domain user belongs.
You can set a security domain with the -sdn option or the
environment variable INFA_DEFAULT_SECURITY_DOMAIN. If you
set a security domain name with both methods, the -sdn option
takes precedence. The security domain name is case sensitive.
If the domain uses native or LDAP authentication, the default is
Native. If the domain uses Kerberos authentication, the default is
the LDAP security domain created during installation. The name of
the security domain is the same as the user realm specified during
installation.
-ServiceName service_name Required. Name of the service running the process for which you
-sn want the status. To enter a name that contains a space or other
non-alphanumeric character, enclose the name in quotation marks.
-NodeName node_name Required. Name of the node where the service process is running.
-nn
GetServiceStatus
Gets the status of an application service.
You can fetch the status of a service such as the Repository Service, Data Integration Service, Analyst
Service, Integration Service, Web Services Hub, or SAP BW Service. A service can be enabled or disabled.
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-ServiceName|-sn> service_name
-DomainName domain_name Required. Name of the Informatica domain. You can set the domain
-dn name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with both
methods, the -dn option takes precedence.
-UserName user_name Required if the domain uses Native or LDAP authentication. User
-un name to connect to the domain. You can set the user name with the
-un option or the environment variable
INFA_DEFAULT_DOMAIN_USER. If you set a user name with both
methods, the -un option takes precedence.
Optional if the domain uses Kerberos authentication. To run the
command with single sign-on, do not set the user name. If you set
the user name, the command runs without single sign-on.
-Password password Required if you specify the user name. Password for the user name.
-pd The password is case sensitive. You can set a password with the -
pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password with
both methods, the password set with the -pd option takes
precedence.
-SecurityDomain security_domain Required if the domain uses LDAP authentication. Optional if the
-sdn domain uses native authentication or Kerberos authentication.
Name of the security domain to which the domain user belongs.
You can set a security domain with the -sdn option or the
environment variable INFA_DEFAULT_SECURITY_DOMAIN. If you set
a security domain name with both methods, the -sdn option takes
precedence. The security domain name is case sensitive.
If the domain uses native or LDAP authentication, the default is
Native. If the domain uses Kerberos authentication, the default is
the LDAP security domain created during installation. The name of
the security domain is the same as the user realm specified during
installation.
-ServiceName service_name Required. Name of the service for which you want the status. To
-sn enter a name that contains a space or other non-alphanumeric
character, enclose the name in quotation marks.
GetServiceStatus 515
GetSessionLog
Gets log events for the most recent run of a session. The PowerCenter Repository Service must be running
when you run this command.
<-DomainName|-dn> domain_name
[<-UserName|-un> user_name]
[<-Password|-pd> password]
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
[<-Format|-fm> format_TEXT_XML_BIN]
[<-OutputFile|-lo> output_file_name]
<-IntegrationService|-is> integration_service_name
<-RepositoryService|-rs> repository_service_name
[<-RepositoryDomain|-rd> domain_of_repository]
<-RepositoryUser|-ru> repository_user]
<-RepositoryPassword|-rp> repository_password]
[<-RepositoryUserSecurityDomain|-rsdn> repository_user_security_domain]
<-FolderName|-fn> repository_folder_name
<-Workflow|-wf> workflow_name
<-Session|-ss> session_name
Note: If you do not specify -un, -pd, and -sdn options, the infacmd isp GetSessionLog command uses the
corresponding values from the -ru, -rp, and the -rsdn options.
-DomainName domain_name Required. Name of the Informatica domain. You can set the
-dn domain name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with both
methods, the -dn option takes precedence.
-Password password Required if you specify the user name. Password for the user
-pd name. The password is case sensitive. You can set a
password with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password
with both methods, the password set with the -pd option takes
precedence.
-Format format Optional. Format for the session log. Valid types include:
-fm - Text
- XML
- Bin (binary)
If you choose binary, then you must specify a file name using
the OutputFile option.
If you do not specify a format, infacmd uses text format with
lines wrapped at 80 characters.
GetSessionLog 517
Option Argument Description
-OutputFile output_file_name Name and file path for the session log file. By default, the
-lo Service Manager uses the server\infa_shared\log directory on
the master gateway node.
Omit this option to display the log events on the screen.
If you choose binary as the output file type, you must specify a
file name using this option.
‑IntegrationService integration_service_nam Required. Name of the Integration Service that runs the
-is e session.
To enter a name that contains a space or other non-
alphanumeric character, enclose the name in quotation marks.
-RepositoryService repository_service_name Required. Name of the Repository Service that contains the
-rs session.
To enter a name that contains a space or other non-
alphanumeric character, enclose the name in quotation marks.
-RepositoryDomain domain_of_repository Required if the repository is in a domain other than the local
-rd domain. Domain of the Repository Service. To enter a name
that contains a space or other non-alphanumeric character,
enclose the name in quotation marks.
-FolderName repository_folder_name Required. Name of the folder containing the session. To enter
-fn a name that contains a space or other non-alphanumeric
character, enclose the name in quotation marks.
-RunInstance run_instance_name Name of the workflow run instance that contains the session.
-in Use this option if you are running concurrent workflows. Use
the -in or the -id option, not both.
-RunId workflow_run_id Run identifier number (Run ID) of the workflow run instance
-id that contains the session. Use this option if you are running
concurrent workflows. Use the -in or the -id option, not both.
Note: Use this option if the workflow does not have a unique
run instance name.
GetSystemLogDirectory
Returns the path of the system log directory.
You must enter this command on the domain for which you want to fetch the system log directory path.
getUserActivityLog
Gets user activity logs for a single user or multiple users. You can write user activity logs to a file or display
them in the console.
The user activity log data includes successful and unsuccessful user login attempts from Informatica clients.
If the client includes custom properties set by the clients on login requests, the data includes the properties.
Note: User login attempts are not captured in the user activity logs in a domain configured to use Kerberos
authentication.
GetSystemLogDirectory 519
[<-ActivityCode|-ac> activity_code]
[<-ActivityText|-atxt> activity_text]
[<-ReverseOrder|-ro> true]
[<-OutputFile|-lo> output_file_name]
[<-Format|-fm> output_format_BIN_TEXT_XML]
The following table describes infacmd isp getUserActivityLog options and arguments:
- domain_name Required. Name of the Informatica domain. You can set the domain
DomainName name with the -dn option or the environment variable
-dn INFA_DEFAULT_DOMAIN. If you set a domain name with both
methods, the -dn option takes precedence.
-UserName user_name Required if the domain uses Native or LDAP authentication. User name
-un to connect to the domain. You can set the user name with the -un
option or the environment variable INFA_DEFAULT_DOMAIN_USER. If
you set a user name with both methods, the -un option takes
precedence.
Optional if the domain uses Kerberos authentication. To run the
command with single sign-on, do not set the user name. If you set the
user name, the command runs without single sign-on.
-Password password Required if you specify the user name. Password for the user name.
-pd The password is case sensitive. You can set a password with the -pd
option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password with both
methods, the password set with the -pd option takes precedence.
-Users user1:[securitydomain] Optional. The list of users that you want to get log events for.
-usrs user2:[securitydomain] Separate multiple users with a space. Use the wildcard symbol (*) to
... view logs for multiple users on a single security domain or all security
domains. For example, the following strings are valid values for the
option:
user:Native
"user:*"
"user*"
"*_users_*"
"*:Native"
If you use the wildcard symbol, enclose the argument in quotation
marks.
If you do not enter a user, the command retrieves the log events for all
users.
-StartDate start_date Optional. Returns log events starting from the date and time that you
-sd specify.
Enter the date and time in one of the following formats:
- MM/dd/yyyy
- MM/dd/yyyy HH:mm:ss
- yyyy-MM-dd
- yyyy-MM-dd HH:mm:ss
-EndDate end_date Optional. Returns log events ending by the date and time. Enter the
-ed date and time in the same format as the StartDate option.
If you enter an end date that is before the start date, the command
returns no log events.
-ActivityCode activity_code Optional. Returns log events based on the activity code.
-ac Use the wildcard symbol (*) to retrieve log events for multiple activity
codes. Valid activity codes include:
- CCM_10437. Indicates that an activity succeeded.
- CCM_10438. Indicates that an activity failed.
- CCM_10778. Indicates that a login attempt with custom properties
succeeded.
- CCM_10779. Indicates that a login attempt with custom properties
failed.
- CCM_10786. Indicates that a login attempt without custom
properties succeeded.
- CCM_10787. Indicates that a login attempt without custom
properties failed.
getUserActivityLog 521
Option Argument Description
-OutputFile output_file_name Optional. Name of the output file. If you do not specify this parameter,
-lo the command displays the log on the command line.
GetWorkflowLog
Gets log events for the most recent run of a workflow. The PowerCenter Repository Service must be running
when you run this command.
<-DomainName|-dn> domain_name
[<-UserName|-un> user_name]
[<-Password|-pd> password]
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
[<-Format|-fm> format_TEXT_XML_BIN]
[<-OutputFile|-lo> output_file_name]
<-IntegrationService|-is> integration_service_name
<-RepositoryService|-rs> repository_service_name
[<-RepositoryDomain|-rd> domain_of_repository]
<-RepositoryUser|-ru> repository_user
<-RepositoryPassword|-rp> repository_password
[<-RepositoryUserSecurityDomain|-rsdn> repository_user_security_domain]
<-FolderName|-fn> repository_folder_name
<-Workflow|-wf> workflow_name
The following table describes infacmd isp GetWorkflowLog options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set the
-dn domain name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with both
methods, the -dn option takes precedence.
-Password password Required if you specify the user name. Password for the user
-pd name. The password is case sensitive. You can set a password
with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password
with both methods, the password set with the -pd option takes
precedence.
GetWorkflowLog 523
Option Argument Description
-Format format Optional. Format for the session log. Valid types include:
-fm - Text
- XML
- Bin (binary)
If you choose binary, then you must specify a file name using
the OutputFile option.
If you do not specify a format, infacmd uses text format with
lines wrapped at 80 characters.
-OutputFile output_file_name Name and file path for the workflow log file. By default, the
-lo Service Manager uses the server\infa_shared\log directory on
the master gateway node. Omit this option to display the log
events on the screen. If you choose binary as the output file
type, you must specify a file name using this option.
‑IntegrationService integration_service_nam Required. Name of the Integration Service that runs the
-is e workflow. To enter a name that contains a space or other non-
alphanumeric character, enclose the name in quotation marks.
-RepositoryService repository_service_name Required. Name of the Repository Service that contains the
-rs workflow. To enter a name that contains a space or other non-
alphanumeric character, enclose the name in quotation marks.
-RepositoryDomain domain_of_repository Required if the repository is in a domain other than the local
-rd domain. Domain of the Repository Service. To enter a name
that contains a space or other non-alphanumeric character,
enclose the name in quotation marks.
-FolderName repository_folder_name Required. Name of the folder containing the workflow. To enter
-fn a name that contains a space or other non-alphanumeric
character, enclose the name in quotation marks.
-Workflow workflow_name Required. Name of the workflow. To enter a name that contains
-wf a space or other non-alphanumeric character, enclose the
name in quotation marks.
-RunInstance run_instance_name Name of the workflow run instance. Use this option if you are
-in running concurrent workflows. Use the -in or the -id option, not
both.
-RunId workflow_run_id Run identifier number (Run ID) of the workflow run instance.
-id Use this option if you are running concurrent workflows. Use
the -in or the -id option, not both.
Note: Use this option if the workflow does not have a unique
run instance name.
Help
Displays the options and arguments for an infacmd command.
- plugin_ID Optional. Describes which infacmd program to display help for. Default is isp.
- command Optional. Name of command. If you omit the command name, infacmd lists all
commands.
ImportDomainObjects
Imports native users, native groups, roles, connections, and cluster configurations from an XML file into an
Informatica domain.
If you do not want to import all objects in the file, use an infacmd import control file to filter the objects that
you want to import.
Use the ExportDomainObjects and ImportDomainObjects commands to migrate objects between two
different domains of the same version. To import native users and groups from domains of different
versions, use the infacmd isp ImportUsersAndGroups command.
When you import a group, you import all subgroups and users in the group.
Help 525
If the command fails with a Java memory error, increase the system memory available for infacmd. To
increase the system memory, set the -Xmx value in the ICMD_JAVA_OPTS environment variable.
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-ImportFilePath|-fp> import_file_path
[<-ImportControlFile|-cp> import_control_file]
[<-ConflictResolution|-cr> resolution_type]
The following table describes infacmd isp ImportDomainObjects options and arguments:
ImportDomainObjects 527
Option Argument Description
ImportUsersAndGroups
Imports native users and groups into the domain.
Run infacmd isp ImportUsersAndGroups to import users and groups from an XML file.
If the command fails with a Java memory error, increase the system memory available for infacmd. To
increase the system memory, set the -Xmx value in the ICMD_JAVA_OPTS environment variable.
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
ImportUsersAndGroups 529
<-ExportFile|-ef> export_file_name
[<-exportedFromPowercenter|-epc> The export file containing users and groups has been
exported from an Informatica PowerCenter 8.6.1 domain]
The following table describes infacmd isp ImportUsersAndGroups options and arguments:
-Password password Required if you specify the user name. Password for
-pd the user name. You can set a password with the -pd
option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a
password with both methods, the password set with
the -pd option takes precedence.
For a native user account, if you enable password
complexity, use the following guidelines when you
create or change a password:
- The length of the password must be at least eight
characters.
- It must be a combination of an alphabet character,
a numeric character and a non-alphanumeric
character, such as:
! \ " # $ % & ' ( ) * + , - . / : ; <
= > ? @ [ ] ^ _ ` { | } ~
When you use special characters in a password, the
shell sometimes interprets them differently. For
example, $ is interpreted as a variable. In this case,
use an escape character to escape the special
character.
-ExportFile export_file_name Required. Name and file path of the export file that
-ef contains the information about the users and groups.
Related Topics:
• “ExportUsersAndGroups” on page 497
ListAlertUsers
Lists users that subscribe to alerts.
<-DomainName|-dn> domain_name
ListAlertUsers 531
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
The following table describes infacmd isp ListAlertUsers options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set the
-dn domain name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with both
methods, the -dn option takes precedence.
-UserName user_name Required if the domain uses Native or LDAP authentication. User
-un name to connect to the domain. You can set the user name with
the -un option or the environment variable
INFA_DEFAULT_DOMAIN_USER. If you set a user name with both
methods, the -un option takes precedence.
Optional if the domain uses Kerberos authentication. To run the
command with single sign-on, do not set the user name. If you
set the user name, the command runs without single sign-on.
-Password password Required if you specify the user name. Password for the user
-pd name. The password is case sensitive. You can set a password
with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password with
both methods, the password set with the -pd option takes
precedence.
-SecurityDomain security_domain Required if the domain uses LDAP authentication. Optional if the
-sdn domain uses native authentication or Kerberos authentication.
Name of the security domain to which the domain user belongs.
You can set a security domain with the -sdn option or the
environment variable INFA_DEFAULT_SECURITY_DOMAIN. If you
set a security domain name with both methods, the -sdn option
takes precedence. The security domain name is case sensitive.
If the domain uses native or LDAP authentication, the default is
Native. If the domain uses Kerberos authentication, the default
is the LDAP security domain created during installation. The
name of the security domain is the same as the user realm
specified during installation.
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
The following table describes infacmd isp listAllCustomLDAPTypes options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set the
-dn domain name with the -dn option or the environment
variable INFA_DEFAULT_DOMAIN. If you set a domain name
with both methods, the -dn option takes precedence.
-Password password Required if you specify the user name. Password for the
-pd user name. The password is case sensitive. You can set a
password with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password
with both methods, the password set with the -pd option
takes precedence.
listAllCustomLDAPTypes 533
Option Argument Description
ListAllGroups
Lists all the groups in the native security domain.
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
The following table describes the infacmd isp ListAllGroups options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set the
-dn domain name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with both
methods, the -dn option takes precedence.
-UserName user_name Required if the domain uses Native or LDAP authentication. User
-un name to connect to the domain. You can set the user name with
the -un option or the environment variable
INFA_DEFAULT_DOMAIN_USER. If you set a user name with both
methods, the -un option takes precedence.
Optional if the domain uses Kerberos authentication. To run the
command with single sign-on, do not set the user name. If you set
the user name, the command runs without single sign-on.
-Password password Required if you specify the user name. Password for the user
-pd name. The password is case sensitive. You can set a password
with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password with
both methods, the password set with the -pd option takes
precedence.
-SecurityDomain security_domain Required if the domain uses LDAP authentication. Optional if the
-sdn domain uses native authentication or Kerberos authentication.
Name of the security domain to which the domain user belongs.
You can set a security domain with the -sdn option or the
environment variable INFA_DEFAULT_SECURITY_DOMAIN. If you
set a security domain name with both methods, the -sdn option
takes precedence. The security domain name is case sensitive.
If the domain uses native or LDAP authentication, the default is
Native. If the domain uses Kerberos authentication, the default is
the LDAP security domain created during installation. The name
of the security domain is the same as the user realm specified
during installation.
listAllLDAPConnectivity
Lists the configuration information for all LDAP configurations used by the specified domain.
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
listAllLDAPConnectivity 535
The following table describes infacmd isp listAllLDAPConnectivity options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set the
-dn domain name with the -dn option or the environment
variable INFA_DEFAULT_DOMAIN. If you set a domain name
with both methods, the -dn option takes precedence.
-Password password Required if you specify the user name. Password for the
-pd user name. The password is case sensitive. You can set a
password with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password
with both methods, the password set with the -pd option
takes precedence.
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
The following table describes the infacmd isp ListAllRoles options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set the
-dn domain name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with both
methods, the -dn option takes precedence.
-UserName user_name Required if the domain uses Native or LDAP authentication. User
-un name to connect to the domain. You can set the user name with
the -un option or the environment variable
INFA_DEFAULT_DOMAIN_USER. If you set a user name with both
methods, the -un option takes precedence.
Optional if the domain uses Kerberos authentication. To run the
command with single sign-on, do not set the user name. If you set
the user name, the command runs without single sign-on.
-Password password Required if you specify the user name. Password for the user
-pd name. The password is case sensitive. You can set a password
with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password with
both methods, the password set with the -pd option takes
precedence.
-SecurityDomain security_domain Required if the domain uses LDAP authentication. Optional if the
-sdn domain uses native authentication or Kerberos authentication.
Name of the security domain to which the domain user belongs.
You can set a security domain with the -sdn option or the
environment variable INFA_DEFAULT_SECURITY_DOMAIN. If you
set a security domain name with both methods, the -sdn option
takes precedence. The security domain name is case sensitive.
If the domain uses native or LDAP authentication, the default is
Native. If the domain uses Kerberos authentication, the default is
the LDAP security domain created during installation. The name
of the security domain is the same as the user realm specified
during installation.
ListAllRoles 537
Option Argument Description
ListAllUsers
Lists all the user accounts in the domain.
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
The following table describes the infacmd isp ListAllUsers options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set the
-dn domain name with the -dn option or the environment
variable INFA_DEFAULT_DOMAIN. If you set a domain name
with both methods, the -dn option takes precedence.
-Password password Required if you specify the user name. Password for the
-pd user name. The password is case sensitive. You can set a
password with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password
with both methods, the password set with the -pd option
takes precedence.
ListConnectionOptions
Lists options for a connection. Run this command to view available options to configure when you update a
connection.
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-ConnectionName|-cn> connection_name
ListConnectionOptions 539
The following table describes infacmd isp ListConnectionOptions options and arguments:
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<<-RecipientUserName|-run> recipient_user_name|<RecipientGroupName|-rgn>
recipient_group_name>
<-RecipientSecurityDomain|-rsd> recipient_security_domain]
<-ConnectionName|-cn> connection_name
The following table describes infacmd isp ListConnectionPermissions options and arguments:
ListConnectionPermissions 541
Option Argument Description
ListConnectionPermissionsByGroup
Lists all groups that have permissions on a connection and lists the type of permissions.
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
ListConnectionPermissionsByGroup 543
Option Argument Description
ListConnectionPermissionsByUser
Lists the users that have permissions for a connection and lists the type of permissions.
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-ConnectionName|-cn> connection_name
The following table describes infacmd isp ListConnectionPermissionsByUser options and arguments:
ListConnections
Lists connection names by type. You can list by all connection types or filter the results by one connection
type.
ListConnections 545
The following table describes infacmd isp ListConnections options and arguments:
-ConnectionType connection_type Optional. You can filter results with the -ct option.
-ct Use any supported connection type as the value for
the -ct option. The input is not case sensitive.
To see a list of connection types to use with this
option, run the following command:
./infacmd.sh isp listConnections
The command lists all connection types and the
connections that you configured on the domain.
ListConnectionOptions
Lists options for a connection. Run this command to view available options to configure when you update a
connection.
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-ConnectionName|-cn> connection_name
ListConnectionOptions 547
The following table describes infacmd isp ListConnectionOptions options and arguments:
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-CustomLDAPTypeName|-lt> custom_LDAP_type_name
The following table describes infacmd isp listCustomLDAPType options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set the
-dn domain name with the -dn option or the environment
variable INFA_DEFAULT_DOMAIN. If you set a domain name
with both methods, the -dn option takes precedence.
-Password password Required if you specify the user name. Password for the
-pd user name. The password is case sensitive. You can set a
password with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password
with both methods, the password set with the -pd option
takes precedence.
listCustomLDAPType 549
Option Argument Description
ListDefaultOSProfiles
Lists the default operating system profiles for the given user or group.
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
[<-RecipientName|-nm> recipient_name]
[<-RecipientSecurityDomain|-ns> security_domain_of_recipient]
[<-RecipientType|-ty> recipient_type]
[<-IndirectInheritance|-in> indirect_inheritance]
-DomainName domain_name Required. Name of the Informatica domain. You can set
-dn the domain name with the -dn option or the environment
variable INFA_DEFAULT_DOMAIN. If you set a domain
name with both methods, the -dn option takes
precedence.
-Password password Required if you specify the user name. Password for the
-pd user name. The password is case sensitive. You can set
a password with the -pd option or the environment
variable INFA_DEFAULT_DOMAIN_PASSWORD. If you set
a password with both methods, the password set with
the -pd option takes precedence.
ListDefaultOSProfiles 551
Option Argument Description
-RecipientSecurityDomain security_domain_of_recipient Optional. Name of the security domain that the user
-ns belongs to, if you use LDAP authentication.
ListDomainCiphers
Lists one or more of the following cipher suite lists: blacklist, default list, effective list, or whitelist.
When you use secure communication within the domain and secure connections to web clients, Informatica
uses an effective list of cipher suites to encrypt traffic. Informatica determines the effective list of cipher
suites based on the following lists:
Blacklist
List of cipher suites that you want the Informatica domain to block. When you add a cipher suite to the
blacklist, the Informatica domain removes the cipher suite from the effective list. You can add cipher
suites that are on the default list to the blacklist.
Default list
Whitelist
List of cipher suites that you want the Informatica domain to support in addition to the default list. When
you add a cipher suite to the whitelist, the Informatica domain adds the cipher suite to the effective list.
You do not need to add cipher suites that are on the default list to the whitelist.
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
[<-lists|-l> comma_separated_list_of_cipher_configurations...
The following table describes infacmd isp ListDomainCiphers options and arguments:
ListDomainCiphers 553
Option Argument Description
ListDomainLinks
Lists the domains to which the local domain can connect. You establish links between two domains if you
want to exchange repository metadata between them.
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
-DomainName domain_name Required. Name of the Informatica domain. You can set the
-dn domain name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with both
methods, the -dn option takes precedence.
-UserName user_name Required if the domain uses Native or LDAP authentication. User
-un name to connect to the domain. You can set the user name with
the -un option or the environment variable
INFA_DEFAULT_DOMAIN_USER. If you set a user name with both
methods, the -un option takes precedence.
Optional if the domain uses Kerberos authentication. To run the
command with single sign-on, do not set the user name. If you
set the user name, the command runs without single sign-on.
-Password password Required if you specify the user name. Password for the user
-pd name. The password is case sensitive. You can set a password
with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password with
both methods, the password set with the -pd option takes
precedence.
-SecurityDomain security_domain Required if the domain uses LDAP authentication. Optional if the
-sdn domain uses native authentication or Kerberos authentication.
Name of the security domain to which the domain user belongs.
You can set a security domain with the -sdn option or the
environment variable INFA_DEFAULT_SECURITY_DOMAIN. If you
set a security domain name with both methods, the -sdn option
takes precedence. The security domain name is case sensitive.
If the domain uses native or LDAP authentication, the default is
Native. If the domain uses Kerberos authentication, the default
is the LDAP security domain created during installation. The
name of the security domain is the same as the user realm
specified during installation.
ListDomainOptions
Lists general properties of the domain. Properties include resilience timeout, limit on resilience timeouts,
maximum restart attempts, restart period, SSL mode, and dispatch mode.
To run the infacmd isp ListDomainOptions command, you must have permission on the domain.
ListDomainOptions 555
The infacmd isp ListDomainOptions command uses the following syntax:
ListDomainOptions
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
The following table describes infacmd isp ListDomainOptions options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set the
-dn domain name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with both
methods, the -dn option takes precedence.
-UserName user_name Required if the domain uses Native or LDAP authentication. User
-un name to connect to the domain. You can set the user name with
the -un option or the environment variable
INFA_DEFAULT_DOMAIN_USER. If you set a user name with both
methods, the -un option takes precedence.
Optional if the domain uses Kerberos authentication. To run the
command with single sign-on, do not set the user name. If you
set the user name, the command runs without single sign-on.
-Password password Required if you specify the user name. Password for the user
-pd name. The password is case sensitive. You can set a password
with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password with
both methods, the password set with the -pd option takes
precedence.
-SecurityDomain security_domain Required if the domain uses LDAP authentication. Optional if the
-sdn domain uses native authentication or Kerberos authentication.
Name of the security domain to which the domain user belongs.
You can set a security domain with the -sdn option or the
environment variable INFA_DEFAULT_SECURITY_DOMAIN. If you
set a security domain name with both methods, the -sdn option
takes precedence. The security domain name is case sensitive.
If the domain uses native or LDAP authentication, the default is
Native. If the domain uses Kerberos authentication, the default
is the LDAP security domain created during installation. The
name of the security domain is the same as the user realm
specified during installation.
ListFolders
Lists the folders in the domain.
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
The following table describes infacmd isp ListFolders options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set the
-dn domain name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with both
methods, the -dn option takes precedence.
-UserName user_name Required if the domain uses Native or LDAP authentication. User
-un name to connect to the domain. You can set the user name with
the -un option or the environment variable
INFA_DEFAULT_DOMAIN_USER. If you set a user name with both
methods, the -un option takes precedence.
Optional if the domain uses Kerberos authentication. To run the
command with single sign-on, do not set the user name. If you
set the user name, the command runs without single sign-on.
ListFolders 557
Option Argument Description
-Password password Required if you specify the user name. Password for the user
-pd name. The password is case sensitive. You can set a password
with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password with
both methods, the password set with the -pd option takes
precedence.
-SecurityDomain security_domain Required if the domain uses LDAP authentication. Optional if the
-sdn domain uses native authentication or Kerberos authentication.
Name of the security domain to which the domain user belongs.
You can set a security domain with the -sdn option or the
environment variable INFA_DEFAULT_SECURITY_DOMAIN. If you
set a security domain name with both methods, the -sdn option
takes precedence. The security domain name is case sensitive.
If the domain uses native or LDAP authentication, the default is
Native. If the domain uses Kerberos authentication, the default
is the LDAP security domain created during installation. The
name of the security domain is the same as the user realm
specified during installation.
ListGridNodes
Lists the nodes assigned to a grid.
To run the infacmd isp ListGridNodes command, you must have permission on the grid.
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-GridName|-gn> grid_name
-DomainName domain_name Required. Name of the Informatica domain. You can set the
-dn domain name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with both
methods, the -dn option takes precedence.
-UserName user_name Required if the domain uses Native or LDAP authentication. User
-un name to connect to the domain. You can set the user name with
the -un option or the environment variable
INFA_DEFAULT_DOMAIN_USER. If you set a user name with both
methods, the -un option takes precedence.
Optional if the domain uses Kerberos authentication. To run the
command with single sign-on, do not set the user name. If you
set the user name, the command runs without single sign-on.
-Password password Required if you specify the user name. Password for the user
-pd name. The password is case sensitive. You can set a password
with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password with
both methods, the password set with the -pd option takes
precedence.
-SecurityDomain security_domain Required if the domain uses LDAP authentication. Optional if the
-sdn domain uses native authentication or Kerberos authentication.
Name of the security domain to which the domain user belongs.
You can set a security domain with the -sdn option or the
environment variable INFA_DEFAULT_SECURITY_DOMAIN. If you
set a security domain name with both methods, the -sdn option
takes precedence. The security domain name is case sensitive.
If the domain uses native or LDAP authentication, the default is
Native. If the domain uses Kerberos authentication, the default
is the LDAP security domain created during installation. The
name of the security domain is the same as the user realm
specified during installation.
ListGridNodes 559
ListGroupPermissions
Lists group permissions on an object.
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-ExistingGroup|-eg> existing_group_name
[<-ExistingGroupSecurityDomain|-egn> existing_group_security_domain]
[<-ObjectType|-ot> object_type_SERVICE_LICENSE_NODE_GRID_FOLDER_OSPROFILE]
The following table describes infacmd isp ListGroupPermissions options and arguments:
ListGroupPermissions 561
ListGroupPrivileges
Lists privileges assigned to a group in the domain. You can list group privileges for each application in the
domain.
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-GroupName|-gn> group_name
[<-GroupSecurityDomain|-gsf> group_security_domain]
<-ServiceName|-sn> service_name
The following table describes infacmd isp ListGroupPrivileges options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set the
-dn domain name with the -dn option or the environment
variable INFA_DEFAULT_DOMAIN. If you set a domain name
with both methods, the -dn option takes precedence.
-Password password Required if you specify the user name. Password for the
-pd user name. The password is case sensitive. You can set a
password with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password
with both methods, the password set with the -pd option
takes precedence.
-GroupName group_name Required. Name of the group for which you want to list
-gn privileges.
-ServiceName service_name Required. Domain or application service name for which you
-sn want to view privileges.
ListGroupsForUser
Lists the native groups to which the user is assigned.
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
ListGroupsForUser 563
<-ExistingUserName|-eu> existing_user_Name
[<-ExistingUserSecurityDomain|-esd> existing_user_security_domain]
The following table describes infacmd isp ListGroupsForUser options and arguments:
-Password password Required if you specify the user name. Password for
-pd the user name. The password is case sensitive. You
can set a password with the -pd option or the
environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a
password with both methods, the password set with
the -pd option takes precedence.
-ExistingUserName existing_user_Name Required. Name of the user for which you want to list
-eu the groups.
ListLDAPConnectivity
Lists the details for the specified LDAP configuration.
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-LDAPHostConfigurationName|-lcn> LDAP_host_configuration_name
ListLDAPConnectivity 565
The following table describes infacmd isp ListLDAPConnectivity options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set the
-dn domain name with the -dn option or the environment
variable INFA_DEFAULT_DOMAIN. If you set a domain name
with both methods, the -dn option takes precedence.
-Password password Required if you specify the user name. Password for the
-pd user name. The password is case sensitive. You can set a
password with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password
with both methods, the password set with the -pd option
takes precedence.
To run the infacmd isp ListLicenses command, you must have permission on the licenses.
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
The following table describes infacmd isp ListLicenses options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set the domain
-dn name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with both
methods, the -dn option takes precedence.
-UserName user_name Required if the domain uses Native or LDAP authentication. User
-un name to connect to the domain. You can set the user name with
the -un option or the environment variable
INFA_DEFAULT_DOMAIN_USER. If you set a user name with both
methods, the -un option takes precedence.
Optional if the domain uses Kerberos authentication. To run the
command with single sign-on, do not set the user name. If you set
the user name, the command runs without single sign-on.
-Password password Required if you specify the user name. Password for the user
-pd name. The password is case sensitive. You can set a password
with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password with
both methods, the password set with the -pd option takes
precedence.
-SecurityDomain security_domain Required if the domain uses LDAP authentication. Optional if the
-sdn domain uses native authentication or Kerberos authentication.
Name of the security domain to which the domain user belongs.
You can set a security domain with the -sdn option or the
environment variable INFA_DEFAULT_SECURITY_DOMAIN. If you
set a security domain name with both methods, the -sdn option
takes precedence. The security domain name is case sensitive.
If the domain uses native or LDAP authentication, the default is
Native. If the domain uses Kerberos authentication, the default is
the LDAP security domain created during installation. The name of
the security domain is the same as the user realm specified during
installation.
ListLicenses 567
Option Argument Description
ListMonitoringOptions
List monitoring general properties.
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
The following table describes infacmd isp listMonitoringOptions options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set the
-dn domain name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with both
methods, the -dn option takes precedence.
-UserName user_name Required if the domain uses Native or LDAP authentication. User
-un name to connect to the domain. You can set the user name with
the -un option or the environment variable
INFA_DEFAULT_DOMAIN_USER. If you set a user name with both
methods, the -un option takes precedence.
Optional if the domain uses Kerberos authentication. To run the
command with single sign-on, do not set the user name. If you
set the user name, the command runs without single sign-on.
-Password password Required if you specify the user name. Password for the user
-pd name. The password is case sensitive. You can set a password
with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password with
both methods, the password set with the -pd option takes
precedence.
-SecurityDomain security_domain Required if the domain uses LDAP authentication. Optional if the
-sdn domain uses native authentication or Kerberos authentication.
Name of the security domain to which the domain user belongs.
You can set a security domain with the -sdn option or the
environment variable INFA_DEFAULT_SECURITY_DOMAIN. If you
set a security domain name with both methods, the -sdn option
takes precedence. The security domain name is case sensitive.
If the domain uses native or LDAP authentication, the default is
Native. If the domain uses Kerberos authentication, the default is
the user realm specified during installation.
ListNodeOptions
Lists general properties for a node. General properties include backup directory, CPU profile, error severity
level, maximum and minimum process ports, and resource provision thresholds.
To run the infacmd isp ListNodeOptions command, you must have permission on the node.
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-NodeName|-nn> node_name
ListNodeOptions 569
The following table describes infacmd isp ListNodeOptions options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set the
-dn domain name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with both
methods, the -dn option takes precedence.
-UserName user_name Required if the domain uses Native or LDAP authentication. User
-un name to connect to the domain. You can set the user name with
the -un option or the environment variable
INFA_DEFAULT_DOMAIN_USER. If you set a user name with both
methods, the -un option takes precedence.
Optional if the domain uses Kerberos authentication. To run the
command with single sign-on, do not set the user name. If you
set the user name, the command runs without single sign-on.
-Password password Required if you specify the user name. Password for the user
-pd name. The password is case sensitive. You can set a password
with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password with
both methods, the password set with the -pd option takes
precedence.
-SecurityDomain security_domain Required if the domain uses LDAP authentication. Optional if the
-sdn domain uses native authentication or Kerberos authentication.
Name of the security domain to which the domain user belongs.
You can set a security domain with the -sdn option or the
environment variable INFA_DEFAULT_SECURITY_DOMAIN. If you
set a security domain name with both methods, the -sdn option
takes precedence. The security domain name is case sensitive.
If the domain uses native or LDAP authentication, the default is
Native. If the domain uses Kerberos authentication, the default
is the LDAP security domain created during installation. The
name of the security domain is the same as the user realm
specified during installation.
-NodeName node_name Required. Name of the node for which you want to list the
-nn options.
To run the infacmd isp ListNodeResources command, you must have permission on the node.
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-NodeName|-nn> node_name
-DomainName domain_name Required. Name of the Informatica domain. You can set the
-dn domain name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with both
methods, the -dn option takes precedence.
-UserName user_name Required if the domain uses Native or LDAP authentication. User
-un name to connect to the domain. You can set the user name with
the -un option or the environment variable
INFA_DEFAULT_DOMAIN_USER. If you set a user name with both
methods, the -un option takes precedence.
Optional if the domain uses Kerberos authentication. To run the
command with single sign-on, do not set the user name. If you set
the user name, the command runs without single sign-on.
-Password password Required if you specify the user name. Password for the user
-pd name. The password is case sensitive. You can set a password
with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password with
both methods, the password set with the -pd option takes
precedence.
ListNodeResources 571
Option Argument Description
-SecurityDomain security_domain Required if the domain uses LDAP authentication. Optional if the
-sdn domain uses native authentication or Kerberos authentication.
Name of the security domain to which the domain user belongs.
You can set a security domain with the -sdn option or the
environment variable INFA_DEFAULT_SECURITY_DOMAIN. If you
set a security domain name with both methods, the -sdn option
takes precedence. The security domain name is case sensitive.
If the domain uses native or LDAP authentication, the default is
Native. If the domain uses Kerberos authentication, the default is
the LDAP security domain created during installation. The name of
the security domain is the same as the user realm specified during
installation.
-NodeName node_name Required. Name of the node for which you want to list the
-nn resources.
-ResourceCategory resource_category Optional. Category of resources that you want to list. Valid
-rc categories include:
- PCIS. Resource for the PowerCenter Integration Service.
- DIS. Reserved for future use.
Default is PCIS.
ListNodeRoles
Lists all roles on a node in the domain.
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-NodeName|-nn> node_name
-DomainName domain_name Required. Name of the Informatica domain. You can set the
-dn domain name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with both
methods, the -dn option takes precedence.
-Password password Required if you specify the user name. Password for the user
-pd name. The password is case sensitive. You can set a password
with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password
with both methods, the password set with the -pd option takes
precedence.
ListNodeRoles 573
ListNodes
Lists the nodes in the domain. If you do not use the node role option, the command lists all the nodes in the
domain. If you use the node role option, the command lists the nodes with the specified role.
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
-DomainName domain_name Required. Name of the Informatica domain. You can set the
-dn domain name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with both
methods, the -dn option takes precedence.
-UserName user_name Required if the domain uses Native or LDAP authentication. User
-un name to connect to the domain. You can set the user name with
the -un option or the environment variable
INFA_DEFAULT_DOMAIN_USER. If you set a user name with both
methods, the -un option takes precedence.
Optional if the domain uses Kerberos authentication. To run the
command with single sign-on, do not set the user name. If you
set the user name, the command runs without single sign-on.
-Password password Required if you specify the user name. Password for the user
-pd name. The password is case sensitive. You can set a password
with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password with
both methods, the password set with the -pd option takes
precedence.
-SecurityDomain security_domain Required if the domain uses LDAP authentication. Optional if the
-sdn domain uses native authentication or Kerberos authentication.
Name of the security domain to which the domain user belongs.
You can set a security domain with the -sdn option or the
environment variable INFA_DEFAULT_SECURITY_DOMAIN. If you
set a security domain name with both methods, the -sdn option
takes precedence. The security domain name is case sensitive.
If the domain uses native or LDAP authentication, the default is
Native. If the domain uses Kerberos authentication, the default
is the LDAP security domain created during installation. The
name of the security domain is the same as the user realm
specified during installation.
-NodeRole node_role Optional. Role enabled on the nodes that you want to list. Enter
-nr one of the following values:
- Service. Lists nodes with at least the service role.
- Compute. Lists nodes with at least the compute role.
- Service_compute. Lists nodes with both the service and
compute roles.
If you omit the option, the command lists all nodes in the
domain.
ListOSProfiles
Lists the operating system profiles in the domain.
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
ListOSProfiles 575
The following table describes infacmd isp ListOSProfile options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set the
-dn domain name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with both
methods, the -dn option takes precedence.
-UserName user_name Required if the domain uses Native or LDAP authentication. User
-un name to connect to the domain. You can set the user name with
the -un option or the environment variable
INFA_DEFAULT_DOMAIN_USER. If you set a user name with both
methods, the -un option takes precedence.
Optional if the domain uses Kerberos authentication. To run the
command with single sign-on, do not set the user name. If you set
the user name, the command runs without single sign-on.
-Password password Required if you specify the user name. Password for the user
-pd name. The password is case sensitive. You can set a password
with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password with
both methods, the password set with the -pd option takes
precedence.
-SecurityDomain security_domain Required if the domain uses LDAP authentication. Optional if the
-sdn domain uses native authentication or Kerberos authentication.
Name of the security domain to which the domain user belongs.
You can set a security domain with the -sdn option or the
environment variable INFA_DEFAULT_SECURITY_DOMAIN. If you
set a security domain name with both methods, the -sdn option
takes precedence. The security domain name is case sensitive.
If the domain uses native or LDAP authentication, the default is
Native. If the domain uses Kerberos authentication, the default is
the LDAP security domain created during installation. The name of
the security domain is the same as the user realm specified during
installation.
ListRepositoryLDAPConfiguration
Lists the LDAP server configuration options such as LDAP server address, search scope, and login attributes.
Use this command after you install Informatica to verify the connection between the domain and the LDAP
external directory service.
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
The following table describes infacmd isp ListRepositoryLDAPConfiguration options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set the
-dn domain name with the -dn option or the environment
variable INFA_DEFAULT_DOMAIN. If you set a domain name
with both methods, the -dn option takes precedence.
-Password password Required if you specify the user name. Password for the
-pd user name. The password is case sensitive. You can set a
password with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password
with both methods, the password set with the -pd option
takes precedence.
ListRepositoryLDAPConfiguration 577
Option Argument Description
ListRolePrivileges
Lists privileges assigned to a role in the domain. You can list role privileges for each application service in
the domain.
You can list privileges assigned to a role for the domain and for each application service type in the domain.
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-RoleName|-rn> role_name
The following table describes ListRolePrivileges options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set the
-dn domain name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with both
methods, the -dn option takes precedence.
-Password password Required if you specify the user name. Password for the user
-pd name. The password is case sensitive. You can set a
password with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password
with both methods, the password set with the -pd option
takes precedence.
-RoleName role_name Required. Name of the role to list privileges for. To enter a
-rn name that contains a space or other non-alphanumeric
character, enclose the name in quotation marks.
ListSecurityDomains
Lists the native and LDAP security domains in the domain.
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
ListSecurityDomains 579
The following table describes the infacmd isp ListSecurityDomains options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set the
-dn domain name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with both
methods, the -dn option takes precedence.
-UserName user_name Required if the domain uses Native or LDAP authentication. User
-un name to connect to the domain. You can set the user name with
the -un option or the environment variable
INFA_DEFAULT_DOMAIN_USER. If you set a user name with both
methods, the -un option takes precedence.
Optional if the domain uses Kerberos authentication. To run the
command with single sign-on, do not set the user name. If you set
the user name, the command runs without single sign-on.
-Password password Required if you specify the user name. Password for the user
-pd name. The password is case sensitive. You can set a password
with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password with
both methods, the password set with the -pd option takes
precedence.
-SecurityDomain security_domain Required if the domain uses LDAP authentication. Optional if the
-sdn domain uses native authentication or Kerberos authentication.
Name of the security domain to which the domain user belongs.
You can set a security domain with the -sdn option or the
environment variable INFA_DEFAULT_SECURITY_DOMAIN. If you
set a security domain name with both methods, the -sdn option
takes precedence. The security domain name is case sensitive.
If the domain uses native or LDAP authentication, the default is
Native. If the domain uses Kerberos authentication, the default is
the LDAP security domain created during installation. The name
of the security domain is the same as the user realm specified
during installation.
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
The following table describes infacmd isp ListServiceLevels options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set the
-dn domain name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with both
methods, the -dn option takes precedence.
-UserName user_name Required if the domain uses Native or LDAP authentication. User
-un name to connect to the domain. You can set the user name with
the -un option or the environment variable
INFA_DEFAULT_DOMAIN_USER. If you set a user name with both
methods, the -un option takes precedence.
Optional if the domain uses Kerberos authentication. To run the
command with single sign-on, do not set the user name. If you
set the user name, the command runs without single sign-on.
-Password password Required if you specify the user name. Password for the user
-pd name. The password is case sensitive. You can set a password
with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password with
both methods, the password set with the -pd option takes
precedence.
-SecurityDomain security_domain Required if the domain uses LDAP authentication. Optional if the
-sdn domain uses native authentication or Kerberos authentication.
Name of the security domain to which the domain user belongs.
You can set a security domain with the -sdn option or the
environment variable INFA_DEFAULT_SECURITY_DOMAIN. If you
set a security domain name with both methods, the -sdn option
takes precedence. The security domain name is case sensitive.
If the domain uses native or LDAP authentication, the default is
Native. If the domain uses Kerberos authentication, the default
is the LDAP security domain created during installation. The
name of the security domain is the same as the user realm
specified during installation.
ListServiceLevels 581
Option Argument Description
ListServiceNodes
Lists the nodes or grid assigned to a service.
If this command returns a grid name, you can run the infacmd isp ListGridNodes command to list the nodes
in the grid.
To run the infacmd isp ListServiceNodes command, you must have permission on the service.
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-ServiceName|-sn> service_name
The following table describes infacmd isp ListServiceNodes options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set the
-dn domain name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with both
methods, the -dn option takes precedence.
-UserName user_name Required if the domain uses Native or LDAP authentication. User
-un name to connect to the domain. You can set the user name with
the -un option or the environment variable
INFA_DEFAULT_DOMAIN_USER. If you set a user name with both
methods, the -un option takes precedence.
Optional if the domain uses Kerberos authentication. To run the
command with single sign-on, do not set the user name. If you
set the user name, the command runs without single sign-on.
-Password password Required if you specify the user name. Password for the user
-pd name. The password is case sensitive. You can set a password
with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password with
both methods, the password set with the -pd option takes
precedence.
-SecurityDomain security_domain Required if the domain uses LDAP authentication. Optional if the
-sdn domain uses native authentication or Kerberos authentication.
Name of the security domain to which the domain user belongs.
You can set a security domain with the -sdn option or the
environment variable INFA_DEFAULT_SECURITY_DOMAIN. If you
set a security domain name with both methods, the -sdn option
takes precedence. The security domain name is case sensitive.
If the domain uses native or LDAP authentication, the default is
Native. If the domain uses Kerberos authentication, the default
is the LDAP security domain created during installation. The
name of the security domain is the same as the user realm
specified during installation.
Related Topics:
• “ListGridNodes” on page 558
ListServicePrivileges
Lists the privileges for a domain or application service type.
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
ListServicePrivileges 583
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
-DomainName domain_name Required. Name of the Informatica domain. You can set the
-dn domain name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with both
methods, the -dn option takes precedence.
-UserName user_name Required if the domain uses Native or LDAP authentication. User
-un name to connect to the domain. You can set the user name with
the -un option or the environment variable
INFA_DEFAULT_DOMAIN_USER. If you set a user name with both
methods, the -un option takes precedence.
Optional if the domain uses Kerberos authentication. To run the
command with single sign-on, do not set the user name. If you
set the user name, the command runs without single sign-on.
-Password password Required if you specify the user name. Password for the user
-pd name. The password is case sensitive. You can set a password
with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password with
both methods, the password set with the -pd option takes
precedence.
-SecurityDomain security_domain Required if the domain uses LDAP authentication. Optional if the
-sdn domain uses native authentication or Kerberos authentication.
Name of the security domain to which the domain user belongs.
You can set a security domain with the -sdn option or the
environment variable INFA_DEFAULT_SECURITY_DOMAIN. If you
set a security domain name with both methods, the -sdn option
takes precedence. The security domain name is case sensitive.
If the domain uses native or LDAP authentication, the default is
Native. If the domain uses Kerberos authentication, the default
is the LDAP security domain created during installation. The
name of the security domain is the same as the user realm
specified during installation.
-ServiceType service_type Optional. Domain or application service type for which you want
-st to view privileges.
Service types include:
- AS. Analyst Service
- CMS. Content Management Service
- CS. Catalog Service
- MM. Metadata Manager Service
- MRS. Model Repository Service
- RS. PowerCenter Repository Service
- TDM. Test Data Manager Service
- TDW. Test Data Warehouse Service
- DOMAIN. Domain
ListServices
Lists the services in the domain.
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
ListServices 585
The following table describes infacmd isp ListServices options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set the domain
-dn name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with both
methods, the -dn option takes precedence.
-SecurityDomain security_domain Required if the domain uses LDAP authentication. Optional if the
-sdn domain uses native authentication or Kerberos authentication.
Name of the security domain to which the domain user belongs. You
can set a security domain with the -sdn option or the environment
variable INFA_DEFAULT_SECURITY_DOMAIN. If you set a security
domain name with both methods, the -sdn option takes precedence.
The security domain name is case sensitive.
If the domain uses native or LDAP authentication, the default is
Native. If the domain uses Kerberos authentication, the default is
the LDAP security domain created during installation. The name of
the security domain is the same as the user realm specified during
installation.
-UserName user_name Required if the domain uses Native or LDAP authentication. User
-un name to connect to the domain. You can set the user name with the
-un option or the environment variable
INFA_DEFAULT_DOMAIN_USER. If you set a user name with both
methods, the -un option takes precedence.
Optional if the domain uses Kerberos authentication. To run the
command with single sign-on, do not set the user name. If you set
the user name, the command runs without single sign-on.
-Password password Required if you specify the user name. Password for the user name.
-pd The password is case sensitive. You can set a password with the -pd
option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password with
both methods, the password set with the -pd option takes
precedence.
ListSMTPOptions
Lists the SMTP configuration properties for the domain. The SMTP configuration is used to send domain
alerts and scorecard notifications.
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
ListSMTPOptions 587
The following table describes infacmd isp ListSMTPOptions options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set the
-dn domain name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with both
methods, the -dn option takes precedence.
-UserName user_name Required if the domain uses Native or LDAP authentication. User
-un name to connect to the domain. You can set the user name with
the -un option or the environment variable
INFA_DEFAULT_DOMAIN_USER. If you set a user name with both
methods, the -un option takes precedence.
Optional if the domain uses Kerberos authentication. To run the
command with single sign-on, do not set the user name. If you
set the user name, the command runs without single sign-on.
-Password password Required if you specify the user name. Password for the user
-pd name. The password is case sensitive. You can set a password
with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password with
both methods, the password set with the -pd option takes
precedence.
-SecurityDomain security_domain Required if the domain uses LDAP authentication. Optional if the
-sdn domain uses native authentication or Kerberos authentication.
Name of the security domain to which the domain user belongs.
You can set a security domain with the -sdn option or the
environment variable INFA_DEFAULT_SECURITY_DOMAIN. If you
set a security domain name with both methods, the -sdn option
takes precedence. The security domain name is case sensitive.
If the domain uses native or LDAP authentication, the default is
Native. If the domain uses Kerberos authentication, the default
is the LDAP security domain created during installation. The
name of the security domain is the same as the user realm
specified during installation.
ListUserPermissions
Lists the domain objects on which a user has permissions.
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-ExistingUserName|-eu> existing_user_name
[<-ExistingUserSecurityDomain|-esd> existing_user_security_domain]
[<-ObjectType|-ot> object_type_SERVICE_LICENSE_NODE_GRID_FOLDER_OSPROFILE]
The following table describes infacmd isp ListUserPermissions options and arguments:
ListUserPermissions 589
Option Argument Description
-ExistingUserName existing_user_name Required. User account for which you want to list
-eu privileges. To enter a name that contains space or
other non-alphanumeric character, enclose the
name in quotation marks.
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-ExistingUserName|-eu> existing_user_Name
[<-ExistingUserSecurityDomain|-esd> existing_user_security_domain]
<-ServiceName|-sn> service_name
The following table describes the infacmd isp ListUserPrivileges options and arguments:
-Password password Required if you specify the user name. Password for
-pd the user name. The password is case sensitive. You
can set a password with the -pd option or the
environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a
password with both methods, the password set with
the -pd option takes precedence.
ListUserPrivileges 591
Option Argument Description
ExistingUserName existing_user_name Required. User account for which you want to list
-eu privileges. To enter a name that contains a space or
other non-alphanumeric character, enclose the name
in quotation marks.
infacmd ListWeakPasswordUsers
Lists the users with passwords that do not meet the password policy.
-DomainName domain_name Required. Name of the Informatica domain. You can set the
-dn domain name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with both
methods, the -dn option takes precedence.
-UserName user_name Required if the domain uses Native or LDAP authentication. User
-un name to connect to the domain. You can set the user name with
the -un option or the environment variable
INFA_DEFAULT_DOMAIN_USER. If you set a user name with both
methods, the -un option takes precedence.
-Password password Required if you specify the user name. Password for the user
-pd name. The password is case sensitive. You can set a password
with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password with
both methods, the password set with the -pd option takes
precedence.
-SecurityDomain security_domain Required if the domain uses LDAP authentication. Optional if the
-sdn domain uses native authentication. Name of the security domain
to which the domain user belongs. You can set a security domain
with the -sdn option or the environment variable
INFA_DEFAULT_SECURITY_DOMAIN. If you set a security domain
name with both methods, the -sdn option takes precedence. The
security domain name is case sensitive.
If the domain uses native or LDAP authentication, the default is
Native. The name of the security domain is the same as the user
realm specified during installation.
migrateUsers
Migrates the groups, roles, privileges, and permissions of users in the native security domain to users in one
or more LDAP security domains. Before you configure a domain to use Kerberos authentication, you must
migrate the users to an LDAP security domain.
For more information about the migrateUsers command, see the Informatica Security Guide.
<-DomainName|-dn> domain_name
migrateUsers 593
<-UserName|-un> administrator_user_name
<-Password|-pd> administrator_password
[<-SecurityDomain|-sdn>|security_domain]
[<-Gateway|-hp>|gateway_host1:port gateway_host2:port...]
[<-ResilienceTimeout|-re> timeout_period_in_seconds ]
<-UserMigrationFile|-umf> user_migration_file
The following table describes infacmd isp migrateUsers options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set the
-dn domain name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with both
methods, the -dn option takes precedence.
-UserName administrator_user_nam Required. User name to connect to the domain. You can set the
-un e user name with the -un option or the environment variable
INFA_DEFAULT_DOMAIN_USER. If you set a user name with
both methods, the -un option takes precedence.
-Password administrator_password Required. Password for the user name. The password is case
-pd sensitive. You can set a password with the -pd option or the
environment variable INFA_DEFAULT_DOMAIN_PASSWORD. If
you set a password with both methods, the password set with
the -pd option takes precedence.
-SecurityDomain security_domain Optional. Name of the security domain to which the domain
-sdn user belongs. You can set a security domain with the -sdn
option or the environment variable
INFA_DEFAULT_SECURITY_DOMAIN. If you set a security
domain name with both methods, the -sdn option takes
precedence. The security domain name is case sensitive.
Note: This security domain is the security domain of the user
account used to connect to the domain, not the security
domain to which the users will be migrated.
-UserMigrationFile user_migration_file Required. Path and file name of the user migration file. The
-umf user migration file is a text file that contains the list of native
users and the corresponding LDAP users. Entries must be in
the following format:
Native/<SourceUserName>,LDAP/<TargetUsername>
For example, to migrate a user named User1 from the native
security domain to a user named User1 in an LDAP security
domain, add the following line to the user migration file:
Native/User1,LDAP/User1
The command skips entries with a duplicate source user name
or target user name.
MoveFolder
Moves a folder.
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-OriginalPath|-op> original_folder_path
<-FolderPath|-fp> full_folder_path
MoveFolder 595
The following table describes infacmd isp MoveFolder options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set the
-dn domain name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with both
methods, the -dn option takes precedence.
-UserName user_name Required if the domain uses Native or LDAP authentication. User
-un name to connect to the domain. You can set the user name with
the -un option or the environment variable
INFA_DEFAULT_DOMAIN_USER. If you set a user name with both
methods, the -un option takes precedence.
Optional if the domain uses Kerberos authentication. To run the
command with single sign-on, do not set the user name. If you
set the user name, the command runs without single sign-on.
-Password password Required if you specify the user name. Password for the user
-pd name. The password is case sensitive. You can set a password
with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password with
both methods, the password set with the -pd option takes
precedence.
-SecurityDomain security_domain Required if the domain uses LDAP authentication. Optional if the
-sdn domain uses native authentication or Kerberos authentication.
Name of the security domain to which the domain user belongs.
You can set a security domain with the -sdn option or the
environment variable INFA_DEFAULT_SECURITY_DOMAIN. If you
set a security domain name with both methods, the -sdn option
takes precedence. The security domain name is case sensitive.
If the domain uses native or LDAP authentication, the default is
Native. If the domain uses Kerberos authentication, the default
is the LDAP security domain created during installation. The
name of the security domain is the same as the user realm
specified during installation.
-OriginalPath original_folder_path Required. Full path, excluding the domain name, to the folder you
-op want to move. Must be in the following format:
/parent_folder/child_folder
-FolderPath full_folder_path Required. Full path, excluding the domain name, to the target
-fp folder location. Must be in the following format:
/parent_folder/child_folder
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-ObjectName|-on> object_name
<-ObjectType|-ot> object_type_SERVICE_LICENSE_NODE_GRID
<-FolderPath|-fp> full_folder_path
The following table describes infacmd isp MoveObject options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set the
-dn domain name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with both
methods, the -dn option takes precedence.
-UserName user_name Required if the domain uses Native or LDAP authentication. User
-un name to connect to the domain. You can set the user name with
the -un option or the environment variable
INFA_DEFAULT_DOMAIN_USER. If you set a user name with both
methods, the -un option takes precedence.
Optional if the domain uses Kerberos authentication. To run the
command with single sign-on, do not set the user name. If you
set the user name, the command runs without single sign-on.
-Password password Required if you specify the user name. Password for the user
-pd name. The password is case sensitive. You can set a password
with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password with
both methods, the password set with the -pd option takes
precedence.
MoveObject 597
Option Argument Description
-SecurityDomain security_domain Required if the domain uses LDAP authentication. Optional if the
-sdn domain uses native authentication or Kerberos authentication.
Name of the security domain to which the domain user belongs.
You can set a security domain with the -sdn option or the
environment variable INFA_DEFAULT_SECURITY_DOMAIN. If you
set a security domain name with both methods, the -sdn option
takes precedence. The security domain name is case sensitive.
If the domain uses native or LDAP authentication, the default is
Native. If the domain uses Kerberos authentication, the default
is the LDAP security domain created during installation. The
name of the security domain is the same as the user realm
specified during installation.
-FolderPath full_folder_path Required. Full path, excluding the domain name, to the folder
-fp into which you want to move the object. Must be in the following
format:
/parent_folder/child_folder
Ping
Pings a domain, service, domain gateway host, or node. If the object is available, this command displays a
message that the object is available at a specific port on the gateway host machine. If the object is
unavailable, this command displays a message saying that it failed to receive a response from the object.
Use this command to troubleshoot network connections. To run the infacmd isp Ping command, you must
have permission on the object you want to ping.
The infacmd isp Ping command does not display results for individual service processes.
[<-DomainName|-dn> domain_name]
[<-ServiceName|-sn> service_name]
[<-GatewayAddress|-dg> domain_gateway_host:port]
[<-NodeName|-nn> node_name]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
The following table describes infacmd isp Ping options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set the
-dn domain name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with both
methods, the -dn option takes precedence.
-ServiceName service_name Optional. Name of the service you want to ping. To enter a name
-sn that contains a space or other non-alphanumeric character,
enclose the name in quotation marks.
-GatewayAddress domain_gateway_host:p Required if you do not specify the -DomainName option, or if you
-dg ort need to ping another domain. Gateway host machine name and
port number.
PingDomain
Pings all nodes and services in a domain. Displays the status of the domain, nodes, and services. You can
choose to write the output to a text or .csv file.
The output uses the following formats to display the status of the domain, nodes, and services:
If a service is disabled in the domain, the status displays DISABLED. The output does not display the node
name, and the host name and port number.
If the service runs on a grid, the command pings each node in the grid. The output displays the status of the
service on each node.
PingDomain 599
The infacmd isp PingDomain command uses the following syntax:
PingDomain
[<-DomainName|-dn> domain_name]
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
[<-Format|-fm> format_TEXT_CSV]
[<-OutputFile|-of> output_file_name]
The following table describes infacmd isp PingDomain options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set the
-dn domain name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with both
methods, the -dn option takes precedence.
-UserName user_name Required if the domain uses Native or LDAP authentication. User
-un name to connect to the domain. You can set the user name with
the -un option or the environment variable
INFA_DEFAULT_DOMAIN_USER. If you set a user name with both
methods, the -un option takes precedence.
Optional if the domain uses Kerberos authentication. To run the
command with single sign-on, do not set the user name. If you
set the user name, the command runs without single sign-on.
-Password password Required if you specify the user name. Password for the user
-pd name. The password is case sensitive. You can set a password
with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password with
both methods, the password set with the -pd option takes
precedence.
-SecurityDomain security_domain Required if the domain uses LDAP authentication. Optional if the
-sdn domain uses native authentication or Kerberos authentication.
Name of the security domain to which the domain user belongs.
You can set a security domain with the -sdn option or the
environment variable INFA_DEFAULT_SECURITY_DOMAIN. If you
set a security domain name with both methods, the -sdn option
takes precedence. The security domain name is case sensitive.
If the domain uses native or LDAP authentication, the default is
Native. If the domain uses Kerberos authentication, the default
is the LDAP security domain created during installation. The
name of the security domain is the same as the user realm
specified during installation.
-Format format_TEXT_CSV Optional. Format to display the status of the domain, nodes, and
-fm services. You can specify TEXT or CSV. The default format is
TEXT.
-OutputFile output_file_name Name and file path where you want to write the output file.
-of
PrintSPNAndKeytabNames
Generates the list of SPN and keytab file names for the nodes and services in the domain. The Informatica
domain requires a keytab file for each SPN. You might need to ask the Kerberos administrator to add the
SPNs to the principal database and create the keytab files. The SPN and keytab file names are case
sensitive.
<-DomainName|-dn> domain_name
<-ServiceRealmName|-srn> realm_name_of_node_spn
[<-Format|-fm> format_TEXT_CSV]
[<-OutputFile|-of> output_file_name]
-DomainName domain_name Required. Name of the Informatica domain. You can set the
-dn domain name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with both
methods, the -dn option takes precedence.
-ServiceRealmName realm_name_of_node_ Required. Name of the Kerberos realm to which the Informatica
-srn spn domain services belong. The realm name must be in uppercase
and is case sensitive.
PrintSPNAndKeytabNames 601
Option Argument Description
-OutputFile output_file_name Optional. Name and file path for the output file.
-of If you do not specify an output file name, infacmd displays the
log events on the screen.
-DomainNodes NodeName:HostName Name of the node and the fully qualified host name of the
-dns [NodeName:Hostname machine that hosts the node. Use the following format:
] NodeName:HostName
You can generate SPNs and keytab file names for multiple
nodes. Separate each node name and host name pair with a
space.
-ServiceProcesses ServiceName:Nodena Optional. Name of the service that you want to create in the
-sps me Informatica domain and the name of the node on which the
[ServiceName:Nodena service will run. Use the following format:
me] ServiceName:NodeName
You can generate SPNs and keytab file names for multiple
services. Separate each service name and node name pair with a
space.
Note: The keytab files for application services in the domain do
not have to be available when you configure the domain to use
Kerberos authentication. You can add the service SPN to the
principal database and create the keytab after you change the
Informatica domain authentication but before you enable the
service.
SPNShareLevel SPNShareLevel Optional. Indicates the service principal level for the domain. Set
-spnSL PROCESS|NODE] the property to one of the following levels:
- Process. The domain requires a unique service principal name
(SPN) and keytab file for each node and each service on a
node. The number of SPNs and keytab files required for each
node depends on the number of service processes that run on
the node. Recommended for production domains.
- Node. The domain uses one SPN and keytab file for the node
and all services that run on the node. It also requires a
separate SPN and keytab file for all HTTP processes on the
node. Recommended for test and development domains.
Recommended for test and development domains.
Default is process.
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-BeforeDate|-bd> before_date
The following table describes infacmd isp PurgeLog options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set the
-dn domain name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with both
methods, the -dn option takes precedence.
-UserName user_name Required if the domain uses Native or LDAP authentication. User
-un name to connect to the domain. You can set the user name with
the -un option or the environment variable
INFA_DEFAULT_DOMAIN_USER. If you set a user name with both
methods, the -un option takes precedence.
Optional if the domain uses Kerberos authentication. To run the
command with single sign-on, do not set the user name. If you set
the user name, the command runs without single sign-on.
-Password password Required if you specify the user name. Password for the user
-pd name. The password is case sensitive. You can set a password
with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password with
both methods, the password set with the -pd option takes
precedence.
-SecurityDomain security_domain Required if the domain uses LDAP authentication. Optional if the
-sdn domain uses native authentication or Kerberos authentication.
Name of the security domain to which the domain user belongs.
You can set a security domain with the -sdn option or the
environment variable INFA_DEFAULT_SECURITY_DOMAIN. If you
set a security domain name with both methods, the -sdn option
takes precedence. The security domain name is case sensitive.
If the domain uses native or LDAP authentication, the default is
Native. If the domain uses Kerberos authentication, the default is
the LDAP security domain created during installation. The name of
the security domain is the same as the user realm specified during
installation.
PurgeLog 603
Option Argument Description
-BeforeDate before_date Required. Purges log events that occurred before this date and
-bd time. Enter date and time in one of the following formats:
- MM/dd/yyyy
- yyyy-MM-dd
PurgeMonitoringData
Purges monitoring data from the Model repository.
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
[<-NumDaysToRetain|-ndr> num_days_to_retain]
[<-NumDaysToRetainDetailedStat|-ndrds> num_days_to_retain_detailed_stat]
PurgeMonitoringData 605
Option Argument Description
RemoveAlertUser
Unsubscribes a user from alert notification emails. You can run infacmd isp RemoveAlertUser for any user.
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-AlertUser|-au> user_name
-DomainName domain_name Required. Name of the Informatica domain. You can set the
-dn domain name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with both
methods, the -dn option takes precedence.
-UserName user_name Required if the domain uses Native or LDAP authentication. User
-un name to connect to the domain. You can set the user name with
the -un option or the environment variable
INFA_DEFAULT_DOMAIN_USER. If you set a user name with both
methods, the -un option takes precedence.
Optional if the domain uses Kerberos authentication. To run the
command with single sign-on, do not set the user name. If you
set the user name, the command runs without single sign-on.
-Password password Required if you specify the user name. Password for the user
-pd name. The password is case sensitive. You can set a password
with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password with
both methods, the password set with the -pd option takes
precedence.
-SecurityDomain security_domain Required if the domain uses LDAP authentication. Optional if the
-sdn domain uses native authentication or Kerberos authentication.
Name of the security domain to which the domain user belongs.
You can set a security domain with the -sdn option or the
environment variable INFA_DEFAULT_SECURITY_DOMAIN. If you
set a security domain name with both methods, the -sdn option
takes precedence. The security domain name is case sensitive.
If the domain uses native or LDAP authentication, the default is
Native. If the domain uses Kerberos authentication, the default
is the LDAP security domain created during installation. The
name of the security domain is the same as the user realm
specified during installation.
-AlertUser user_name Required. Name of user you want to unsubscribes from alerts.
-au
RemoveAlertUser 607
RemoveConnection
Removes a connection from the domain.
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-ConnectionName|-cn> connection_name
The following table describes infacmd isp RemoveConnection options and arguments:
RemoveConnectionPermissions
Removes connection permissions for a user or group.
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<<-RecipientUserName|-run> recipient_user_name|<ReceipeintGroupName|-rgn>
recipeint_group_name>
<-RecipientSecurityDomain|-rsd> recipient_security_domain]
<-ConnectionName|-cn> connection_name
RemoveConnectionPermissions 609
The following table describes infacmd isp RemoveConnectionPermissions options and arguments:
removeCustomLDAPType
Removes the specified custom LDAP type.
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-CustomLDAPTypeName|-lt> custom_LDAP_type_name
The following table describes infacmd isp removeCustomLDAPType options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set the
-dn domain name with the -dn option or the environment
variable INFA_DEFAULT_DOMAIN. If you set a domain name
with both methods, the -dn option takes precedence.
removeCustomLDAPType 611
Option Argument Description
-Password password Required if you specify the user name. Password for the
-pd user name. The password is case sensitive. You can set a
password with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password
with both methods, the password set with the -pd option
takes precedence.
-CustomLDAPTypeName custom_LDAP_type_name Required. The name of the custom LDAP type to remove.
-lt
RemoveDomainLink
Removes a linked domain. When you remove a linked domain, you cannot exchange repository metadata
between the local and linked domains. You might want to do this if you no longer need to access a
PowerCenter Repository Service in another domain.
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
<-LinkedDomainName|-ld> linked_domain_name
The following table describes infacmd isp RemoveDomainLink options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set the
-dn domain name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with both
methods, the -dn option takes precedence.
-UserName user_name Required if the domain uses Native or LDAP authentication. User
-un name to connect to the domain. You can set the user name with
the -un option or the environment variable
INFA_DEFAULT_DOMAIN_USER. If you set a user name with both
methods, the -un option takes precedence.
Optional if the domain uses Kerberos authentication. To run the
command with single sign-on, do not set the user name. If you
set the user name, the command runs without single sign-on.
-Password password Required if you specify the user name. Password for the user
-pd name. The password is case sensitive. You can set a password
with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password with
both methods, the password set with the -pd option takes
precedence.
-SecurityDomain security_domain Required if the domain uses LDAP authentication. Optional if the
-sdn domain uses native authentication or Kerberos authentication.
Name of the security domain to which the domain user belongs.
You can set a security domain with the -sdn option or the
environment variable INFA_DEFAULT_SECURITY_DOMAIN. If you
set a security domain name with both methods, the -sdn option
takes precedence. The security domain name is case sensitive.
If the domain uses native or LDAP authentication, the default is
Native. If the domain uses Kerberos authentication, the default
is the LDAP security domain created during installation. The
name of the security domain is the same as the user realm
specified during installation.
-LinkedDomainName linked_domain_name Required. Name of the domain from which you want to remove a
-ld connection.
RemoveDomainLink 613
RemoveFolder
Removes a folder from the domain. Before you remove a folder, make sure that the folder is empty.
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-FolderPath|-fp> full_folder_path
The following table describes infacmd isp RemoveFolder options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set the
-dn domain name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with both
methods, the -dn option takes precedence.
-UserName user_name Required if the domain uses Native or LDAP authentication. User
-un name to connect to the domain. You can set the user name with
the -un option or the environment variable
INFA_DEFAULT_DOMAIN_USER. If you set a user name with both
methods, the -un option takes precedence.
Optional if the domain uses Kerberos authentication. To run the
command with single sign-on, do not set the user name. If you
set the user name, the command runs without single sign-on.
-Password password Required if you specify the user name. Password for the user
-pd name. The password is case sensitive. You can set a password
with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password with
both methods, the password set with the -pd option takes
precedence.
-SecurityDomain security_domain Required if the domain uses LDAP authentication. Optional if the
-sdn domain uses native authentication or Kerberos authentication.
Name of the security domain to which the domain user belongs.
You can set a security domain with the -sdn option or the
environment variable INFA_DEFAULT_SECURITY_DOMAIN. If you
set a security domain name with both methods, the -sdn option
takes precedence. The security domain name is case sensitive.
If the domain uses native or LDAP authentication, the default is
Native. If the domain uses Kerberos authentication, the default
is the LDAP security domain created during installation. The
name of the security domain is the same as the user realm
specified during installation.
-FolderPath full_folder_path Required. Full path, excluding the domain name, to the folder you
-fp want to remove. Must be in the following format:
/parent_folder/child_folder
RemoveGrid
Removes a grid from the domain. Before you can remove a grid, you must unassign the grid from the
PowerCenter Integration Service or Data Integration Service.
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-GridName|-gn> grid_name
The following table describes infacmd isp RemoveGrid options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set the
-dn domain name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with both
methods, the -dn option takes precedence.
-UserName user_name Required. User name to connect to the domain. You can set the
-un user name with the -un option or the environment variable
INFA_DEFAULT_DOMAIN_USER. If you set a user name with both
methods, the -un option takes precedence.
RemoveGrid 615
Option Argument Description
-Password password Required. Password for the user name. The password is case
-pd sensitive. You can set a password with the -pd option or the
environment variable INFA_DEFAULT_DOMAIN_PASSWORD. If
you set a password with both methods, the password set with
the -pd option takes precedence.
-SecurityDomain security_domain Required if the domain uses LDAP authentication. Optional if the
-sdn domain uses native authentication or Kerberos authentication.
Name of the security domain to which the domain user belongs.
You can set a security domain with the -sdn option or the
environment variable INFA_DEFAULT_SECURITY_DOMAIN. If you
set a security domain name with both methods, the -sdn option
takes precedence. The security domain name is case sensitive.
If the domain uses native or LDAP authentication, the default is
Native. If the domain uses Kerberos authentication, the default
is the LDAP security domain created during installation. The
name of the security domain is the same as the user realm
specified during installation.
RemoveGroup
Removes a group from the native security domain.
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-GroupName|-gn> group_name
-DomainName domain_name Required. Name of the Informatica domain. You can set the
-dn domain name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with both
methods, the -dn option takes precedence.
-UserName user_name Required if the domain uses Native or LDAP authentication. User
-un name to connect to the domain. You can set the user name with
the -un option or the environment variable
INFA_DEFAULT_DOMAIN_USER. If you set a user name with both
methods, the -un option takes precedence.
Optional if the domain uses Kerberos authentication. To run the
command with single sign-on, do not set the user name. If you
set the user name, the command runs without single sign-on.
-Password password Required if you specify the user name. Password for the user
-pd name. The password is case sensitive. You can set a password
with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password with
both methods, the password set with the -pd option takes
precedence.
-SecurityDomain security_domain Required if the domain uses LDAP authentication. Optional if the
-sdn domain uses native authentication or Kerberos authentication.
Name of the security domain to which the domain user belongs.
You can set a security domain with the -sdn option or the
environment variable INFA_DEFAULT_SECURITY_DOMAIN. If you
set a security domain name with both methods, the -sdn option
takes precedence. The security domain name is case sensitive.
If the domain uses native or LDAP authentication, the default is
Native. If the domain uses Kerberos authentication, the default
is the LDAP security domain created during installation. The
name of the security domain is the same as the user realm
specified during installation.
RemoveGroup 617
RemoveGroupPermission
Removes a group permission on an object.
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-ExistingGroup|-eg> existing_group_name
[<-GroupSecurityDomain|-gsf> group_security_domain]
<-ObjectName|-on> object_name
<-ObjectType|-ot> object_type_SERVICE_LICENSE_NODE_GRID_FOLDER_OSPROFILE
The following table describes infacmd isp RemoveGroupPermission options and arguments:
-ObjectName object_name Name of the object that you want to remove the
-on group access permission.
RemoveGroupPermission 619
RemoveGroupPrivilege
Removes a privilege from a group in the domain. You can remove a privilege from a group for the domain or
an application service in the domain.
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-GroupName|-gn> group_name
[<-GroupSecurityDomain|-gsf> group_security_domain]
<-ServiceName|-sn> service_name
<-PrivilegePath|-pp> path_of_privilege
The following table describes infacmd isp RemoveGroupPrivilege options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set the
-dn domain name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with both
methods, the -dn option takes precedence.
-Password password Required if you specify the user name. Password for the user
-pd name. The password is case sensitive. You can set a
password with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password
with both methods, the password set with the -pd option takes
precedence.
-GroupName group_name Required. Name of the group from which you are removing the
-gn privilege. To enter a name that contains a space or other non-
alphanumeric character, enclose the name in quotation marks.
-GroupSecurityDomain group_security_domain Required if you use LDAP authentication. Name of the security
-gsf domain that the group from which you are removing privileges
belongs to. Default is Native.
-ServiceName service_name Required. Domain or application service name for which you
-sn want to view privileges.
RemoveGroupPrivilege 621
removeLDAPConnectivity
Removes the specified LDAP configuration.
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-LDAPHostConfigurationName|-lcn> LDAP_host_configuration_name
The following table describes infacmd isp removeLDAPConnectivity options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set the
-dn domain name with the -dn option or the environment
variable INFA_DEFAULT_DOMAIN. If you set a domain name
with both methods, the -dn option takes precedence.
-Password password Required if you specify the user name. Password for the
-pd user name. The password is case sensitive. You can set a
password with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password
with both methods, the password set with the -pd option
takes precedence.
RemoveLicense
Removes a license from the domain. Before you run this command, you must first disable the services
assigned to the license.
Removes a license from a domain when it expires or when you want to move the license to another domain.
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-LicenseName|-ln> license_name
RemoveLicense 623
The following table describes infacmd isp RemoveLicense options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set the
-dn domain name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with both
methods, the -dn option takes precedence.
-UserName user_name Required if the domain uses Native or LDAP authentication. User
-un name to connect to the domain. You can set the user name with
the -un option or the environment variable
INFA_DEFAULT_DOMAIN_USER. If you set a user name with both
methods, the -un option takes precedence.
Optional if the domain uses Kerberos authentication. To run the
command with single sign-on, do not set the user name. If you set
the user name, the command runs without single sign-on.
-Password password Required if you specify the user name. Password for the user
-pd name. The password is case sensitive. You can set a password
with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password with
both methods, the password set with the -pd option takes
precedence.
-SecurityDomain security_domain Required if the domain uses LDAP authentication. Optional if the
-sdn domain uses native authentication or Kerberos authentication.
Name of the security domain to which the domain user belongs.
You can set a security domain with the -sdn option or the
environment variable INFA_DEFAULT_SECURITY_DOMAIN. If you
set a security domain name with both methods, the -sdn option
takes precedence. The security domain name is case sensitive.
If the domain uses native or LDAP authentication, the default is
Native. If the domain uses Kerberos authentication, the default is
the LDAP security domain created during installation. The name of
the security domain is the same as the user realm specified during
installation.
Related Topics:
• “DisableService” on page 481
• “UnassignLicense” on page 664
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-NodeName|-nn> node_name
The following table describes infacmd isp RemoveNode options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set the
-dn domain name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with both
methods, the -dn option takes precedence.
-UserName user_name Required if the domain uses Native or LDAP authentication. User
-un name to connect to the domain. You can set the user name with
the -un option or the environment variable
INFA_DEFAULT_DOMAIN_USER. If you set a user name with both
methods, the -un option takes precedence.
Optional if the domain uses Kerberos authentication. To run the
command with single sign-on, do not set the user name. If you set
the user name, the command runs without single sign-on.
-Password password Required if you specify the user name. Password for the user
-pd name. The password is case sensitive. You can set a password
with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password with
both methods, the password set with the -pd option takes
precedence.
-SecurityDomain security_domain Required if the domain uses LDAP authentication. Optional if the
-sdn domain uses native authentication or Kerberos authentication.
Name of the security domain to which the domain user belongs.
You can set a security domain with the -sdn option or the
environment variable INFA_DEFAULT_SECURITY_DOMAIN. If you
set a security domain name with both methods, the -sdn option
takes precedence. The security domain name is case sensitive.
If the domain uses native or LDAP authentication, the default is
Native. If the domain uses Kerberos authentication, the default is
the LDAP security domain created during installation. The name of
the security domain is the same as the user realm specified during
installation.
RemoveNode 625
Option Argument Description
RemoveNodeResource
Removes a resource from a node. You can remove a custom or file or directory resource from a node. You
cannot remove a connection resource from a node.
When a PowerCenter Integration Service runs on a grid, the Load Balancer can use resources to distribute
Session, Command, and predefined Event-Wait tasks. If the PowerCenter Integration Service is configured to
check resources, the Load Balancer distributes tasks to nodes where the resources are added and enabled. If
you remove a resource that is required by the Session or Command task, the task can no longer run on that
node.
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-NodeName|-nn> node_name
<-ResourceName|-rn> resource_name
-DomainName domain_name Required. Name of the Informatica domain. You can set the
-dn domain name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with both
methods, the -dn option takes precedence.
-UserName user_name Required if the domain uses Native or LDAP authentication. User
-un name to connect to the domain. You can set the user name with
the -un option or the environment variable
INFA_DEFAULT_DOMAIN_USER. If you set a user name with both
methods, the -un option takes precedence.
Optional if the domain uses Kerberos authentication. To run the
command with single sign-on, do not set the user name. If you set
the user name, the command runs without single sign-on.
-Password password Required if you specify the user name. Password for the user
-pd name. The password is case sensitive. You can set a password
with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password with
both methods, the password set with the -pd option takes
precedence.
-SecurityDomain security_domain Required if the domain uses LDAP authentication. Optional if the
-sdn domain uses native authentication or Kerberos authentication.
Name of the security domain to which the domain user belongs.
You can set a security domain with the -sdn option or the
environment variable INFA_DEFAULT_SECURITY_DOMAIN. If you
set a security domain name with both methods, the -sdn option
takes precedence. The security domain name is case sensitive.
If the domain uses native or LDAP authentication, the default is
Native. If the domain uses Kerberos authentication, the default is
the LDAP security domain created during installation. The name of
the security domain is the same as the user realm specified during
installation.
-NodeName node_name Required. Name of the node that has the resource you want to
-nn remove.
RemoveNodeResource 627
Option Argument Description
-ResourceType resource_type Required. Type of resource you want to remove. Valid types
-rt include:
- Custom
- File Directory
-ResourceName resource_name Required. Entire name of the resource you want to remove.
-rn To list the names of all resources available to a node, run the
infacmd isp ListNodeResources command.
RemoveOSProfile
Removes an operating system profile from the domain.
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-OSProfileName|-on> OSProfile_name
The following table describes infacmd isp RemoveOSProfile options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set the domain
-dn name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with both
methods, the -dn option takes precedence.
-UserName user_name Required if the domain uses Native or LDAP authentication. User
-un name to connect to the domain. You can set the user name with
the -un option or the environment variable
INFA_DEFAULT_DOMAIN_USER. If you set a user name with both
methods, the -un option takes precedence.
Optional if the domain uses Kerberos authentication. To run the
command with single sign-on, do not set the user name. If you set
the user name, the command runs without single sign-on.
-Password password Required if you specify the user name. Password for the user
-pd name. The password is case sensitive. You can set a password
with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password with
both methods, the password set with the -pd option takes
precedence.
-SecurityDomain security_domain Required if the domain uses LDAP authentication. Optional if the
-sdn domain uses native authentication or Kerberos authentication.
Name of the security domain to which the domain user belongs.
You can set a security domain with the -sdn option or the
environment variable INFA_DEFAULT_SECURITY_DOMAIN. If you
set a security domain name with both methods, the -sdn option
takes precedence. The security domain name is case sensitive.
If the domain uses native or LDAP authentication, the default is
Native. If the domain uses Kerberos authentication, the default is
the LDAP security domain created during installation. The name of
the security domain is the same as the user realm specified during
installation.
-OSProfileName OSProfile_name Required. Name of the operating system profile you want to
-on remove.
RemoveRole
Removes a custom role from the domain. When you remove a custom role, the custom role and all privileges
that it included are removed from any user or group assigned the role.
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-RoleName|-rn> role_name
RemoveRole 629
The following table describes infacmd isp RemoveRole options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set the domain
-dn name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with both
methods, the -dn option takes precedence.
-UserName user_name Required if the domain uses Native or LDAP authentication. User
-un name to connect to the domain. You can set the user name with
the -un option or the environment variable
INFA_DEFAULT_DOMAIN_USER. If you set a user name with both
methods, the -un option takes precedence.
Optional if the domain uses Kerberos authentication. To run the
command with single sign-on, do not set the user name. If you set
the user name, the command runs without single sign-on.
-Password password Required if you specify the user name. Password for the user
-pd name. The password is case sensitive. You can set a password
with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password with
both methods, the password set with the -pd option takes
precedence.
-SecurityDomain security_domain Required if the domain uses LDAP authentication. Optional if the
-sdn domain uses native authentication or Kerberos authentication.
Name of the security domain to which the domain user belongs.
You can set a security domain with the -sdn option or the
environment variable INFA_DEFAULT_SECURITY_DOMAIN. If you
set a security domain name with both methods, the -sdn option
takes precedence. The security domain name is case sensitive.
If the domain uses native or LDAP authentication, the default is
Native. If the domain uses Kerberos authentication, the default is
the LDAP security domain created during installation. The name of
the security domain is the same as the user realm specified during
installation.
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-RoleName|-rn> role_name
<-PrivilegePath|-pp> path_of_privilege
The following table describes infacmd isp RemoveRolePrivilege options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set the
-dn domain name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with both
methods, the -dn option takes precedence.
-Password password Required if you specify the user name. Password for the user
-pd name. The password is case sensitive. You can set a
password with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password
with both methods, the password set with the -pd option
takes precedence.
RemoveRolePrivilege 631
Option Argument Description
-RoleName role_name Required. Name of the role from which you are removing the
-rn privilege. To enter a name that contains a space or other non-
alphanumeric character, enclose the name in quotation
marks.
-ServiceType service_type Required. Domain or application service type from which you
-st want to remove the privilege for the role.
Service types include:
- AS. Analyst Service
- CMS. Content Management Service
- CS. Catalog Service
- MM. Metadata Manager Service
- MRS. Model Repository Service
- RS. PowerCenter Repository Service
- TDM. Test Data Manager Service
- TDW. Test Data Warehouse Service
- DOMAIN. Domain
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-ServiceName|-sn> service_name
The following table describes infacmd isp RemoveService options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set the
-dn domain name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with both
methods, the -dn option takes precedence.
-UserName user_name Required if the domain uses Native or LDAP authentication. User
-un name to connect to the domain. You can set the user name with
the -un option or the environment variable
INFA_DEFAULT_DOMAIN_USER. If you set a user name with both
methods, the -un option takes precedence.
Optional if the domain uses Kerberos authentication. To run the
command with single sign-on, do not set the user name. If you set
the user name, the command runs without single sign-on.
-Password password Required if you specify the user name. Password for the user
-pd name. The password is case sensitive. You can set a password
with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password with
both methods, the password set with the -pd option takes
precedence.
-SecurityDomain security_domain Required if the domain uses LDAP authentication. Optional if the
-sdn domain uses native authentication or Kerberos authentication.
Name of the security domain to which the domain user belongs.
You can set a security domain with the -sdn option or the
environment variable INFA_DEFAULT_SECURITY_DOMAIN. If you
set a security domain name with both methods, the -sdn option
takes precedence. The security domain name is case sensitive.
If the domain uses native or LDAP authentication, the default is
Native. If the domain uses Kerberos authentication, the default is
the LDAP security domain created during installation. The name of
the security domain is the same as the user realm specified during
installation.
RemoveService 633
Option Argument Description
-ServiceName service_name Required. Name of service you want to remove. To enter a name
-sn that contains a space or other non-alphanumeric character,
enclose the name in quotation marks.
RemoveServiceLevel
Removes a service level. When you remove a service level, the Workflow Manager does not update tasks that
use the service level. If a workflow service level does not exist in the domain, the Load Balancer dispatches
the tasks with the default service level.
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-ServiceLevelName|-ln> service_level_name
-DomainName domain_name Required. Name of the Informatica domain. You can set the
-dn domain name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with both
methods, the -dn option takes precedence.
-UserName user_name Required if the domain uses Native or LDAP authentication. User
-un name to connect to the domain. You can set the user name with
the -un option or the environment variable
INFA_DEFAULT_DOMAIN_USER. If you set a user name with both
methods, the -un option takes precedence.
Optional if the domain uses Kerberos authentication. To run the
command with single sign-on, do not set the user name. If you
set the user name, the command runs without single sign-on.
-Password password Required if you specify the user name. Password for the user
-pd name. The password is case sensitive. You can set a password
with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password with
both methods, the password set with the -pd option takes
precedence.
-SecurityDomain security_domain Required if the domain uses LDAP authentication. Optional if the
-sdn domain uses native authentication or Kerberos authentication.
Name of the security domain to which the domain user belongs.
You can set a security domain with the -sdn option or the
environment variable INFA_DEFAULT_SECURITY_DOMAIN. If you
set a security domain name with both methods, the -sdn option
takes precedence. The security domain name is case sensitive.
If the domain uses native or LDAP authentication, the default is
Native. If the domain uses Kerberos authentication, the default
is the LDAP security domain created during installation. The
name of the security domain is the same as the user realm
specified during installation.
-ServiceLevelName service_level_name Required. Name of the service level you want to remove.
-ln
RemoveServiceLevel 635
RemoveUser
Removes a user account from the native security domain. You cannot remove user accounts in the LDAP
security domains.
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-ExistingUserName|-eu> existing_user_name
The following table describes infacmd isp RemoveUser options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set the
-dn domain name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with both
methods, the -dn option takes precedence.
-UserName user_name Required if the domain uses Native or LDAP authentication. User
-un name to connect to the domain. You can set the user name with
the -un option or the environment variable
INFA_DEFAULT_DOMAIN_USER. If you set a user name with both
methods, the -un option takes precedence.
Optional if the domain uses Kerberos authentication. To run the
command with single sign-on, do not set the user name. If you set
the user name, the command runs without single sign-on.
-Password password Required if you specify the user name. Password for the user
-pd name. The password is case sensitive. You can set a password
with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password with
both methods, the password set with the -pd option takes
precedence.
-SecurityDomain security_domain Required if the domain uses LDAP authentication. Optional if the
-sdn domain uses native authentication or Kerberos authentication.
Name of the security domain to which the domain user belongs.
You can set a security domain with the -sdn option or the
environment variable INFA_DEFAULT_SECURITY_DOMAIN. If you
set a security domain name with both methods, the -sdn option
takes precedence. The security domain name is case sensitive.
If the domain uses native or LDAP authentication, the default is
Native. If the domain uses Kerberos authentication, the default is
the LDAP security domain created during installation. The name
of the security domain is the same as the user realm specified
during installation.
RemoveUserFromGroup
Removes a native or LDAP user from a native group in the domain.
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-ExistingUserName|-eu> existing_user_name
[<-ExistingUserSecurityDomain|-esd> existing_user_security_domain]
<-GroupName|-gn> group_name
RemoveUserFromGroup 637
The following table describes infacmd isp RemoveUserFromGroup options and arguments:
-Password password Required if you specify the user name. Password for
-pd the user name. The password is case sensitive. You
can set a password with the -pd option or the
environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a
password with both methods, the password set with
the -pd option takes precedence.
-GroupName group_name Required. Name of the group from which you want to
-gn remove the user.
RemoveUserPermission
Removes a user permission on an object.
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-ExistingUserName|-eu> existing_user_name
[<-ExistingUserSecurityDomain|-esd> existing_user_security_domain]
<-ObjectName|-on> object_name
<-ObjectType|-ot> object_type_SERVICE_LICENSE_NODE_GRID_FOLDER_OSPROFILE
RemoveUserPermission 639
The following table describes infacmd isp RemoveUserPermission options and arguments:
-Password password Required if you specify the user name. Password for
-pd the user name. The password is case sensitive. You
can set a password with the -pd option or the
environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a
password with both methods, the password set with
the -pd option takes precedence.
-ObjectName object_name Name of the object that you want to remove the user
-on access permission.
RemoveUserPrivilege
Removes a privilege from a user in the domain or from a user in an application service within the domain.
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-ExistingUserName|-eu> existing_user_Name
[<-ExistingUserSecurityDomain|-esd> existing_user_security
<-ServiceName|-sn> service_name
<-PrivilegePath|-pp> path_of_privilege
RemoveUserPrivilege 641
The following table describes infacmd isp RemoveUserPrivilege options and arguments:
-Password password Required if you specify the user name. Password for
-pd the user name. The password is case sensitive. You
can set a password with the -pd option or the
environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a
password with both methods, the password set with
the -pd option takes precedence.
ExistingUserName existing_user_name Required. User account from which you are removing
-eu the privilege. To enter a name that contains a space or
other non-alphanumeric character, enclose the name in
quotation marks.
RenameConnection
Renames a connection. When you rename a connection, the Developer tool and the Analyst tool update the
jobs that use the connection.
Note: Deployed applications and parameter files identify a connection by name, not by connection ID.
Therefore, when you rename a connection, you must redeploy all applications that use the connection. You
must also update all parameter files that use the connection parameter.
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-ConnectionName|-cn> connection_name
<-NewConnectionName|-ncn> new_connection_name
RenameConnection 643
The following table describes infacmd isp RenameConnection options and arguments:
ResetPassword
Resets the password for a user in the domain.
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-ResetUserName|-ru> reset_user_name
<-ResetUserPassword|-rp> reset_user_password
The following table describes infacmd isp ResetPassword options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set the
-dn domain name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with both
methods, the -dn option takes precedence.
-UserName user_name Required if the domain uses Native or LDAP authentication. User
-un name to connect to the domain. You can set the user name with
the -un option or the environment variable
INFA_DEFAULT_DOMAIN_USER. If you set a user name with both
methods, the -un option takes precedence.
Optional if the domain uses Kerberos authentication. To run the
command with single sign-on, do not set the user name. If you
set the user name, the command runs without single sign-on.
ResetPassword 645
Option Argument Description
-Password password Required if you specify the user name. Password for the user
-pd name. The password is case sensitive. You can set a password
with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password with
both methods, the password set with the -pd option takes
precedence.
-SecurityDomain security_domain Required if the domain uses LDAP authentication. Optional if the
-sdn domain uses native authentication or Kerberos authentication.
Name of the security domain to which the domain user belongs.
You can set a security domain with the -sdn option or the
environment variable INFA_DEFAULT_SECURITY_DOMAIN. If you
set a security domain name with both methods, the -sdn option
takes precedence. The security domain name is case sensitive.
If the domain uses native or LDAP authentication, the default is
Native. If the domain uses Kerberos authentication, the default
is the LDAP security domain created during installation. The
name of the security domain is the same as the user realm
specified during installation.
-ResetUserName reset_user_name Required. Name of the user whose password you want to reset.
-ru
-ResetUserPassword reset_user_password Required. New password for the user. You can set a password
-rp with the -rp option or the environment variable INFA_PASSWORD.
If you set a password with both methods, the password set with
the -rp option takes precedence.
For a native user account, if you enable password complexity,
use the following guidelines when you create or change a
password:
- The length of the password must be at least eight characters.
- It must be a combination of an alphabet character, a numeric
character and a non-alphanumeric character, such as:
! \ " # $ % & ' ( ) * + , - . / : ; < = > ? @
[ ] ^ _ ` { | } ~
When you use special characters in a password, the shell
sometimes interprets them differently. For example, $ is
interpreted as a variable. In this case, use an escape character
to escape the special character.
Note: This command takes approximately five minutes and uses 100% of one CPU on the machine.
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-NodeName|-nn> node_name
The following table describes infacmd isp RunCPUProfile options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set the
-dn domain name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with both
methods, the -dn option takes precedence.
-UserName user_name Required if the domain uses Native or LDAP authentication. User
-un name to connect to the domain. You can set the user name with
the -un option or the environment variable
INFA_DEFAULT_DOMAIN_USER. If you set a user name with both
methods, the -un option takes precedence.
Optional if the domain uses Kerberos authentication. To run the
command with single sign-on, do not set the user name. If you
set the user name, the command runs without single sign-on.
-Password password Required if you specify the user name. Password for the user
-pd name. The password is case sensitive. You can set a password
with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password with
both methods, the password set with the -pd option takes
precedence.
-SecurityDomain security_domain Required if the domain uses LDAP authentication. Optional if the
-sdn domain uses native authentication or Kerberos authentication.
Name of the security domain to which the domain user belongs.
You can set a security domain with the -sdn option or the
environment variable INFA_DEFAULT_SECURITY_DOMAIN. If you
set a security domain name with both methods, the -sdn option
takes precedence. The security domain name is case sensitive.
If the domain uses native or LDAP authentication, the default is
Native. If the domain uses Kerberos authentication, the default
is the LDAP security domain created during installation. The
name of the security domain is the same as the user realm
specified during installation.
RunCPUProfile 647
Option Argument Description
-NodeName node_name Required. Name of the node for which you want to calculate the
-nn CPU profile.
SetConnectionPermissions
Assigns permissions on connection to a user or a group after removing previous permissions.
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<<-RecipientUserName|-run> recipient_user_name|<RecipientGroupName|-rgn>
recipient_group_name>
<-RecipientSecurityDomain|-rsd> recipient_security_domain]
<-ConnectionName|-cn> connection_name
[<-Permission|-p> permission_READ|WRITE|EXECUTE|GRANT|ALL
SetConnectionPermissions 649
Option Argument Description
SetRepositoryLDAPConfiguration
Updates the LDAP server configuration options for a PowerCenter repository.
You may need to update the connection information between the repository and the LDAP external directory
service after you install Informatica.
Use infacmd isp ListRepositoryLDAPConfiguration to view the current values for LDAP server configuration
options.
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-LDAPAddress|-la> ldap_server_address
<-LDAPPrincipal|-lp> ldap_principal
<-LDAPCredential|-lc> ldap_credential
[<-UseSSL|-us> use_ssl]
-DomainName domain_name Required. Name of the Informatica domain. You can set the
-dn domain name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with both
methods, the -dn option takes precedence.
-Password password Required if you specify the user name. Password for the user
-pd name. The password is case sensitive. You can set a password
with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password
with both methods, the password set with the -pd option takes
precedence.
SetRepositoryLDAPConfiguration 651
Option Argument Description
-LDAPAddress ldap_server_address Required. Host name and port number for the machine hosting
-la the LDAP directory service. Typically, the LDAP server port
number is 389.
-SearchBase search base Required. Distinguished name (DN) of the entry that serves as
-sb the starting point to search for user names in the LDAP
directory tree. LDAP finds an object in the directory according
to the path in the distinguished name of the object. For
example, in Microsoft Active Directory, the distinguished name
of a user object might be
cn=UserName,ou=OrganizationalUnit,dc=DomainName, where
the series of relative distinguished names denoted by
dc=DomainName identifies the DNS domain of the object.
-SearchScope search scope Required. Scope of the user search. Choose one of the
-ss following options:
- Base. Search the entry identified by search base.
- One level. Search all entries one level beneath the search
base entry but not including the search base entry.
- Subtree. Search the entire subtree at all levels beneath the
search base entry.
-LDAPPrincipal ldap_principal Required. Distinguished name (DN) for the principal user. The
-lp user name often consists of a common name (CN), an
organization (O), and a country (C). The Principal User Name is
an administrative user with access to the directory and is not
the name to authenticate. Specify a user who has permission
to read other user entries in the LDAP server. Omit this option
to log in as an anonymous user. For more information, refer to
the LDAP Server documentation.
-LDAPCredential ldap_credential Required. Password for the principal user. You can set a
-lc password with the -lc option or the environment variable
INFA_PASSWORD. If you set a password with both methods,
the password set with the -lc option takes precedence.
Omit this option to log in as an anonymous user.
-LoginFilter login_filter Required. An LDAP query string to filter results for user search.
-lf The filter can specify attribute types, assertion values, and
matching criteria. For example: (objectclass=*) searches all
objects. (&(objectClass=user)(!(cn=susan))) searches all user
objects except “susan.” For more information about search
filters, see the LDAP server documentation.
-UseSSL use_ssl Do not use this option. Informatica does not support an LDAP
-us server that uses SSL for versions 8.1.1 .
-CertificateDatabase certificate_database_for_ Do not use this option. Informatica does not support an LDAP
-cd ssl server that uses SSL for versions 8.1.1 .
To run the infacmd isp ShowLicense command, you must have permission on the license.
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-LicenseName|-ln> license_name
The following table describes infacmd isp ShowLicense options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set the
-dn domain name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with both
methods, the -dn option takes precedence.
-UserName user_name Required if the domain uses Native or LDAP authentication. User
-un name to connect to the domain. You can set the user name with
the -un option or the environment variable
INFA_DEFAULT_DOMAIN_USER. If you set a user name with both
methods, the -un option takes precedence.
Optional if the domain uses Kerberos authentication. To run the
command with single sign-on, do not set the user name. If you set
the user name, the command runs without single sign-on.
-Password password Required if you specify the user name. Password for the user
-pd name. The password is case sensitive. You can set a password
with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password with
both methods, the password set with the -pd option takes
precedence.
-SecurityDomain security_domain Required if the domain uses LDAP authentication. Optional if the
-sdn domain uses native authentication or Kerberos authentication.
Name of the security domain to which the domain user belongs.
You can set a security domain with the -sdn option or the
environment variable INFA_DEFAULT_SECURITY_DOMAIN. If you
set a security domain name with both methods, the -sdn option
takes precedence. The security domain name is case sensitive.
If the domain uses native or LDAP authentication, the default is
Native. If the domain uses Kerberos authentication, the default is
the LDAP security domain created during installation. The name
of the security domain is the same as the user realm specified
during installation.
ShowLicense 653
Option Argument Description
ShutdownNode
Shuts down a node. After you shut down a node, you can restart the node by starting the Informatica service
on the machine. You cannot restart a node using infacmd.
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-NodeName|-nn> node_name
The following table describes infacmd isp ShutdownNode options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set the
-dn domain name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with both
methods, the -dn option takes precedence.
-UserName user_name Required if the domain uses Native or LDAP authentication. User
-un name to connect to the domain. You can set the user name with
the -un option or the environment variable
INFA_DEFAULT_DOMAIN_USER. If you set a user name with both
methods, the -un option takes precedence.
Optional if the domain uses Kerberos authentication. To run the
command with single sign-on, do not set the user name. If you set
the user name, the command runs without single sign-on.
-Password password Required if you specify the user name. Password for the user
-pd name. The password is case sensitive. You can set a password
with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password with
both methods, the password set with the -pd option takes
precedence.
-SecurityDomain security_domain Required if the domain uses LDAP authentication. Optional if the
-sdn domain uses native authentication or Kerberos authentication.
Name of the security domain to which the domain user belongs.
You can set a security domain with the -sdn option or the
environment variable INFA_DEFAULT_SECURITY_DOMAIN. If you
set a security domain name with both methods, the -sdn option
takes precedence. The security domain name is case sensitive.
If the domain uses native or LDAP authentication, the default is
Native. If the domain uses Kerberos authentication, the default is
the LDAP security domain created during installation. The name of
the security domain is the same as the user realm specified during
installation.
-NodeName node_name Required. Name of the node you want to shut down.
-nn
SwitchToGatewayNode
Converts an existing worker node to a gateway node. The worker node must have the service role enabled.
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-NodeName|-nn> node_name
SwitchToGatewayNode 655
[<-EnableSaml|-saml> true|false]
[<-AssertionSigningCertificateAlias|-asca> idp_assertion_signing_certificate_alias]
[<-SamlTrustStoreDir|-std> saml_truststore_directory]
[<-SamlTrustStorePassword|-stp> saml_truststore_password]
[<-AdminconsolePort|-ap> admin_tool_port]
[<-AdminconsoleShutdownPort|-asp> admin_tool_shutdown_port]
<-LogServiceDirectory|-ld> log_service_directory
[<-DatabaseTruststorePassword|-dbtp> database_truststore_password]
[<-DatabaseTruststoreLocation|-dbtl> database_truststore_location]
The following table describes infacmd isp SwitchToGatewayNode options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set the
-dn domain name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with both
methods, the -dn option takes precedence.
-UserName user_name Required if the domain uses Native or LDAP authentication. User
-un name to connect to the domain. You can set the user name with
the -un option or the environment variable
INFA_DEFAULT_DOMAIN_USER. If you set a user name with both
methods, the -un option takes precedence.
Optional if the domain uses Kerberos authentication. To run the
command with single sign-on, do not set the user name. If you
set the user name, the command runs without single sign-on.
-Password password Required if you specify the user name. Password for the user
-pd name. The password is case sensitive. You can set a password
with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password
with both methods, the password set with the -pd option takes
precedence.
-SecurityDomain security_domain Required if the domain uses LDAP authentication. Optional if the
-sdn domain uses native authentication or Kerberos authentication.
Name of the security domain to which the domain user belongs.
You can set a security domain with the -sdn option or the
environment variable INFA_DEFAULT_SECURITY_DOMAIN. If you
set a security domain name with both methods, the -sdn option
takes precedence. The security domain name is case sensitive.
If the domain uses native or LDAP authentication, the default is
Native. If the domain uses Kerberos authentication, the default
is the LDAP security domain created during installation. The
name of the security domain is the same as the user realm
specified during installation.
-NodeName node_name Required. Name of the node you want to make a gateway node.
-nn
-SamlTrustStoreDir saml_truststore_director Optional. The directory containing the custom truststore file
-std y 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.
-LogServiceDirectory log_service_directory Required. Shared directory path used by the Log Manager to
-ld store log event files. Ensure that the -ld value does not match or
contain the specified -sld value.
- database_truststore_pas Optional. Password for the database truststore file for the
DatabaseTruststorePa sword secure database. Required if you configure a secure domain
ssword repository database for the domain.
-dbtp
- database_truststore_loca Path and file name of the truststore file for the secure database.
DatabaseTruststoreLo tion Required if you configure a secure domain repository database
cation for the domain.
-dbtl
SwitchToGatewayNode 657
SwitchToWorkerNode
Converts a gateway node to a worker node. The command fails if the node you want to switch is the only
gateway node in the domain.
If the node serves as the master gateway node, you must shut down the node before you can convert it to a
worker node. Shut down the node and wait for the master gateway to fail over to another node. You can then
restart the node and run the infacmd isp SwitchToWorkerNode command.
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-NodeName|-nn> node_name
The following table describes infacmd isp SwitchToWorkerNode options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set the
-dn domain name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with both
methods, the -dn option takes precedence.
-UserName user_name Required if the domain uses Native or LDAP authentication. User
-un name to connect to the domain. You can set the user name with
the -un option or the environment variable
INFA_DEFAULT_DOMAIN_USER. If you set a user name with both
methods, the -un option takes precedence.
Optional if the domain uses Kerberos authentication. To run the
command with single sign-on, do not set the user name. If you
set the user name, the command runs without single sign-on.
-Password password Required if you specify the user name. Password for the user
-pd name. The password is case sensitive. You can set a password
with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password with
both methods, the password set with the -pd option takes
precedence.
-SecurityDomain security_domain Required if the domain uses LDAP authentication. Optional if the
-sdn domain uses native authentication or Kerberos authentication.
Name of the security domain to which the domain user belongs.
You can set a security domain with the -sdn option or the
environment variable INFA_DEFAULT_SECURITY_DOMAIN. If you
set a security domain name with both methods, the -sdn option
takes precedence. The security domain name is case sensitive.
If the domain uses native or LDAP authentication, the default is
Native. If the domain uses Kerberos authentication, the default
is the LDAP security domain created during installation. The
name of the security domain is the same as the user realm
specified during installation.
-NodeName node_name Required. Name of the node you want to make a worker node.
-nn
SyncSecurityDomains
Synchronizes users and groups in a security domain with the users and groups in the LDAP directory service.
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-SynchronizingNamespace|-sn> namespace_to_sync
SyncSecurityDomains 659
The following table describes infacmd isp SyncSecurityDomain options and arguments:
-Password password Required if you specify the user name. Password for
-pd the user name. The password is case sensitive. You
can set a password with the -pd option or the
environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a
password with both methods, the password set with
the -pd option takes precedence.
UnassignDefaultOSProfile
Removes the default operating system profile that is assigned to a user or group.
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-RecipientName|-nm> recipient_name
<-RecipientSecurityDomain|-ns> security_domain_of_recipient
<-RecipientType|-ty> recipient_type
UnassignDefaultOSProfile 661
The following table describes infacmd isp UnassignDefaultOSProfile options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set
-dn the domain name with the -dn option or the environment
variable INFA_DEFAULT_DOMAIN. If you set a domain
name with both methods, the -dn option takes
precedence.
-Password password Required if you specify the user name. Password for the
-pd user name. The password is case sensitive. You can set
a password with the -pd option or the environment
variable INFA_DEFAULT_DOMAIN_PASSWORD. If you set
a password with both methods, the password set with
the -pd option takes precedence.
-RecipientSecurityDomain security_domain_of_recipient Required if you use LDAP authentication and you are
-ns granting user permissions. Name of the security domain
that the user belongs to.
UnassignISMMService
Disassociates a PowerCenter Integration Service from a Metadata Manager Service. If you remove a
PowerCenter Integration Service, you must associate another PowerCenter Integration Service before you
load resources.
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> securitydomain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-ServiceName|-sn> service_name
<-IntegrationService|-is> integration_service_name
The following table describes infacmd isp UnassignISMMService options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set the
-dn domain name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with both
methods, the -dn option takes precedence.
-UserName user_name Required if the domain uses Native or LDAP authentication. User
-un name to connect to the domain. You can set the user name with
the -un option or the environment variable
INFA_DEFAULT_DOMAIN_USER. If you set a user name with both
methods, the -un option takes precedence.
Optional if the domain uses Kerberos authentication. To run the
command with single sign-on, do not set the user name. If you
set the user name, the command runs without single sign-on.
UnassignISMMService 663
Option Argument Description
-Password password Required if you specify the user name. Password for the user
-pd name. The password is case sensitive. You can set a password
with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password with
both methods, the password set with the -pd option takes
precedence.
-SecurityDomain security_domain Required if the domain uses LDAP authentication. Optional if the
-sdn domain uses native authentication or Kerberos authentication.
Name of the security domain to which the domain user belongs.
You can set a security domain with the -sdn option or the
environment variable INFA_DEFAULT_SECURITY_DOMAIN. If you
set a security domain name with both methods, the -sdn option
takes precedence. The security domain name is case sensitive.
If the domain uses native or LDAP authentication, the default is
Native. If the domain uses Kerberos authentication, the default is
the LDAP security domain created during installation. The name
of the security domain is the same as the user realm specified
during installation.
-ServiceName service_name Required. Name of the Metadata Manager Service for which you
-sn want to unassign the Integration Service.
UnassignLicense
Removes a license from an application service. The service must be stopped. After you remove the license
from the service, you must assign a valid license to re-enable the service.
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
<-LicenseName|-ln> license_name
-DomainName domain_name Required. Name of the Informatica domain. You can set the domain
-dn name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with both
methods, the -dn option takes precedence.
-UserName user_name Required if the domain uses Native or LDAP authentication. User
-un name to connect to the domain. You can set the user name with the
-un option or the environment variable
INFA_DEFAULT_DOMAIN_USER. If you set a user name with both
methods, the -un option takes precedence.
Optional if the domain uses Kerberos authentication. To run the
command with single sign-on, do not set the user name. If you set
the user name, the command runs without single sign-on.
-Password password Required if you specify the user name. Password for the user name.
-pd The password is case sensitive. You can set a password with the -
pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password with
both methods, the password set with the -pd option takes
precedence.
-SecurityDomain security_domain Required if the domain uses LDAP authentication. Optional if the
-sdn domain uses native authentication or Kerberos authentication.
Name of the security domain to which the domain user belongs.
You can set a security domain with the -sdn option or the
environment variable INFA_DEFAULT_SECURITY_DOMAIN. If you set
a security domain name with both methods, the -sdn option takes
precedence. The security domain name is case sensitive.
If the domain uses native or LDAP authentication, the default is
Native. If the domain uses Kerberos authentication, the default is
the LDAP security domain created during installation. The name of
the security domain is the same as the user realm specified during
installation.
UnassignLicense 665
Option Arguments Description
-ServiceNames service_name1 Required. Names of the services for which you want to remove the
-sn service_name2 ... license. To enter a name that contains a space or other non-
alphanumeric character, enclose the name in quotation marks.
UnassignRoleFromGroup
Removes a role from a group for a domain or an application service.
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-GroupName|-gn> group_name
[<-GroupSecurityDomain|-gsf> group_security_domain]
<-RoleName|-rn> role_name
<-ServiceName|-sn> service_name
The following table describes infacmd isp UnassignRoleFromGroup options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set the
-dn domain name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with both
methods, the -dn option takes precedence.
-Password password Required if you specify the user name. Password for the user
-pd name. The password is case sensitive. You can set a
password with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password
with both methods, the password set with the -pd option
takes precedence.
-GroupName group_name Required. Name of the group from which you want to remove
-gn a role. To enter a name that contains a space or other non-
alphanumeric character, enclose the name in quotation
marks.
-RoleName role_name Required. Name of the role you want to remove from the
-rn group.
-ServiceName service_name Required. Domain or application service name from which you
-sn want to remove the role. To enter a name that contains a
space or other non-alphanumeric character, enclose the name
in quotation marks.
UnassignRoleFromGroup 667
UnassignRoleFromUser
Removes a role from a user for a domain or an application service.
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-ExistingUserName|-eu> existing_user_Name
[<-ExistingUserSecurityDomain|-esd> existing_user_securit
<-RoleName|-rn> role_name
<-ServiceName|-sn> service_name
The following table describes infacmd isp UnassignRoleFromUser options and arguments:
-Password password Required if you specify the user name. Password for
-pd the user name. The password is case sensitive. You
can set a password with the -pd option or the
environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a
password with both methods, the password set with
the -pd option takes precedence.
-ExistingUserName existing_user_Name Required. User account from which you are removing
-eu the role. To enter a name that contains a space or
other non-alphanumeric character, enclose the name
in quotation marks.
-RoleName role_name Required. Name of the role you want to remove from
-rn the user.
UnassignRSWSHubService
Disassociates a PowerCenter repository from a Web Services Hub in the domain.
UnassignRSWSHubService 669
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-ServiceName|-sn> service_name
<-NodeName|-nn> node_name
<-RepositoryService|-rs> repository_service_name
The following table describes infacmd isp UnassignRSWSHubService options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set the
-dn domain name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with both
methods, the -dn option takes precedence.
-Password password Required if you specify the user name. Password for the user
-pd name. The password is case sensitive. You can set a
password with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password
with both methods, the password set with the -pd option
takes precedence.
-ServiceName service_name Required. Name of the Web Services Hub from which you
-sn want to disassociate a repository.
-NodeName node_name Required. Name of the node where the Web Services Hub
-nn process runs. If the Informatica environment is configured
for high availability, this option specifies the name of the
primary node.
-RepositoryService repository_service_name Required. Name of the Repository Service that the Web
-rs Services Hub depends on.
To enter a name that contains a space or other non-
alphanumeric character, enclose the name in quotation
marks.
UnassociateDomainNode
Disassociates a node in a domain from its address. The node name remains part of the domain, but it has no
physical address.
For example, in a domain, “Node1” is associated with machine “MyHost:9090.” When you run this command,
the connection between the name “Node1” and the host address “MyHost:9090” is removed. You can then
associate “Node1” with a new host. You must run the infasetup DefineGatewayNode or DefineWorkerNode
command on the new host to define “Node1” on that machine.
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-NodeName|-nn> node_name
UnassociateDomainNode 671
The following table describes infacmd isp UnassociateDomainNode options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set the
-dn domain name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with both
methods, the -dn option takes precedence.
-UserName user_name Required if the domain uses Native or LDAP authentication. User
-un name to connect to the domain. You can set the user name with
the -un option or the environment variable
INFA_DEFAULT_DOMAIN_USER. If you set a user name with both
methods, the -un option takes precedence.
Optional if the domain uses Kerberos authentication. To run the
command with single sign-on, do not set the user name. If you set
the user name, the command runs without single sign-on.
-Password password Required if you specify the user name. Password for the user
-pd name. The password is case sensitive. You can set a password
with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password with
both methods, the password set with the -pd option takes
precedence.
-SecurityDomain security_domain Required if the domain uses LDAP authentication. Optional if the
-sdn domain uses native authentication or Kerberos authentication.
Name of the security domain to which the domain user belongs.
You can set a security domain with the -sdn option or the
environment variable INFA_DEFAULT_SECURITY_DOMAIN. If you
set a security domain name with both methods, the -sdn option
takes precedence. The security domain name is case sensitive.
If the domain uses native or LDAP authentication, the default is
Native. If the domain uses Kerberos authentication, the default is
the LDAP security domain created during installation. The name
of the security domain is the same as the user realm specified
during installation.
-NodeName node_name Required. Name of the node you want to disassociate from the
-nn domain.
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-ConnectionName|-cn> connection_name
[<-ConnectionUserName|-cun> connection_user_name]
[<-ConnectionPassword|-cpd> connection_password]
UpdateConnection 673
Option Argument Description
UpdateConnection 675
Option Argument Description
updateCustomLDAPType
Updates a custom LDAP type that defines an LDAP directory service from which you import users into an
LDAP security domain.
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-CustomLDAPTypeName|-lt> custom_LDAP_type_name
[<-DisplayName|-dpn> display_name]
[<-Uid> uid]
[<-GroupMembershipAttr|-gm> group_membership_attr]
[<-GroupDescriptionAttr|-gd> group_description_attr]
[<-UserSurnameAttr|-usn> user_surname_attr]
[<-UserGivenNameAttr|-ugn> user_given_name_attr]
[<-UserEmailAttr|-ue> user_email_attr]
[<-UserEnableAttr|-uen> user_enable_attr]
[<-UserTelephoneAttr|-utn> user_telephone_attr]
[<-UserDescriptionAttr|-ud> user_description_attr]
[<-CN> cn]
[<-FetchRangedAttr|-fr> fetch_ranged_attr]
-DomainName domain_name Required. Name of the Informatica domain. You can set
-dn the domain name with the -dn option or the environment
variable INFA_DEFAULT_DOMAIN. If you set a domain
name with both methods, the -dn option takes
precedence.
-Password password Required if you specify the user name. Password for the
-pd user name. The password is case sensitive. You can set a
password with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a
password with both methods, the password set with the -
pd option takes precedence.
updateCustomLDAPType 677
Option Argument Description
- -DisplayName display_name Optional. Name of the custom LDAP type displayed in the
-dpn Administrator tool.
- User DescriptionAttrr user_description_attr Optional. Name of the attribute in the LDAP directory
-ud service that contains a description for a user.
- FetchRangedAttr fetch_ranged_attr Optional. Set to true to retrieve all of the values contained
-fr in multivalued attributes.
Use this option with Microsoft Active Directory only.
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
-DomainName domain_name Required. Name of the Informatica domain. You can set the
-dn domain name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with both
methods, the -dn option takes precedence.
-UserName user_name Required if the domain uses Native or LDAP authentication. User
-un name to connect to the domain. You can set the user name with
the -un option or the environment variable
INFA_DEFAULT_DOMAIN_USER. If you set a user name with both
methods, the -un option takes precedence.
Optional if the domain uses Kerberos authentication. To run the
command with single sign-on, do not set the user name. If you
set the user name, the command runs without single sign-on.
-Password password Required if you specify the user name. Password for the user
-pd name. The password is case sensitive. You can set a password
with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password with
both methods, the password set with the -pd option takes
precedence.
-SecurityDomain security_domain Required if the domain uses LDAP authentication. Optional if the
-sdn domain uses native authentication or Kerberos authentication.
Name of the security domain to which the domain user belongs.
You can set a security domain with the -sdn option or the
environment variable INFA_DEFAULT_SECURITY_DOMAIN. If you
set a security domain name with both methods, the -sdn option
takes precedence. The security domain name is case sensitive.
If the domain uses native or LDAP authentication, the default is
Native. If the domain uses Kerberos authentication, the default
is the LDAP security domain created during installation. The
name of the security domain is the same as the user realm
specified during installation.
UpdateDomainOptions 679
Option Argument Description
-DomainOptions option_name=value Required. Domain properties you want to update. You can update
-do the following properties:
- LicenseUsageDetailMinDays. Minimum number of days the
Log Manager keeps log events for license usage.
- LicenseUsageSummaryMinDays. Minimum number of days the
Log Manager keeps database records for license usage.
- ResilTimeout. Amount of time in seconds services attempt to
connect as clients to other services.
- RestartsMaxAttempts. Number of times within a specified
period that the domain attempts to restart an application
service process when it fails.
- RestartsWithinSeconds. Maximum period of time in seconds
that the domain spends attempting to restart an application
service process when it fails.
- ServiceResilTimeout. Maximum amount of time that the
service holds on to resources to accommodate resilience
timeouts.
- TaskDispatchMode. Load Balancer dispatch mode for tasks:
RoundRobin, MetricBased, or Adaptive. Restart the Integration
Service to apply changes.
- TLSMode. Configures secure communication between
services within the domain. To apply changes, restart the
domain. Valid values are true or false.
UpdateFolder
Updates the folder description.
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
<-FolderPath|-fp> full_folder_path
<-FolderDescription|-fd> description_of_folder
The following table describes infacmd isp UpdateFolder options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set the
-dn domain name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with both
methods, the -dn option takes precedence.
-UserName user_name Required if the domain uses Native or LDAP authentication. User
-un name to connect to the domain. You can set the user name with
the -un option or the environment variable
INFA_DEFAULT_DOMAIN_USER. If you set a user name with both
methods, the -un option takes precedence.
Optional if the domain uses Kerberos authentication. To run the
command with single sign-on, do not set the user name. If you
set the user name, the command runs without single sign-on.
-Password password Required if you specify the user name. Password for the user
-pd name. The password is case sensitive. You can set a password
with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password with
both methods, the password set with the -pd option takes
precedence.
-SecurityDomain security_domain Required if the domain uses LDAP authentication. Optional if the
-sdn domain uses native authentication or Kerberos authentication.
Name of the security domain to which the domain user belongs.
You can set a security domain with the -sdn option or the
environment variable INFA_DEFAULT_SECURITY_DOMAIN. If you
set a security domain name with both methods, the -sdn option
takes precedence. The security domain name is case sensitive.
If the domain uses native or LDAP authentication, the default is
Native. If the domain uses Kerberos authentication, the default
is the LDAP security domain created during installation. The
name of the security domain is the same as the user realm
specified during installation.
UpdateFolder 681
Option Argument Description
-FolderPath full_folder_path Required. Full path, excluding the domain name, to the folder you
-fp want to update. Must be in the following format:
/parent_folder/child_folder
UpdateGatewayInfo
Updates gateway node connectivity information in the domains.infa file.
Run infacmd isp UpdateGatewayInfo to create a domains.infa file or update a domains.infa file. The
domains.infa file contains the connectivity information for a gateway node in a domain along with the TLS
and Kerberos configuration of the domain. The connectivity information includes the domain name, domain
host name, and domain host HTTP port.
You might need to generate a domains.infa file to run infacmd oie commands on a client machine. To
generate the domains.infa file, run infacmd isp UpdateGatewayInfo. The updateGatewayInfo command
generates a domains.infa file in the DeveloperClient directory. Define the domain gateway host name and
port when you run the command.
<-DomainName|-dn> domain_name
<-GatewayAddress|-dg> domain_gateway_host:port
[<-Force|-f>]
The following table describes infacmd isp UpdateGatewayInfo options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set the
-dn domain name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with both
methods, the -dn option takes precedence.
-GatewayAddress domain_gateway_host:por Required. Gateway host machine name and port number. Enter
-dg t the gateway address in the following format:
domain_gateway_host:port
-Force - Optional. Updates or creates the domains.infa file even when the
-f connection to the domain fails. The ‑Force option sets the
Kerberos and TLS enabled options as false in the domains.infa
file if the connection to domain fails. If you do not specify the
‑Force option, the command does not update the domains.infa
file if the connection to the domain fails.
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-GridName|-gn> grid_name
[<-UpdateNodeList|-ul> true|false]
The following table describes infacmd isp UpdateGrid options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set the
-dn domain name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with both
methods, the -dn option takes precedence.
-UserName user_name Required if the domain uses Native or LDAP authentication. User
-un name to connect to the domain. You can set the user name with
the -un option or the environment variable
INFA_DEFAULT_DOMAIN_USER. If you set a user name with both
methods, the -un option takes precedence.
Optional if the domain uses Kerberos authentication. To run the
command with single sign-on, do not set the user name. If you
set the user name, the command runs without single sign-on.
-Password password Required if you specify the user name. Password for the user
-pd name. The password is case sensitive. You can set a password
with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password with
both methods, the password set with the -pd option takes
precedence.
UpdateGrid 683
Option Argument Description
-SecurityDomain security_domain Required if the domain uses LDAP authentication. Optional if the
-sdn domain uses native authentication or Kerberos authentication.
Name of the security domain to which the domain user belongs.
You can set a security domain with the -sdn option or the
environment variable INFA_DEFAULT_SECURITY_DOMAIN. If you
set a security domain name with both methods, the -sdn option
takes precedence. The security domain name is case sensitive.
If the domain uses native or LDAP authentication, the default is
Native. If the domain uses Kerberos authentication, the default
is the LDAP security domain created during installation. The
name of the security domain is the same as the user realm
specified during installation.
-NodeList node1 node2 ... Required. Names of the nodes that you want to assign to the
-nl grid. This list of nodes replaces or updates the list of nodes
previously assigned to the grid based on the -ul option defined.
If you specify the -ul option, the -nl option updates the list of
nodes previously assigned to the grid. If you do not specify the -
ul option, the -nl option replaces the list of nodes previously
assigned to the grid.
-UpdateNodeList true|false Optional. Updates the current node list with the values in the -nl
-ul option instead of replacing the list of nodes previously assigned
to the grid. If true, infacmd updates the node list with the list of
nodes specified using the -nl option along with the nodes
previously assigned to the grid. If false, infacmd replaces the
node list with the list of nodes specified using the -nl option.
Default is false.
UpdateIntegrationService
Updates the configuration properties for the PowerCenter Integration Service.
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-ServiceName|-sn> service_name
[<-RepositoryService|-rs> repository_service_name]
[<-RepositoryUser|-ru> repository_user]
[<-RepositoryPassword|-rp> repository_password]
[<-RepositoryUserSecurityDomain|-rsdn> repository_user_security_domain]
The following table describes infacmd isp UpdateIntegrationService options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set the
-dn domain name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with both
methods, the -dn option takes precedence.
-Password password Required if you specify the user name. Password for the user
-pd name. The password is case sensitive. You can set a password
with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password
with both methods, the password set with the -pd option takes
precedence.
UpdateIntegrationService 685
Option Argument Description
-NodeName node_name Optional. Name of the node where the Integration Service
-nn process runs. If the PowerCenter environment is configured for
high availability, this option specifies the name of the primary
node.
Do not enter a value for this option if you specify the grid
name.
-GridName grid_name Optional. Name of the grid where the Integration Service
-gn process runs.
Do not enter a value for this option if you specify the node
name.
-BackupNodes node1 node2 ... Optional. Nodes on which the service can run if the primary
-bn node is unavailable. You can configure backup nodes if you
have high availability.
-RepositoryService repository_service_nam Optional. Name of the Repository Service that the Integration
-rs e Service depends on.
To enter a name that contains a space or other non-
alphanumeric character, enclose the name in quotation marks.
-RepositoryUser user Required for native or LDAP authentication. User name used to
-ru connect to the repository.
To enter a name that contains a space or other non-
alphanumeric character, enclose the name in quotation marks.
-ServiceOptions option_name=value Optional. Service properties that define how the PowerCenter
-so Integration Service runs.
updateLDAPConnectivity
Updates the specified LDAP configuration.
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-LDAPAddress|-la> ldap_server_address
[<-LDAPPrincipal|-lp> ldap_principal]
[<-LDAPCredential|-lc> ldap_credential]
[<-UseSSL|-us> use_ssl]
[<-TrustLDAPCertificate|-tc> trust_ldap_certificate]
[<-MaxSecurityDomainSize|-ms> Max_Security_Domain_size]
[<-GroupMembershipAttr|-gm> LDAP_Group_Membership_Attribute]
[<-LDAPNotCaseSensitive|-lnc> ldap_not_case_sensitive]
<-LDAPHostConfigurationName|-lcn> LDAP_host_configuration_name
updateLDAPConnectivity 687
The following table describes infacmd isp updateLDAPConnectivity options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set
-dn the domain name with the -dn option or the environment
variable INFA_DEFAULT_DOMAIN. If you set a domain
name with both methods, the -dn option takes
precedence.
-Password password Required if you specify the user name. Password for the
-pd user name. The password is case sensitive. You can set a
password with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a
password with both methods, the password set with the -
pd option takes precedence.
-LDAPAddress ldap_server_address Required. Host name and port number for the machine
-la hosting the LDAP directory service. Typically, the LDAP
server port number is 389. If the LDAP server uses SSL,
the LDAP server port number is 636.
-LDAPPrincipal ldap_principal Optional. Distinguished name (DN) for the principal user.
-lp Omit this option to log in as an anonymous user.
For more information, refer to the documentation for the
LDAP directory service.
-LDAPCredential ldap_credential Optional. Password for the principal user. You can set a
-lc password with the -lc option or the environment variable
INFA_PASSWORD. If you set a password with both
methods, the password set with the -lc option takes
precedence.
Omit this option to log in as an anonymous user.
-UseSSL use_ssl Optional. If you include the option, the LDAP directory
-us service uses Secure Socket Layer (SSL) protocol.
-LDAPNotCaseSensitive LDAP_Not_Case_Sensitive Optional. Indicates that the user names from the LDAP
-lnc directory service are not case sensitive.
Default is false.
updateLDAPConnectivity 689
UpdateLicense
Updates license information for the domain. Run this command to upgrade your license using an incremental
license key. You use the key to add or remove licensed options.
When you add an incremental key to a license, the Service Manager updates the license expiration date if the
expiration date on the incremental key is later than the original key.
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-LicenseName|-ln> license_name
<-LicenseKeyFile|-lf> license_key_file
The following table describes infacmd isp UpdateLicense options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set the
-dn domain name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with both
methods, the -dn option takes precedence.
-UserName user_name Required if the domain uses Native or LDAP authentication. User
-un name to connect to the domain. You can set the user name with
the -un option or the environment variable
INFA_DEFAULT_DOMAIN_USER. If you set a user name with both
methods, the -un option takes precedence.
Optional if the domain uses Kerberos authentication. To run the
command with single sign-on, do not set the user name. If you set
the user name, the command runs without single sign-on.
-Password password Required if you specify the user name. Password for the user
-pd name. The password is case sensitive. You can set a password
with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password with
both methods, the password set with the -pd option takes
precedence.
-SecurityDomain security_domain Required if the domain uses LDAP authentication. Optional if the
-sdn domain uses native authentication or Kerberos authentication.
Name of the security domain to which the domain user belongs.
You can set a security domain with the -sdn option or the
environment variable INFA_DEFAULT_SECURITY_DOMAIN. If you
set a security domain name with both methods, the -sdn option
takes precedence. The security domain name is case sensitive.
If the domain uses native or LDAP authentication, the default is
Native. If the domain uses Kerberos authentication, the default is
the LDAP security domain created during installation. The name of
the security domain is the same as the user realm specified during
installation.
-LicenseName license_name Required. Name of the license object you want to update.
-ln
-LicenseKeyFile license_key_file Required. Name and path to the file that contains the incremental
-lf keys.
UpdateMMService
Updates or creates the service options for a Metadata Manager Service. To update or create the service
options, disable the Metadata Manager Service, update the options, and re-enable the service.
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-ServiceName|-sn> service_name
[<-LicenseName|-ln> license_name]
UpdateMMService 691
The following table describes infacmd isp UpdateMMService options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set the
-dn domain name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with both
methods, the -dn option takes precedence.
-UserName user_name Required if the domain uses Native or LDAP authentication. User
-un name to connect to the domain. You can set the user name with
the -un option or the environment variable
INFA_DEFAULT_DOMAIN_USER. If you set a user name with both
methods, the -un option takes precedence.
Optional if the domain uses Kerberos authentication. To run the
command with single sign-on, do not set the user name. If you
set the user name, the command runs without single sign-on.
-Password password Required if you specify the user name. Password for the user
-pd name. The password is case sensitive. You can set a password
with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password
with both methods, the password set with the -pd option takes
precedence.
-SecurityDomain security_domain Required if the domain uses LDAP authentication. Optional if the
-sdn domain uses native authentication or Kerberos authentication.
Name of the security domain to which the domain user belongs.
You can set a security domain with the -sdn option or the
environment variable INFA_DEFAULT_SECURITY_DOMAIN. If you
set a security domain name with both methods, the -sdn option
takes precedence. The security domain name is case sensitive.
If the domain uses native or LDAP authentication, the default is
Native. If the domain uses Kerberos authentication, the default
is the LDAP security domain created during installation. The
name of the security domain is the same as the user realm
specified during installation.
-ServiceName service_name Required. Name of the Metadata Manager Service you want to
-sn update.
-LicenseName license_name Required. Name of the license you want to assign to the
-ln Metadata Manager Service.
-ServiceOptions option_name=value Optional. Service properties that define how the Metadata
-so Manager Service runs.
When you specify a Model Repository Service with the -ModelRepositoryService option, you must also enter
values for the -RepositoryUserName and -RepositoryPassword options. You must include values for all three
options or for none of them.
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
[<-ModelRepositoryService|-rs> model_repository_service]
[<-RepositoryUserName|-rsun> model_repository_user_name]
[<-RepositoryPassword|-rspd> model_repository_password]
[<-RepositorySecurityDomain|-rsdn> model_repository_security_domain]
UpdateMonitoringOptions 693
Option Argument Description
UpdateNamespace
Updates an LDAP security domain with the filters provided for the user and group. Updates the LDAP security
domain if the Informatica domain uses LDAP or Kerberos authentication.
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
UpdateNamespace 695
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-NameSpace|-ns> namespace
[<-UserSearchBase|-usb> usersearchbase]
[<-UserFilter|-uf> userfilter]
[<-GroupSearchBase|-gsb> groupsearchbase]
[<-GroupFilter|-gf> groupfilter]
[<-LDAPHostConfigurationName|-lcn> LDAP_host_configuration_name]
The following table describes infacmd isp UpdateNamespace options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set the
-dn domain name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with both
methods, the -dn option takes precedence.
-Password password Required if you specify the user name. Password for the user
-pd name. The password is case sensitive. You can set a
password with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password
with both methods, the password set with the -pd option
takes precedence.
-SecurityDomain security_domain Name of the security domain to which the domain user
-sdn belongs. You can set a security domain with the -sdn option
or the environment variable
INFA_DEFAULT_SECURITY_DOMAIN. If you set a security
domain name with both methods, the -sdn option takes
precedence. The security domain name is case sensitive.
You can specify a value for ‑sdn or use the default based on
the authentication mode:
- Required if the domain uses LDAP authentication. Default
is Native. To work with LDAP authentication, you need to
specify the value for -sdn.
- Optional if the domain uses native authentication or
Kerberos authentication. Default is native for native
authentication. If the domain uses Kerberos authentication,
the default is the LDAP security domain created during
installation. The name of the security domain is the same
as the user realm specified during installation.
-UserSearchBase usersearchbasesu Distinguished name (DN) of the entry that serves as the
-usb starting point to search for user names in the LDAP directory
service. The LDAP directory service searches for an object in
the directory according to the path in the distinguished name
of the object.
For example, in Microsoft Active Directory, the distinguished
name of a user object might be
cn=UserName,ou=OrganizationalUnit,dc=DomainName. The
series of relative distinguished names denoted by
dc=DomainName identifies the DNS domain of the object.
-UserFilter userfilter An LDAP query string that specifies the search criteria to
-uf search for users in the directory service. The filter can
specify attribute types, assertion values, and matching
criteria.
For example: The filter(objectclass=*)searches all
objects. The filter(&(objectClass=user)(!
(cn=susan)))searches all user objects except “susan.” For
more information about search filters, see the documentation
for the LDAP directory service.
-GroupSearchBase groupsearchbase Distinguished name (DN) of the entry that serves as the
-gsb starting point to search for group names in the LDAP
directory service.
-GroupFilter groupfilter An LDAP query string that specifies the criteria for searching
-gf for groups in the directory service.
UpdateNamespace 697
UpdateNodeOptions
Updates node general properties such as backup directory, CPU profile, error severity level, service process
ports, and resource provision thresholds.
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-NodeName|-nn> node_name
-DomainName domain_name Required. Name of the Informatica domain. You can set the
-dn domain name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with both
methods, the -dn option takes precedence.
-UserName user_name Required if the domain uses Native or LDAP authentication. User
-un name to connect to the domain. You can set the user name with
the -un option or the environment variable
INFA_DEFAULT_DOMAIN_USER. If you set a user name with both
methods, the -un option takes precedence.
Optional if the domain uses Kerberos authentication. To run the
command with single sign-on, do not set the user name. If you set
the user name, the command runs without single sign-on.
-Password password Required if you specify the user name. Password for the user
-pd name. The password is case sensitive. You can set a password
with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password with
both methods, the password set with the -pd option takes
precedence.
-SecurityDomain security_domain Required if the domain uses LDAP authentication. Optional if the
-sdn domain uses native authentication or Kerberos authentication.
Name of the security domain to which the domain user belongs.
You can set a security domain with the -sdn option or the
environment variable INFA_DEFAULT_SECURITY_DOMAIN. If you
set a security domain name with both methods, the -sdn option
takes precedence. The security domain name is case sensitive.
If the domain uses native or LDAP authentication, the default is
Native. If the domain uses Kerberos authentication, the default is
the LDAP security domain created during installation. The name of
the security domain is the same as the user realm specified
during installation.
-NodeName node_name Optional. Name of the node whose resource provision thresholds
-nn you want to update.
-NodeOptions option_name=value Optional. The node options you want to update. You can update
-no the following options:
- BackupDir. Directory to store repository backup files.
- CPUProfile. Ranking of the CPU performance of the node
compared to a baseline system. ErrorSeverityLevel. Level of
error logging for the node: error, warning, info, trace, debug.
- MaxProcessPort. Maximum port number used by service
processes on the node.
- MinProcessPort. Minimum port number used by service
processes on the node.
The following example sets MaxProcessPort to 1515:
infacmd UpdateNodeOptions ... -no
MaxProcessPort=1515
-ResourceProvision option_name=value Optional. The resource provision thresholds you want to update.
-rp You can update the following thresholds:
- MaxCPURunQueueLength. The maximum number of runnable
threads waiting for CPU resources on the node.
- MaxMemoryPercent. The maximum percentage of virtual
memory allocated on the node relative to the total physical
memory size.
- MaxProcesses. The maximum number of Session and
Command tasks that can run on each Integration Service
running on the node.
The following example sets MaxProcesses to 15:
infacmd UpdateNodeOptions ... -rp MaxProcesses=15
UpdateNodeOptions 699
UpdateNodeRole
Updates the role on a node in the domain. You can enable or disable the service role or the compute role on a
node.
By default, each node has both the service and compute roles. If a node is assigned to a Data Integration
Service grid, you might want to update the node role. Enable only the service role to dedicate the node to
running the Data Integration Service process. Enable only the compute role to dedicate the node to running
Data Integration Service mappings.
If you update the role on a node assigned to a Data Integration Service or a Data Integration Service grid, you
must recycle the Data Integration Service for the changes to take effect.
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-NodeName|-nn> node_name
[<-EnableServiceRole|-esr> true|false]
[<-EnableComputeRole|-ecr> true|false]
[<-disableComputeRoleMode|-mo> disable_mode]
The following table describes infacmd isp UpdateNodeRole options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set the
-dn domain name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with both
methods, the -dn option takes precedence.
-Password password Required if you specify the user name. Password for the user
-pd name. The password is case sensitive. You can set a password
with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password
with both methods, the password set with the -pd option takes
precedence.
-NodeName node_name Required. Name of the node that you want to update.
-nn
-EnableServiceRole true | false Optional. Enables the service role on the node. If true,
-esr application services can run on the node. If false, application
services cannot run on the node. Set to false only if the node is
assigned to a Data Integration Service grid and you want to
dedicate the node to running mappings.
Default is true.
-EnableComputeRole true | false Optional. Enables the compute role on the node. If true, the
-esr node can perform computations requested by remote
application services. If false, the node cannot perform
computations requested by remote application services.
A node requires the compute role when the Data Integration
Service runs jobs on the node.
If the Data Integration Service does not run jobs on the node,
you can disable the compute role. However, enabling or
disabling the compute role does not have a performance
impact.
Default is true.
UpdateNodeRole 701
UpdateOSProfile
Updates properties for an operating system profile in the domain.
Note: To run workflows that use operating system profiles, you must have the operating system profiles
option.
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-OSProfileName|-on> OSProfile_name
[<-HadoopImpersonationProperties|-hipr> hadoop_impersonation_properties]
[<-HadoopImpersonationUser|-hu> hadoop_impersonation_user]
[<-UseLoggedInUserAsProxy|-ip> use_logged_in_user_as_proxy]
[<-ProductExtensionName|-pe> product_extension_name]
UpdateOSProfile 703
Option Argument Description
-ProductOptions optionGroupName.op Required. Name and value of each option that you
-o tionName=Value set. Use the option to create a flat file cache
directory that the operating system profile can use.
For example, the following command sets the
cache directory to $PMRootDir/OSPCache:
infacmd isp createOSProfile ... -o
'runTimeVariables.flatFileCacheDirecto
ry'="$PMRootDir/OSPCache"
UpdateRepositoryService
Updates or creates service options for the PowerCenter Repository Service.
For example, you can update the PowerCenter Repository Service operating mode, which you can set to
normal or exclusive. Normal mode allows multiple users to access the PowerCenter Repository Service and
update repository contents. Exclusive mode allows a single user to access the PowerCenter Repository
Service and update repository contents. Set the operating mode to exclusive when you perform
administrative tasks that require a single user to log in and update the configuration. To update the
PowerCenter Repository Service operating mode, disable the PowerCenter Repository Service, update the
operating mode, and then re-enable the PowerCenter Repository Service.
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-ServiceName|-sn> service_name
-DomainName domain_name Required. Name of the Informatica domain. You can set the
-dn domain name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with both
methods, the -dn option takes precedence.
-UserName user_name Required if the domain uses Native or LDAP authentication. User
-un name to connect to the domain. You can set the user name with
the -un option or the environment variable
INFA_DEFAULT_DOMAIN_USER. If you set a user name with both
methods, the -un option takes precedence.
Optional if the domain uses Kerberos authentication. To run the
command with single sign-on, do not set the user name. If you
set the user name, the command runs without single sign-on.
-Password password Required if you specify the user name. Password for the user
-pd name. The password is case sensitive. You can set a password
with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password with
both methods, the password set with the -pd option takes
precedence.
-SecurityDomain security_domain Required if the domain uses LDAP authentication. Optional if the
-sdn domain uses native authentication or Kerberos authentication.
Name of the security domain to which the domain user belongs.
You can set a security domain with the -sdn option or the
environment variable INFA_DEFAULT_SECURITY_DOMAIN. If you
set a security domain name with both methods, the -sdn option
takes precedence. The security domain name is case sensitive.
If the domain uses native or LDAP authentication, the default is
Native. If the domain uses Kerberos authentication, the default
is the LDAP security domain created during installation. The
name of the security domain is the same as the user realm
specified during installation.
-ServiceName service_name Required. Name of the PowerCenter Repository Service you want
-sn to update. To enter a name that contains a space or other non-
alphanumeric character, enclose the name in quotation marks.
UpdateRepositoryService 705
Option Argument Description
-NodeName node_name Optional. Name of the node where the PowerCenter Repository
-nn Service process runs. If the PowerCenter environment is
configured for high availability, this option specifies the name of
the primary node.
-BackupNodes node1 node2 ... Optional. Nodes on which the service can run if the primary node
-bn is unavailable. You can configure backup nodes if you have high
availability.
-ServiceOptions option_name=value Required. Service properties that define how the PowerCenter
-so Repository Service runs.
Option Description
AllowWritesWithRACaching Optional. Uses PowerCenter Client tools to modify metadata in the repository
when repagent caching is enabled. Default is Yes.
CheckinCommentsRequired Optional. Requires users to add comments when checking in repository objects.
Default is Yes. To apply changes, restart the PowerCenter Repository Service.
CodePage Required. Code page description for the database. To enter a code page
description that contains a space or other non-alphanumeric character, enclose
the name in quotation marks.
DBPassword Required. Repository database password corresponding to the database user. You
can set a password with the -so option or the environment variable
INFA_DEFAULT_DATABASE_PASSWORD. If you set a password with both methods,
the password set with the -so option takes precedence.
To apply changes, restart the PowerCenter Repository Service.
DBPoolExpiryThreshold Optional. The minimum number of idle database connections allowed by the
PowerCenter Repository Service. For example, if there are 20 idle connections, and
you set this threshold to 5, the PowerCenter Repository Service closes no more
than 15 connections. Minimum is 3. Default is 5.
DBPoolExpiryTimeout Optional. The interval, in seconds, at which the PowerCenter Repository Service
checks for idle database connections. If a connection is idle for a period of time
greater than this value, the PowerCenter Repository Service can close the
connection. Minimum is 300. Maximum is 2,592,000 (30 days). Default is 3,600 (1
hour).
DBUser Required. Account for the database containing the repository. To apply changes,
restart the PowerCenter Repository Service.
DatabaseArrayOperationSize Optional. Number of rows to fetch each time an array database operation is
issued, such as insert or fetch. Default is 100. To apply changes, restart the
PowerCenter Repository Service.
DatabaseConnectionTimeout Optional. Amount of time in seconds that the PowerCenter Repository Service
attempts to establish a connection to the database management system. Default
is 180.
DatabasePoolSize Optional. Maximum number of connections to the repository database that the
PowerCenter Repository Service can establish. Minimum is 20. Default is 500.
DatabaseType Required. Type of database that stores the repository metadata. To apply changes,
restart the PowerCenter Repository Service.
EnableRepAgentCaching Optional. Enables the repository agent caching feature. Default is Yes.
ErrorSeverityLevel Optional. Minimum level of error messages written to the PowerCenter Repository
Service log:
- Fatal
- Error
Warning
- Info
- Trace
- Debug
Default is Info.
HeartBeatInterval Optional. Interval at which the PowerCenter Repository Service verifies its
connections with clients of the service. Default is 60 seconds.
MaxResilienceTimeout Optional. Maximum amount of time in seconds that the service holds on to
resources for resilience purposes. Default is 180.
MaximumConnections Optional. Maximum number of connections the repository accepts from repository
clients. Default is 200.
MaximumLocks Optional. Maximum number of locks the repository places on metadata objects.
Default is 50,000.
UpdateRepositoryService 707
Option Description
OptimizeDatabaseSchema Optional. Optimizes the repository database schema when you create repository
contents or back up and restore an IBM DB2 or Microsoft SQL Server repository.
When enabled, the PowerCenter Repository Service tries to create repository
tables that contain Varchar columns with a precision of 2000 instead of CLOB
columns. Use Varchar columns to increase repository performance. When you use
Varchar columns, you reduce disk input and output, and the database can cache
the columns.
To use this option, verify the page size requirements for the following repository
databases:
- IBM DB2. Database page size 4 KB or greater. At least one temporary
tablespace with page size 16 KB or greater.
- Microsoft SQL Server. Database page size 8 KB or greater.
Default is disabled.
PreserveMXData Optional. Preserves MX data for prior versions of mappings. Default is disabled.
RACacheCapacity Optional. Number of objects that the cache can contain when repository agent
caching is enabled. Default is 10,000.
SecurityAuditTrail Optional. Tracks changes made to users, groups, privileges, and permissions.
Default is No.
ServiceResilienceTimeout Optional. Amount of time in seconds that the service tries to establish or
reestablish a connection to another service. Default is 180. To apply changes,
restart the PowerCenter Repository Service.
TableOwnerName Optional. Name of the owner of the repository tables for an IBM DB2 repository.
TablespaceName Optional. Tablespace name for IBM DB2 repositories. To apply changes, restart the
PowerCenter Repository Service.
TrustedConnection Optional. Uses Windows authentication to access the Microsoft SQL Server
database. Default is No. To apply changes, restart the PowerCenter Repository
Service.
UpdateSAPBWService
Updates the service and service process options for the SAP BW Service.
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
[<-NodeName|-nn> node_name]
-DomainName domain_name Required. Name of the Informatica domain. You can set the
-dn domain name with the -dn option or the environment
variable INFA_DEFAULT_DOMAIN. If you set a domain
name with both methods, the -dn option takes precedence.
-Password password Required if you specify the user name. Password for the
-pd user name. The password is case sensitive. You can set a
password with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a
password with both methods, the password set with the -pd
option takes precedence.
UpdateSAPBWService 709
Option Argument Description
-NodeName node_name Optional. Name of the node where the SAP BW Service
-nn process runs. If the PowerCenter environment is configured
for high availability, this option specifies the name of the
primary node.
-ServiceOptions option_name=value Optional. Service properties that define how the SAP BW
-so Service runs.
-ServiceProcessOptions option_name=value Optional. Service process properties that define how the
-po SAP BW Service process runs.
UpdateServiceLevel
Updates service level properties. You can update the dispatch priority and maximum dispatch wait time.
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-ServiceLevelName|-ln> service_level_name
-DomainName domain_name Required. Name of the Informatica domain. You can set the
-dn domain name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with both
methods, the -dn option takes precedence.
-UserName user_name Required if the domain uses Native or LDAP authentication. User
-un name to connect to the domain. You can set the user name with
the -un option or the environment variable
INFA_DEFAULT_DOMAIN_USER. If you set a user name with both
methods, the -un option takes precedence.
Optional if the domain uses Kerberos authentication. To run the
command with single sign-on, do not set the user name. If you
set the user name, the command runs without single sign-on.
-Password password Required if you specify the user name. Password for the user
-pd name. The password is case sensitive. You can set a password
with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password with
both methods, the password set with the -pd option takes
precedence.
-SecurityDomain security_domain Required if the domain uses LDAP authentication. Optional if the
-sdn domain uses native authentication or Kerberos authentication.
Name of the security domain to which the domain user belongs.
You can set a security domain with the -sdn option or the
environment variable INFA_DEFAULT_SECURITY_DOMAIN. If you
set a security domain name with both methods, the -sdn option
takes precedence. The security domain name is case sensitive.
If the domain uses native or LDAP authentication, the default is
Native. If the domain uses Kerberos authentication, the default
is the LDAP security domain created during installation. The
name of the security domain is the same as the user realm
specified during installation.
-ServiceLevelName service_level_name Required. Name of the service level you want to update.
-ln
-ServiceLevel option_name=value Required. The service level properties you want to update. You
-sl can update the following properties:
- DispatchPriority. The initial priority for dispatch. Smaller
numbers have higher priority. Priority 1 is the highest priority.
- MaxDispatchWaitTime. The amount of time in seconds that
can elapse before the Load Balancer escalates the dispatch
priority for a task to the highest priority.
UpdateServiceLevel 711
UpdateServiceProcess
Updates the values of the PowerCenter Integration Service process options.
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-ServiceName|-sn> service_name
<-NodeName|-nn> node_name
<-ServiceProcessOptions|-po> option_name=value
[<-ProcessEnvironmentVariables|-ev> option_name=value ...]
The following table describes infacmd isp UpdateServiceProcess options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set the
-dn domain name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with both
methods, the -dn option takes precedence.
-Password password Required if you specify the user name. Password for the user
-pd name. The password is case sensitive. You can set a password
with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password
with both methods, the password set with the -pd option takes
precedence.
-ServiceName service_name Required. Name of the service. To enter a name that contains a
-sn space or other non-alphanumeric character, enclose the name
in quotation marks.
-NodeName node_name Required. Name of the node where you want to update
-nn configuration information.
-ServiceProcessOptions option_name=value Name and new values of the options whose values you want to
-po update. You can specify multiple option_name=value pairs. You
can use a process variable in the value.
For example, the following command sets the cache directory
to “$PMRootDir/NewCache” and the reject file directory to
“$PMRootDir/NewBadFiles”:
infacmd UpdateServiceProcess ... -po
$PMCacheDir=$PMRootDir/NewCache $PMBadFileDir=
$PMRootDir/NewBadFiles
Required if you do not specify ProcessEnvironmentVariables.
- option_name=value Environment variables for the service process. You can specify
ProcessEnvironmentVariable multiple environment variables.
s For example, the following command adds or updates the
-ev JAVA_HOME directory to "$HOME/java" and the INFA_HOME
directory to “$HOME/Informatica/9.0.1/install” for the
specified service process:
infacmd ProcessEnvironmentVariables ... -ev
JAVA_HOME=$HOME/java INFA_HOME=$HOME/
Informatica/9.0.1/install
Required if you do not specify ServiceProcessOptions.
UpdateServiceProcess 713
UpdateSMTPOptions
Updates the domain SMTP configuration. The SMTP configuration is used to send domain alerts and
scorecard notifications.
After you configure the SMTP settings, you must subscribe the user to alerts using the AddAlertUser
command.
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-SMTPAddress|-sa> smtp_server_address
[<-SMTPUsername|-su> user_name]
[<-SMTPPassword|-sp> password]
[<-SMTPSenderAddress|-ss> sender_email_address]
The following table describes infacmd isp UpdateSMTPOptions options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set the
-dn domain name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with both
methods, the -dn option takes precedence.
-UserName user_name Required. User name to connect to the domain. You can set
-un the user name with the -un option or the environment variable
INFA_DEFAULT_DOMAIN_USER. If you set a user name with
both methods, the -un option takes precedence.
-Password password Required. Password for the user name. The password is case
-pd sensitive. You can set a password with the -pd option or the
environment variable INFA_DEFAULT_DOMAIN_PASSWORD. If
you set a password with both methods, the password set with
the -pd option takes precedence.
-SecurityDomain security_domain Required if you use LDAP authentication. Name of the security
-sdn domain that the user belongs to. You can set a security
domain with the -sdn option or the environment variable
INFA_DEFAULT_SECURITY_DOMAIN. If you set a security
domain name with both methods, the -sdn option takes
precedence. Security domain is case sensitive. Default is
Native.
-SMTPAddress SMTP_server_address Required. The host name and port number for the SMTP
-sa outbound mail server. Enter this information in the following
format:
host_name:port_number
-SMTPUserName user_name Optional. The user name for authentication upon sending if
-su required by the outbound mail server.
-SMTPSenderAddress sender_email_address Optional. Email address the Service Manager uses to send
-ss notification emails. If you leave this field blank, the Service
Manager uses the default “Administrator@<host>” as the
sender.
Related Topics:
• “AddAlertUser” on page 325
UpdateWSHubService
Updates a Web Services Hub in the domain.
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-ServiceName|-sn> service_name
UpdateWSHubService 715
[<-NodeName|-nn> node_name]
-DomainName domain_name Required. Name of the Informatica domain. You can set the
-dn domain name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with both
methods, the -dn option takes precedence.
-UserName user_name Required if the domain uses Native or LDAP authentication. User
-un name to connect to the domain. You can set the user name with
the -un option or the environment variable
INFA_DEFAULT_DOMAIN_USER. If you set a user name with both
methods, the -un option takes precedence.
Optional if the domain uses Kerberos authentication. To run the
command with single sign-on, do not set the user name. If you
set the user name, the command runs without single sign-on.
-Password password Required if you specify the user name. Password for the user
-pd name. The password is case sensitive. You can set a password
with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password with
both methods, the password set with the -pd option takes
precedence.
-SecurityDomain security_domain Required if the domain uses LDAP authentication. Optional if the
-sdn domain uses native authentication or Kerberos authentication.
Name of the security domain to which the domain user belongs.
You can set a security domain with the -sdn option or the
environment variable INFA_DEFAULT_SECURITY_DOMAIN. If you
set a security domain name with both methods, the -sdn option
takes precedence. The security domain name is case sensitive.
If the domain uses native or LDAP authentication, the default is
Native. If the domain uses Kerberos authentication, the default
is the LDAP security domain created during installation. The
name of the security domain is the same as the user realm
specified during installation.
-ServiceName service_name Required. Name of the Web Services Hub you want to update.
-sn
-NodeName node_name Optional. Name of the node where the Web Services Hub process
-nn runs.
-ServiceOptions option_name=value ... Optional. Service properties that define how the Web Services
-so Hub runs.
validateFeature
Validates that the feature in the specified plug-in file is registered in the domain.
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-FeatureFilename|-ff> feature_filename
The following table describes infacmd isp validateFeature options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set
-dn the domain name with the -dn option or the environment
variable INFA_DEFAULT_DOMAIN. If you set a domain
name with both methods, the -dn option takes
precedence.
validateFeature 717
Option Argument Description
-Password password Required if you specify the user name. Password for the
-pd user name. The password is case sensitive. You can set
a password with the -pd option or the environment
variable INFA_DEFAULT_DOMAIN_PASSWORD. If you set
a password with both methods, the password set with
the -pd option takes precedence.
-FeatureFilename feature_filename Required. Path and file name of the plug-in xml file of the
-ff registered feature that you want to validate.
Version
Displays the PowerCenter version and Informatica trademark and copyright information.
• BackupContents, 719
• CreateService, 721
• collectAppLogs, 728
• ListServiceOptions, 730
• ListServiceProcessOptions, 731
• publishArchive, 733
• restoreContents, 735
• removesnapshot, 737
• UpdateServiceOptions, 739
• UpdateServiceProcessOptions, 741
• upgrade, 742
BackupContents
You can run this command in HDFS and offline mode. The offline mode is set as default. In HDFS mode,
takes a backup of HDFS and Zookeeper directory and creates a .zip file of the backup in the Catalog Service
host machine. In the offline mode, takes backup of the Hbase, Solr, and scanner staging data.
Note: If you run the command in the offline mode, you must set the Yarn property as
[yarn.nodemanager.aux-services] and the property value must contain [mapreduce_shuffle] in the
external cluster.
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
<-ServiceName|-sn> service_name
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
719
[<-HDFSSourceDirectory|-hsd> HDFS_source_directory
<-OutputFilename|-of> output_file_name
[<-CustomKeytabFile|-ckf> custom_keytab_file_location
[<-CustomClientUserPrincipal|-ccup> custom_client_user_principal
[<-ExtraJarsPath|-ejp> extra_jars_path
[<-Force|-fr> force
The following table describes infacmd ldm BackupContents options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set
-dn the domain name with the -dn option or the
environment variable INFA_DEFAULT_DOMAIN. If you
set a domain name with both methods, the -dn option
takes precedence.
-Password password Required if you specify the user name. Password for
-pd the user name. The password is case sensitive. You
can set a password with the -pd option or the
environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a
password with both methods, the password set with
the -pd option takes precedence.
-Force force Optional. If you want to force backup when the backup
-fr mode is offline. Forcefully takes backup and overwrites
the existing backup.
CreateService
Creates a Catalog Service. Before you create a Catalog Service, you need to ensure that you import the
Hadoop cluster certificates to the domain trust store for a Hadoop cluster that uses SSL protocol.
<-DomainName|-dn> domain_name
<-NodeName|-nn> node_name
[<-SecurityDomain|-sdn> security_domain]
<-UserName|-un> user_name
CreateService 721
<-Password|-pd> password
<-ServiceName|-sn> service_name
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-ModelRepositoryService|-mrs> model_repository_service_name
<-MRSUserName|-mrsun> model_repository_service_user_name
<-MRSPassword|-mrspd> model_repository_service_user_password
[<-MRSSecurityDomain|-mrssdn> model_repository_service_user_security_domain]
[<-HttpPort|-p> port_name]
[<-HttpsPort|-sp> https_port_name]
[<-KeystoreFile|-kf> keystore_file_location]
[<-KeystorePassword|-kp> keystore_password]
[<-SSLProtocol|-sslp> ssl_protocol]
[<-ClusterHadoopDistributionURL|-chdu> Cluster_Hadoop_Distribution_URL]
[<-ClusterHadoopDistributionURLUser|-chduu> Cluster_Hadoop_Distribution_URL_User]
[<-ClusterHadoopDistributionURLPwd|-chdup> Cluster_Hadoop_Distribution_URL_Pwd]
[<-ClusterNameHadoopDistribution|-cnhd> Cluster_Name_Hadoop_Distribution]
[<-InfaHadoopServiceName|-ihsn> infa_hadoop_service_name]
[<-ZookeeperURI(s)|-zk> zk_uris]
[<-HDFSNameNodeURI(s)|-hnnu> hdfs_namenode_uri]
[<-YarnRMUri(s)|-yrmu> yarn_resource_manager_uri]
[<-YarnRMHttpUri(s)|-yrmhu> yarn_resource_manager_http_uri]
[<-HistoryServerHttpUri|-hshu> history_server_http_uri]
[<-YarnRMSchedulerUri(s)|-yrmsu> yarn_resource_manager_scheduler_uri]
[<-ServiceClusterName|-scn> service_cluster_name]
[<-HdfsServiceNameHA|-hsn> hdfs_service_name]
[<-HdfsServicePrincipal|-hspn> hdfs_service_principal]
[<-YarnServicePrincipal|-yspn> yarn_service_principal]
[<-KdcDomain|-kdn> kdc_domain_name]
[<-KeytabLocation|-kl> keytab_location]
[<-BackupNodes|-bn> node_name1,node_name2,...]
CreateService 723
Option Argument Description
CreateService 725
Option Argument Description
CreateService 727
Option Argument Description
collectAppLogs
Collects log files for YARN applications that run to enable the Catalog Service.
Note: The collectAppLogs command is not supported if you have deployed Enterprise Data Catalog on a
Cloudera cluster. This command works only for the Hortonworks Data Platform (HDP) clusters and Enterprise
Data Catalog deployed on HDP embedded clusters.
collectAppLogs
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-ApplicationStartDate|-ad>
[<-LdmApplicationTypes|-at>
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
[<-CustomClientUserPrincipal|-ccup> custom_client_user_principal
[<-CustomKeytabFile|-ckf> custom_keytab_file_location
The following table describes infacmd ldm collectAppLogs options and arguments:
-Password password Required if you specify the user name. Password for
-pd the user name. The password is case sensitive. You
can set a password with the -pd option or the
environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a
password with both methods, the password set with
the -pd option takes precedence.
-OutputZipFileName output zip file name Required. Absolute path of the ZIP file on local
-of machine to which the logs will be collected. The zip file
will be created if it doesn't already exist, overwritten
otherwise.
-ApplicationStartDate Application Start Date Optional. The start date of applications to be fetched
-ad in the format MM/dd/yyyy. Logs for all applications
with start date after this will be fetched. If you do not
provide the date, the latest YARN log file is fetched.
collectAppLogs 729
Option Argument Description
ListServiceOptions
Lists service options for the Catalog Service.
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
<-ServiceName|-sn> service_name
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
-DomainName domain_name Required. Name of the Informatica domain. You can set the
-dn domain name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with both
methods, the -dn option takes precedence.
-UserName user_name Required if the domain uses Native or LDAP authentication. User
-un name to connect to the domain. You can set the user name with
the -un option or the environment variable
INFA_DEFAULT_DOMAIN_USER. If you set a user name with both
methods, the -un option takes precedence.
Optional if the domain uses Kerberos authentication. To run the
command with single sign-on, do not set the user name. If you set
the user name, the command runs without single sign-on.
-Password password Required if you specify the user name. Password for the user
-pd name. The password is case sensitive. You can set a password
with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password with
both methods, the password set with the -pd option takes
precedence.
-SecurityDomain security_domain Required if the domain uses LDAP authentication. Optional if the
-sdn domain uses native authentication or Kerberos authentication.
Name of the security domain to which the domain user belongs.
You can set a security domain with the -sdn option or the
environment variable INFA_DEFAULT_SECURITY_DOMAIN. If you
set a security domain name with both methods, the -sdn option
takes precedence. The security domain name is case sensitive.
If the domain uses native or LDAP authentication, the default is
Native. If the domain uses Kerberos authentication, the default is
the LDAP security domain created during installation. The name
of the security domain is the same as the user realm specified
during installation.
ListServiceProcessOptions
Lists service process options for the Catalog Administrator process.
ListServiceProcessOptions 731
<-DomainName|-dn> domain_name
<-ServiceName|-sn> service_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-NodeName|-nn> node_name
The following table describes infacmd ldm ListServiceProcessOptions options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set the
-dn domain name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with both
methods, the -dn option takes precedence.
-UserName user_name Required if the domain uses Native or LDAP authentication. User
-un name to connect to the domain. You can set the user name with
the -un option or the environment variable
INFA_DEFAULT_DOMAIN_USER. If you set a user name with both
methods, the -un option takes precedence.
Optional if the domain uses Kerberos authentication. To run the
command with single sign-on, do not set the user name. If you set
the user name, the command runs without single sign-on.
-Password password Required if you specify the user name. Password for the user
-pd name. The password is case sensitive. You can set a password
with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password with
both methods, the password set with the -pd option takes
precedence.
-SecurityDomain security_domain Required if the domain uses LDAP authentication. Optional if the
-sdn domain uses native authentication or Kerberos authentication.
Name of the security domain to which the domain user belongs.
You can set a security domain with the -sdn option or the
environment variable INFA_DEFAULT_SECURITY_DOMAIN. If you
set a security domain name with both methods, the -sdn option
takes precedence. The security domain name is case sensitive.
If the domain uses native or LDAP authentication, the default is
Native. If the domain uses Kerberos authentication, the default is
the LDAP security domain created during installation. The name
of the security domain is the same as the user realm specified
during installation.
-NodeName node_name Required. Required. Name of the node where the service process
-nn runs.
publishArchive
Creates a resource in offline mode and runs the scan.
<-UserName|-un> user_name
[<-Verbose|-v> Verbose]
publishArchive 733
The following table describes infacmd ldm CreateService options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set the domain
-dn name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with both
methods, the -dn option takes precedence.
-UserName user_name Required if the domain uses Native or LDAP authentication. User
-un name to connect to the domain. You can set the user name with the -
un option or the environment variable
INFA_DEFAULT_DOMAIN_USER. If you set a user name with both
methods, the -un option takes precedence.
Optional if the domain uses Kerberos authentication. To run the
command with single sign-on, do not set the user name. If you set
the user name, the command runs without single sign-on.
-Password password Required if you specify the user name. Password for the user name.
-pd The password is case sensitive. You can set a password with the -pd
option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password with
both methods, the password set with the -pd option takes
precedence.
-ResourceName Name of the resource Required. Name of the resource. The name cannot exceed 79
-rn characters, have leading or trailing spaces, or contains carriage
returns, tabs, or the following characters:
\ / * ? < > " | $
-SecurityDomain security_domain Required if the domain uses LDAP authentication. Optional if the
-sdn domain uses native authentication or Kerberos authentication. Name
of the security domain to which the domain user belongs. You can
set a security domain with the -sdn option or the environment
variable INFA_DEFAULT_SECURITY_DOMAIN. If you set a security
domain name with both methods, the -sdn option takes precedence.
The security domain name is case sensitive.
If the domain uses native or LDAP authentication, the default is
Native. If the domain uses Kerberos authentication, the default is
the LDAP security domain created during installation. The name of
the security domain is the same as the user realm specified during
installation.
-DomainHost Domain host name Required. Name of the host machine where the domain runs.
-dh
-DomainPort Domain port number Required. The port number of the domain.
-dp
-DomainSslEnabled is_Domain_SSL_Enabled Optional. Specify true to enable SSL domain. Default is False.
-dse
-WaitToCatalog - Optional. Waits for the metadata ingestion to complete into the
-w catalog.
restoreContents
You can run this command in HDFS and offline mode. Restores backup in the mode that you select for the
BackupContents command. For example, if you run the BackupContents command in offline mode, then the
restoreContents command runs in the same mode. In HDFS mode, retrieves the HDFS data backup .zip file
from the Catalog Service host and restores the data in the HDFS and Zookeeper directory. In the offline
mode, launches Hbase, Solr and restores the Hbase, Solr and scanner staging data.
Note: If you run the command in the offline mode, you must set the Yarn property as
[yarn.nodemanager.aux-services] and the property value must contain [mapreduce_shuffle] in the
external cluster.
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
<-ServiceName|-sn> service_name
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
[<-HDFSDestinationDir|-hdd> HDFS_destination_dir
<-InputFileName|-if> input_file_name
[<-CustomKeytabFile|-ckf> custom_keytab_file_location
[<-CustomClientUserPrincipal|-ccup> custom_client_user_principal
[<-ExtraJarsPath|-ejp> extra_jars_path
restoreContents 735
[<-Force|-fr> force
The following table describes infacmd ldm restoreContents options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set
-dn the domain name with the -dn option or the
environment variable INFA_DEFAULT_DOMAIN. If you
set a domain name with both methods, the -dn option
takes precedence.
-Password password Required if you specify the user name. Password for
-pd the user name. The password is case sensitive. You
can set a password with the -pd option or the
environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a
password with both methods, the password set with
the -pd option takes precedence.
-Force force Optional. If you want to clean the existing content from
-fr HDFS and Apache Zookeeper. Forcefully restores the
backup data.
removesnapshot
Removes snapshot from the HDFS directory.
Note: Use the infacmd ldm removesnapshot command if you have deployed Enterprise Data Catalog on an
internal cluster.
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
<-ServiceName|-sn> service_name
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
[<-HDFSSnapshotDir|-hssd> HDFS_snapshot_dir]
[<-CustomKeytabFile|-ckf> custom_keytab_file_location]
[<-CustomClientUserPrincipal|-ccup> custom_client_user_principal]
removesnapshot 737
The following table describes infacmd ldm removesnapshot options and arguments:
UpdateServiceOptions
Updates options for the Catalog Service. Separate multiple options with a space. To enter a value that
contains a space or other non-alphanumeric character, enclose the value in quotation marks.
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
<-ServiceName|-sn> service_name
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
[<-Options|-o> options
[<-PrimaryNode|-nn> node_name]
[<-BackupNodes|-bn> node_name1,node_name2,...]
UpdateServiceOptions 739
The following table describes infacmd ldm UpdateServiceOptions options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set the
-dn domain name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with both
methods, the -dn option takes precedence.
-UserName user_name Required if the domain uses Native or LDAP authentication. User
-un name to connect to the domain. You can set the user name with
the -un option or the environment variable
INFA_DEFAULT_DOMAIN_USER. If you set a user name with both
methods, the -un option takes precedence.
Optional if the domain uses Kerberos authentication. To run the
command with single sign-on, do not set the user name. If you set
the user name, the command runs without single sign-on.
-Password password Required if you specify the user name. Password for the user
-pd name. The password is case sensitive. You can set a password
with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password with
both methods, the password set with the -pd option takes
precedence.
-SecurityDomain security_domain Required if the domain uses LDAP authentication. Optional if the
-sdn domain uses native authentication or Kerberos authentication.
Name of the security domain to which the domain user belongs.
You can set a security domain with the -sdn option or the
environment variable INFA_DEFAULT_SECURITY_DOMAIN. If you
set a security domain name with both methods, the -sdn option
takes precedence. The security domain name is case sensitive.
If the domain uses native or LDAP authentication, the default is
Native. If the domain uses Kerberos authentication, the default is
the LDAP security domain created during installation. The name
of the security domain is the same as the user realm specified
during installation.
-PrimaryNode node_name Optional. If you want to configure high availability for Enterprise
-nn Data Catalog, specify the primary node name.
-BackupNodes node_names Optional, If you want to configure high availability for Enterprise
-bn Data Catalog, specify a list of comma-separated backup node
names.
<-DomainName|-dn> domain_name
<-NodeName|-nn> node_name
<-UserName|-un> user_name
<-Password|-pd> password
<-ServiceName|-sn> service_name
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-Options|-o> options
The following table describes infacmd ldm UpdateServiceProcessOptions options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set the
-dn domain name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with both
methods, the -dn option takes precedence.
-NodeName node_name Required. Name of the node where the service process runs.
-nn
-UserName user_name Required if the domain uses Native or LDAP authentication. User
-un name to connect to the domain. You can set the user name with
the -un option or the environment variable
INFA_DEFAULT_DOMAIN_USER. If you set a user name with both
methods, the -un option takes precedence.
Optional if the domain uses Kerberos authentication. To run the
command with single sign-on, do not set the user name. If you set
the user name, the command runs without single sign-on.
-Password password Required if you specify the user name. Password for the user
-pd name. The password is case sensitive. You can set a password
with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password with
both methods, the password set with the -pd option takes
precedence.
UpdateServiceProcessOptions 741
Option Argument Description
-SecurityDomain security_domain Required if the domain uses LDAP authentication. Optional if the
-sdn domain uses native authentication or Kerberos authentication.
Name of the security domain to which the domain user belongs.
You can set a security domain with the -sdn option or the
environment variable INFA_DEFAULT_SECURITY_DOMAIN. If you
set a security domain name with both methods, the -sdn option
takes precedence. The security domain name is case sensitive.
If the domain uses native or LDAP authentication, the default is
Native. If the domain uses Kerberos authentication, the default is
the LDAP security domain created during installation. The name
of the security domain is the same as the user realm specified
during installation.
upgrade
Upgrades the Catalog Service.
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
<-ServiceName|-sn> service_name
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
-DomainName domain_name Required. Name of the Informatica domain. You can set the
-dn domain name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with both
methods, the -dn option takes precedence.
-UserName user_name Required if the domain uses Native or LDAP authentication. User
-un name to connect to the domain. You can set the user name with
the -un option or the environment variable
INFA_DEFAULT_DOMAIN_USER. If you set a user name with both
methods, the -un option takes precedence.
Optional if the domain uses Kerberos authentication. To run the
command with single sign-on, do not set the user name. If you set
the user name, the command runs without single sign-on.
-Password password Required if you specify the user name. Password for the user
-pd name. The password is case sensitive. You can set a password
with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password with
both methods, the password set with the -pd option takes
precedence.
-SecurityDomain security_domain Required if the domain uses LDAP authentication. Optional if the
-sdn domain uses native authentication or Kerberos authentication.
Name of the security domain to which the domain user belongs.
You can set a security domain with the -sdn option or the
environment variable INFA_DEFAULT_SECURITY_DOMAIN. If you
set a security domain name with both methods, the -sdn option
takes precedence. The security domain name is case sensitive.
If the domain uses native or LDAP authentication, the default is
Native. If the domain uses Kerberos authentication, the default is
the LDAP security domain created during installation. The name
of the security domain is the same as the user realm specified
during installation.
upgrade 743
Chapter 22
• CreateService, 744
• ListServiceOptions, 748
• ListServiceProcessOptions, 749
• UpdateServiceOptions, 751
• UpdateServiceProcessOptions, 753
CreateService
Creates a Metadata Access Service. The Metadata Access Service is an application service that allows the
Developer tool to access Hadoop connection information to import and preview metadata.
<-DomainName|-dn> DomainName
<-NodeName|-nn> NodeName
<-UserName|-un> Username
<-Password|-pd> Password
<-ServiceName|-sn> ServiceName
<-HTTPProtocolType|-hp> HTTPProtocolType
[<-HTTPPort|-pt> HTTPPort]
[<-HTTPSPort|-spt> HTTPSPort]
[<-HadoopServicePrincipalName|-hpn> HadoopServicePrincipalName]
[<-HadoopKeyTab|-hkt> HadoopKeyTab]
[<-ServiceDescription|-sd> ServiceDescription]
[<-ResilienceTimeout|-re> ResilienceTimeout]
744
[<-FolderPath|-fp> FolderPath]
[<-BackupNodes|-bn> BackupNodes]
[<-KeyStoreFile|-kf> KeyStoreFile]
[<-KeystorePassword|-kp> KeystorePassword]
[<-TruststoreFile|-tf> TruststoreFile]
[<-TruststorePassword|-tp> TruststorePassword]
[<-SecurityDomain|-sdn> SecurityDomain]
[<-SSLProtocol|-sp> SSLProtocol]
[<-loggedInUserAsImpersonationUser|-uiu> UseLoggedInUserAsImpersonationUser]
[<-enableOSProfile|-osp> EnableOSProfile]
The following table describes infacmd mas CreateService options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set
-dn the domain name with the -dn option or the environment
variable INFA_DEFAULT_DOMAIN. If you set a domain
name with both methods, the -dn option takes
precedence.
-NodeName node_name Node where the Metadata Access Service runs. You can
-nn run the Data Integration Service only on a node.
-Password password Required if you specify the user name. Password for the
-pd user name. The password is case sensitive. You can set
a password with the -pd option or the environment
variable INFA_DEFAULT_DOMAIN_PASSWORD. If you set
a password with both methods, the password set with
the -pd option takes precedence.
CreateService 745
Option Argument Description
-HTTPProtocolType http_protocol_type Security protocol that the Metadata Access Service uses.
-hp Enter one of the following values:
- HTTP. Requests to the service must use an HTTP URL.
- HTTPS. Requests to the service must use an HTTPS
URL.
When you set the HTTP protocol type to HTTPS, you
enable Transport Layer Security (TLS) for the service.
Default is HTTP.
-HadoopKeyTab keytab_file_path The file path to the Kerberos keytab file on the machine
-hkt on which the Metadata Access Service runs.
Not applicable for the MapR distribution.
-FolderPath full_folder_path Optional. Full path, excluding the domain name, to the
-fp folder in which you want to create the Metadata Access
Service. Must be in the following format:
/parent_folder/child_folder
Default is “/” (the domain).
-BackupNodes node_name1,node_name Optional. Nodes on which the service can run if the
-bn 2,... primary node is unavailable. You can configure backup
nodes if you have high availability.
-KeystoreFile keystore_file_location Path and file name of the keystore file that contains the
-kf keys and certificates required if you use the HTTPS
protocol for the Metadata Access Service. You can
create a keystore file with a keytool. keytool is a utility
that generates and stores private or public key pairs and
associated certificates in a keystore file. You can use the
self-signed certificate or use a certificate signed by a
certificate authority.
-HadoopImpersonationUser hadoop_impersonation_ Optional. Enter a user name for the Metadata Access
-hu user Service to impersonate when it connects to a Hadoop
environment.
-enableOSProfile enable_OS_profile Indicates that the Metadata Access Service can use
-osp operating system profiles for metadata preview.
Default is false.
CreateService 747
ListServiceOptions
Lists the properties for a Metadata Access Service.
<-DomainName|-dn> DomainName
<-UserName|-un> Username
<-Password|-pd> Password
<-ServiceName|-sn> ServiceName
[<-SecurityDomain|-sdn> SecurityDomain]
[<-ResilienceTimeout|-re> ResilienceTimeout]
The following table describes infacmd mas ListServiceOptions options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set
-dn the domain name with the -dn option or the environment
variable INFA_DEFAULT_DOMAIN. If you set a domain
name with both methods, the -dn option takes
precedence.
-Password password Required if you specify the user name. Password for the
-pd user name. The password is case sensitive. You can set
a password with the -pd option or the environment
variable INFA_DEFAULT_DOMAIN_PASSWORD. If you set
a password with both methods, the password set with
the -pd option takes precedence.
ListServiceProcessOptions
Lists the properties of a Metadata Access Service process.
<-DomainName|-dn> DomainName
<-NodeName|-nn> NodeName
<-UserName|-un> Username
<-Password|-pd> Password
<-ServiceName|-sn> ServiceName
[<-SecurityDomain|-sdn> SecurityDomain]
[<-ResilienceTimeout|-re> ResilienceTimeout]
ListServiceProcessOptions 749
The following table describes infacmd mas ListServiceProcessOptions options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set
-dn the domain name with the -dn option or the environment
variable INFA_DEFAULT_DOMAIN. If you set a domain
name with both methods, the -dn option takes
precedence.
-NodeName node_name Required. Name of node where the service process runs.
-nn
-Password password Required if you specify the user name. Password for the
-pd user name. The password is case sensitive. You can set
a password with the -pd option or the environment
variable INFA_DEFAULT_DOMAIN_PASSWORD. If you set
a password with both methods, the password set with
the -pd option takes precedence.
You can change the properties while the service is running, but you must recycle the service for the changed
properties to take effect.
<-DomainName|-dn> DomainName
<-UserName|-un> Username
<-Password|-pd> Password
<-ServiceName|-sn> ServiceName
[<-SecurityDomain|-sdn> SecurityDomain]
[<-ResilienceTimeout|-re> ResilienceTimeout]
[<-Options|-o> options]
<-PrimaryNode|-nn> PrimaryNodeName
[<-BackupNodes|-bn> node_name1,node_name2,...]
[<-SearchIndexRoot|-si> SearchIndexRoot]
The following table describes infacmd mas UpdateServiceOptions options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set
-dn the domain name with the -dn option or the environment
variable INFA_DEFAULT_DOMAIN. If you set a domain
name with both methods, the -dn option takes
precedence.
-Password password Required if you specify the user name. Password for the
-pd user name. The password is case sensitive. You can set
a password with the -pd option or the environment
variable INFA_DEFAULT_DOMAIN_PASSWORD. If you set
a password with both methods, the password set with
the -pd option takes precedence.
-ServiceName service_name Required. Name of the Metadata Access Service that the
-sn application is deployed to.
UpdateServiceOptions 751
Option Argument Description
-PrimaryNode node_name Enter the node where the Metadata Access Service will
-nn run. The Metadata Access Service can run only on a
node.
-BackupNodes node_name1,node_name2,. Optional. Nodes on which the service can run if the
-bn .. primary node is unavailable. You can configure backup
nodes if you have high availability.
-SearchIndexRoot search_index_root Optional. Changes the directory for the search index.
-si Enter the full path to the directory. Default is the
Informatica installation directory.
Option Description
HttpConfigurationOptions.HTTPProtocolType Security protocol that the Metadata Access Service uses. Enter one of
the following values:
- HTTP. Requests to the service must use an HTTP URL.
- HTTPS. Requests to the service must use an HTTPS URL.
When you set the HTTP protocol type to HTTPS, you enable Transport
Layer Security (TLS) for the service.
Default is HTTP.
MASProperties.EnableOSProfile Flag to indicate if the Metadata Access Service can use operating
system profiles for metadata preview. Default is false.
MASProperties.HadoopKeytab The file path to the Kerberos keytab file on the machine on which the
Metadata Access Service runs.
Not applicable for the MapR distribution.
UpdateServiceProcessOptions
Updates properties for a Metadata Access Service process. To view current properties, run the infacmd mas
ListServiceProcessOptions command.
<-DomainName|-dn> DomainName
<-NodeName|-nn> NodeName
<-UserName|-un> Username
<-Password|-pd> Password
<-ServiceName|-sn> ServiceName
UpdateServiceProcessOptions 753
[<-SecurityDomain|-sdn> SecurityDomain]
[<-ResilienceTimeout|-re> ResilienceTimeout]
The following table describes infacmd mas UpdateServiceProcessOptions options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set
-dn the domain name with the -dn option or the environment
variable INFA_DEFAULT_DOMAIN. If you set a domain
name with both methods, the -dn option takes
precedence.
-Password password Required if you specify the user name. Password for the
-pd user name. The password is case sensitive. You can set
a password with the -pd option or the environment
variable INFA_DEFAULT_DOMAIN_PASSWORD. If you set
a password with both methods, the password set with
the -pd option takes precedence.
Option Description
GeneralOptions.JVMOptions Java Virtual Machine (JVM) command line options to run Java-
based programs. When you configure the JVM options, you must
set the Java SDK classpath, Java SDK minimum memory, and
Java SDK maximum memory properties.
HttpConfigurationOptions.KeyStoreFile Path and file name of the keystore file that contains the keys
and certificates required if you use the HTTPS protocol for the
Metadata Access Service. You can create a keystore file with a
keytool. keytool is a utility that generates and stores private or
public key pairs and associated certificates in a keystore file.
You can use the self-signed certificate or use a certificate
signed by a certificate authority.
UpdateServiceProcessOptions 755
Option Description
HttpConfigurationOptions.TrustStoreFile Path and file name of the truststore file that contains
authentication certificates trusted by the Metadata Access
Service.
• abortRun, 757
• createService, 758
• deploySpec, 761
• exportSpec, 762
• extendedRunStats, 764
• getSpecRunStats, 765
• listSpecRuns, 766
• listSpecs, 767
• restartMapping, 768
• runSpec, 769
abortRun
Aborts the ingestion mapping jobs in a run instance of a mass ingestion specification. When you abort the
ingestion mapping jobs, the command aborts the mappings that perform the ingestion jobs for all source
tables that are running or queued. The command does not abort mappings for the ingestion jobs that are
completed.
To abort the ingestion mapping jobs, you must specify a RunID. To find the RunID for a run instance, list the
specification run instances using infacmd mi listSpecRuns.
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
<-ServiceName|-sn> service_name
<-runID|-rid> run_id
757
The following table describes infacmd mi abortRun options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set the domain name with
-dn the -dn option or the environment variable INFA_DEFAULT_DOMAIN. If you set a
domain name with both methods, the -dn option takes precedence.
-UserName user_name Required. User name to connect to the domain. You can set the user name with
-un the -un option or the environment variable INFA_DEFAULT_DOMAIN_USER. If
you set a user name with both methods, the -un option takes precedence.
-Password password Required. Password for the user name. The password is case sensitive. You
-pd can set a password with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password with both
methods, the password set with the -pd option takes precedence.
-SecurityDomain security_domain Optional. Name of the security domain to which the domain user belongs. You
-sdn can set a security domain with the -sdn option or the environment variable
INFA_DEFAULT_SECURITY_DOMAIN. If you set a security domain name with
both methods, the -sdn option takes precedence. The security domain name is
case sensitive.
Default is Native.
-ServiceName service_name Required. Name of the Mass Ingestion Service that manages the mass
-sn ingestion specification.
-runID run_id Required. Run identifier number, or the Run ID, of the mass ingestion
-rid specification run instance.
To find the RunID for a run instance, list the specification run instances using
infacmd mi listSpecRuns.
createService
Creates a Mass Ingestion Service. When you create the Mass Ingestion Service, you must specify a Model
Repository Service. The Mass Ingestion Service is disabled by default. To enable the Mass Ingestion Service,
use infacmd isp enableService.
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-ServiceName|-sn> service_name
<-HttpPort|-http> http_port
[<-KeystoreFile|-kf> keystore_file_location]
[<-KeystorePassword|-kp> keystore_password]
<-LicenseName|-ln> license_name
[<-FolderPath|-fp> full_folder_path]
<-NodeName|-nn> node_name
<-RepositoryService|-rs> repository_service_name
[<-RepositoryUser|-ru> repository_user]
[<-RepositoryPassword|-rp> repository_password]
[<-RepositoryUserSecurityDomain|-rsdn> repository_user_security_domain]
The following table describes infacmd mi createService options and arguments:
createService 759
Option Argument Description
deploySpec
Deploys a mass ingestion specification. When you deploy the specification, you must specify the Data
Integration Service and the Hadoop connection. You must deploy a mass ingestion specification before you
can run it. After you deploy the specification, run the specification using infacmd mi runSpec.
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
<-ServiceName|-sn> service_name
<-DISServiceName|-dsn> dis_service_name
<-MISpecName|-spec> mi_spec_name
<-HadoopConnection|-hc> hadoop_connection
deploySpec 761
The following table describes infacmd mi deploySpec options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set the domain
-dn name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with both
methods, the -dn option takes precedence.
-UserName user_name Required. User name to connect to the domain. You can set the
-un user name with the -un option or the environment variable
INFA_DEFAULT_DOMAIN_USER. If you set a user name with both
methods, the -un option takes precedence.
-Password password Required. Password for the user name. The password is case
-pd sensitive. You can set a password with the -pd option or the
environment variable INFA_DEFAULT_DOMAIN_PASSWORD. If you
set a password with both methods, the password set with the -pd
option takes precedence.
-SecurityDomain security_domain Optional. Name of the security domain to which the domain user
-sdn belongs. You can set a security domain with the -sdn option or the
environment variable INFA_DEFAULT_SECURITY_DOMAIN. If you set
a security domain name with both methods, the -sdn option takes
precedence. The security domain name is case sensitive.
Default is Native.
-ServiceName service_name Required. Name of the Mass Ingestion Service that manages the
-sn mass ingestion specification.
-DISServiceName data_integration_service Required. Name of the Data Integration Service where you want to
-dis deploy the mass ingestion specification.
-MISpecName mi_spec_name Required. Name of the mass ingestion specification that you want
-spec to deploy to the Data Integration Service.
-HadoopConnection hadoop_connection Required. The Hadoop connection that the Data Integration Service
-hc uses to push the mass ingestion specification to the Hadoop
environment.
exportSpec
Exports the mass ingestion specification to an application archive file. When you export the specification, you
must specify the directory where you want to save the file. You can deploy the application archive file to a
Data Integration Service using infacmd dis DeployApplication.
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
<-ServiceName|-sn> service_name
<-MISpecName|-spec> mi_spec_name
<-Directory|-dir> dir_path
<-HadoopConnection|-hc> hadoop_connection
The following table describes infacmd mi exportSpec options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set the domain
-dn name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with both methods,
the -dn option takes precedence.
-UserName user_name Required. User name to connect to the domain. You can set the user
-un name with the -un option or the environment variable
INFA_DEFAULT_DOMAIN_USER. If you set a user name with both
methods, the -un option takes precedence.
-Password password Required. Password for the user name. The password is case sensitive.
-pd You can set a password with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password with both
methods, the password set with the -pd option takes precedence.
-SecurityDomain security_domain Optional. Name of the security domain to which the domain user
-sdn belongs. You can set a security domain with the -sdn option or the
environment variable INFA_DEFAULT_SECURITY_DOMAIN. If you set a
security domain name with both methods, the -sdn option takes
precedence. The security domain name is case sensitive.
Default is Native.
-ServiceName service_name Required. Name of the Mass Ingestion Service that manages the mass
-sn ingestion specification.
-MISpecName mi_spec_name Required. Name of the mass ingestion specification that you want to
-spec export.
-Directory dir_path Required. The directory where you want to write the application archive
-dir file.
-HadoopConnection hadoop_connection Required. The Hadoop connection that the Data Integration Service will
-hc use to run the mass ingestion job when you import the application
archive file and run the application.
You must specify the Hadoop connection because a Hadoop connection
does not persist for the mass ingestion specification while the
specification is stored in the Model repository.
exportSpec 763
extendedRunStats
Gets the extended ingestion statistics for a specific source table in a deployed mass ingestion specification.
To get the extended statistics, you must specify the RunID of the mass ingestion specification, the name of
the source table, and the mapping type.
The extended statistics report the ingestion statistics for table rows ingested from the source and the
ingestion statistics for table rows ingested in the target. The statistics list the number of rows that were
ingested successfully and the number of rows that contain errors.
If the run instance uses an incremental load, the extended statistics also report the incremental key and the
start value. The incremental key is the name of the column that the Spark engine used to fetch incremental
data in the source table. The start value is the value that the Spark engine used to start ingesting incremental
data.
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
<-ServiceName|-sn> service_name
<-RunID|-rid> run_id
<-SourceName|-srcName> source_name
<-MappingTp|-mtp> mapping_type
The following table describes infacmd mi extendedRunStats options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set the domain name with
-dn the -dn option or the environment variable INFA_DEFAULT_DOMAIN. If you set a
domain name with both methods, the -dn option takes precedence.
-UserName user_name Required. User name to connect to the domain. You can set the user name with
-un the -un option or the environment variable INFA_DEFAULT_DOMAIN_USER. If
you set a user name with both methods, the -un option takes precedence.
-Password password Required. Password for the user name. The password is case sensitive. You
-pd can set a password with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password with both
methods, the password set with the -pd option takes precedence.
-SecurityDomain security_domain Optional. Name of the security domain to which the domain user belongs. You
-sdn can set a security domain with the -sdn option or the environment variable
INFA_DEFAULT_SECURITY_DOMAIN. If you set a security domain name with
both methods, the -sdn option takes precedence. The security domain name is
case sensitive.
Default is Native.
-ServiceName service_name Required. Name of the Mass Ingestion Service that manages the mass
-sn ingestion specification associated with the ingestion mapping job.
-RunID run_id Required. Run identifier number, or the Run ID, of the mass ingestion
-rid specification run instance.
To find the RunID for a run instance, list the specification run instances using
infacmd mi listSpecRuns.
-SourceName source_name Required. Name of the source table in the run instance of the mass ingestion
-srcName specification.
To find the name of the source table, get the ingestion run statistics using
infacmd mi getSpecRunStats.
-MappingTp mapping_type Required. The mapping type corresponds to the run-time engine that runs the
-mtp ingestion mapping job for the source table.
To find the mapping type, get the ingestion run statistics using infacmd mi
getSpecRunStats.
getSpecRunStats
Gets the detailed run statistics for a deployed mass ingestion specification. To get the statistics, you must
specify a RunID. To find the RunID for a run instance, list the specification run instances using infacmd mi
listSpecRuns.
The detailed run statistics report the JobID for each ingestion mapping job in the deployed mass ingestion
specification, the name of the source table that each mapping job ingests, the run start time, the end time,
the run-time engine that runs the mapping job, and the job status. The JobID is the ID of the ingestion
mapping job that ingests the source table. The status might display Completed, Failed, Canceled, Running,
Aborted, Queued, or Unknown.
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
<-ServiceName|-sn> service_name
<-runID|-rid> run_id
getSpecRunStats 765
The following table describes infacmd mi getSpecRunStats options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set the domain name with
-dn the -dn option or the environment variable INFA_DEFAULT_DOMAIN. If you set a
domain name with both methods, the -dn option takes precedence.
-UserName user_name Required. User name to connect to the domain. You can set the user name with
-un the -un option or the environment variable INFA_DEFAULT_DOMAIN_USER. If
you set a user name with both methods, the -un option takes precedence.
-Password password Required. Password for the user name. The password is case sensitive. You
-pd can set a password with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password with both
methods, the password set with the -pd option takes precedence.
-SecurityDomain security_domain Optional. Name of the security domain to which the domain user belongs. You
-sdn can set a security domain with the -sdn option or the environment variable
INFA_DEFAULT_SECURITY_DOMAIN. If you set a security domain name with
both methods, the -sdn option takes precedence. The security domain name is
case sensitive.
Default is Native.
-ServiceName service_name Required. Name of the Mass Ingestion Service that manages the mass
-sn ingestion specification.
-runID run_id Required. Run identifier number, or the Run ID, of the mass ingestion
-rid specification run instance.
To find the RunID for a run instance, list the specification run instances using
infacmd mi listSpecRuns.
listSpecRuns
Lists the run instances of a deployed mass ingestion specification. Each run instance is defined by a RunID.
When you list the run instances, you must specify the Mass Ingestion Service.
The detailed run statistics report the RunID for each specification run instance, the load type, the run instance
start time, the Data Integration Service where the mass ingestion specification is deployed, the user who
started the run, and the job status for each run instance. The status might display Completed, Failed,
Cancelled, Running, Queued, or Unknown.
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
<-ServiceName|-sn> service_name
<-MISpecName|-spec> mi_spec_name
-DomainName domain_name Required. Name of the Informatica domain. You can set the domain name with
-dn the -dn option or the environment variable INFA_DEFAULT_DOMAIN. If you set a
domain name with both methods, the -dn option takes precedence.
-UserName user_name Required. User name to connect to the domain. You can set the user name with
-un the -un option or the environment variable INFA_DEFAULT_DOMAIN_USER. If
you set a user name with both methods, the -un option takes precedence.
-Password password Required. Password for the user name. The password is case sensitive. You
-pd can set a password with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password with both
methods, the password set with the -pd option takes precedence.
-SecurityDomain security_domain Optional. Name of the security domain to which the domain user belongs. You
-sdn can set a security domain with the -sdn option or the environment variable
INFA_DEFAULT_SECURITY_DOMAIN. If you set a security domain name with
both methods, the -sdn option takes precedence. The security domain name is
case sensitive.
Default is Native.
-ServiceName service_name Required. Name of the Mass Ingestion Service that manages the mass
-sn ingestion specification.
listSpecs
Lists the mass ingestion specifications. When you list specifications, you must specify the Mass Ingestion
Service.
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
<-ServiceName|-sn> service_name
listSpecs 767
The following table describes infacmd mi listSpecs options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set the domain name with
-dn the -dn option or the environment variable INFA_DEFAULT_DOMAIN. If you set a
domain name with both methods, the -dn option takes precedence.
-UserName user_name Required. User name to connect to the domain. You can set the user name with
-un the -un option or the environment variable INFA_DEFAULT_DOMAIN_USER. If
you set a user name with both methods, the -un option takes precedence.
-Password password Required. Password for the user name. The password is case sensitive. You
-pd can set a password with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password with both
methods, the password set with the -pd option takes precedence.
-SecurityDomain security_domain Optional. Name of the security domain to which the domain user belongs. You
-sdn can set a security domain with the -sdn option or the environment variable
INFA_DEFAULT_SECURITY_DOMAIN. If you set a security domain name with
both methods, the -sdn option takes precedence. The security domain name is
case sensitive.
Default is Native.
-ServiceName service_name Required. Name of the Mass Ingestion Service that manages the mass
-sn ingestion specifications.
restartMapping
Restarts the ingestion mapping jobs in a mass ingestion specification. Specify the list of source tables to
restart. You must specify the Mass Ingestion Service and the RunID for the run instance of the mass
ingestion specification. You can also specify whether you want to restart only the source tables that failed.
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
<-ServiceName|-sn> service_name
<-RunID|-rid> run_id
<-SourceList|-srcList> comma_separated_source_list
[<-OnlyFailed|-failed> true|false]
-DomainName domain_name Required. Name of the Informatica domain. You can set the
-dn domain name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with both
methods, the -dn option takes precedence.
-UserName user_name Required. User name to connect to the domain. You can set the
-un user name with the -un option or the environment variable
INFA_DEFAULT_DOMAIN_USER. If you set a user name with both
methods, the -un option takes precedence.
-Password password Required. Password for the user name. The password is case
-pd sensitive. You can set a password with the -pd option or the
environment variable INFA_DEFAULT_DOMAIN_PASSWORD. If
you set a password with both methods, the password set with the
-pd option takes precedence.
-SecurityDomain security_domain Optional. Name of the security domain to which the domain user
-sdn belongs. You can set a security domain with the -sdn option or
the environment variable INFA_DEFAULT_SECURITY_DOMAIN. If
you set a security domain name with both methods, the -sdn
option takes precedence. The security domain name is case
sensitive.
Default is Native.
-ServiceName service_name Required. Name of the Mass Ingestion Service that manages the
-sn ingestion of the source tables.
-runID run_id Required. Run identifier number (Run ID) of the mass ingestion
-rid specification run instance.
-SourceList comma_separated_source_list Required. The list of source tables to restart. Separate each
-srcList source table with a comma.
-OnlyFailed true|false Optional. Enter true to restart only the source tables that failed to
-failed be ingested. Enter false to restart all source tables.
runSpec
Runs a mass ingestion specification that is deployed to a Data Integration Service. Before you can run a
specification, you must deploy the specification using infacmd mi deploySpec.
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
runSpec 769
<-ServiceName|-sn> service_name
<-MISpecName|-spec> mi_spec_name
[<-LoadType|-lt> load_type]
<-DISServiceName|-dsn> dis_service_name
[<-OperatingSystemProfile|-osp> operating_system_profile_name]
The following table describes infacmd mi runSpec options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set
-dn the domain name with the -dn option or the environment
variable INFA_DEFAULT_DOMAIN. If you set a domain
name with both methods, the -dn option takes
precedence.
-UserName user_name Required. User name to connect to the domain. You can
-un set the user name with the -un option or the
environment variable INFA_DEFAULT_DOMAIN_USER. If
you set a user name with both methods, the -un option
takes precedence.
-Password password Required. Password for the user name. The password is
-pd case sensitive. You can set a password with the -pd
option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a
password with both methods, the password set with the
-pd option takes precedence.
-LoadType load_type Optional. Type of load to ingest the data in the mass
-lt ingestion specification. Use full or incremental.
Default is full.
If incremental load is not enabled in the mass ingestion
specification, you cannot use an incremental load to
ingest the data.
runSpec 771
Chapter 24
• BackupContents, 773
• CheckInObject, 775
• CreateContents, 777
• CreateFolder, 779
• CreateProject, 780
• CreateService, 782
• DeleteContents, 785
• DeleteFolder, 786
• DeleteProject, 788
• disableMappingValidationEnvironment, 789
• enableMappingValidationEnvironment, 791
• ListBackupFiles, 793
• ListCheckedOutObjects, 795
• listFolders, 796
• ListLockedObjects , 798
• listMappingEngines, 800
• listPermissionOnProject, 802
• ListProjects, 804
• ListServiceOptions, 805
• ListServiceProcessOptions, 807
• ManageGroupPermissionOnProject, 808
• ManageUserPermissionOnProject, 810
• PopulateVCS, 812
• ReassignCheckedOutObject, 814
• rebuildDependencyGraph, 815
• RenameFolder, 817
• replaceMappingHadoopRuntimeConnections, 818
• RestoreContents, 820
• UndoCheckout, 822
• setMappingExecutionEnvironment, 823
772
• UndoCheckout, 825
• UnlockObject , 826
• UpdateServiceOptions, 828
• UpdateServiceProcessOptions, 833
• UpdateStatistics, 835
• UpgradeContents, 837
• UpgradeExportedObjects, 838
BackupContents
Backs up the Model repository content to a file. If the repository content does not exist, the command fails.
To ensure that a consistent backup file is created, the backup operation blocks all other repository
operations until the backup completes.
<-DomainName|-dn> domain_name
[<-SecurityDomain|-sdn> security_domain]
<-UserName|-un> user_name
<-Password|-pd> password
<-ServiceName|-sn> service_name
<-OutputFileName|-of> output_file_name
[<-OverwriteFile|-ow> overwrite_file]
[<-Description|-ds> description]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
BackupContents 773
The following table describes infacmd mrs BackupContents options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set
-dn the domain name with the -dn option or the environment
variable INFA_DEFAULT_DOMAIN. If you set a domain
name with both methods, the -dn option takes
precedence.
-Password password Required if you specify the user name. Password for the
-pd user name. The password is case sensitive. You can set
a password with the -pd option or the environment
variable INFA_DEFAULT_DOMAIN_PASSWORD. If you set
a password with both methods, the password set with
the -pd option takes precedence.
OverwriteFile overwrite_file You must include this option to overwrite a backup file
-ow that has the same name.
CheckInObject
Checks in a single object that is checked out. The object is checked in to the Model repository.
CheckInObject 775
The following table describes infacmd mrs CheckInObject options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set
-dn the domain name with the -dn option or the environment
variable INFA_DEFAULT_DOMAIN. If you set a domain
name with both methods, the -dn option takes
precedence.
-Password password Required if you specify the user name. Password for the
-pd user name. The password is case sensitive. You can set
a password with the -pd option or the environment
variable INFA_DEFAULT_DOMAIN_PASSWORD. If you set
a password with both methods, the password set with
the -pd option takes precedence.
-Description description Optional. You can use this parameter for the check-in
-ds description or comments.
CreateContents
Creates repository content for a Model repository. The command fails if the content exists for the Model
repository.
<-DomainName|-dn> domain_name
[<-SecurityDomain|-sdn> security_domain]
<-UserName|-un> user_name
<-Password|-pd> password
<-ServiceName|-sn> service_name
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
CreateContents 777
The following table describes infacmd mrs CreateContents options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set
-dn the domain name with the -dn option or the environment
variable INFA_DEFAULT_DOMAIN. If you set a domain
name with both methods, the -dn option takes
precedence.
-Password password Required if you specify the user name. Password for the
-pd user name. The password is case sensitive. You can set
a password with the -pd option or the environment
variable INFA_DEFAULT_DOMAIN_PASSWORD. If you set
a password with both methods, the password set with
the -pd option takes precedence.
-DomainName domain_name Required. Name of the Informatica domain. You can set the
-dn domain name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with
both methods, the -dn option takes precedence.
-Password password Required if you specify the user name. Password for the user
-pd name. The password is case sensitive. You can set a
password with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password
with both methods, the password set with the -pd option
takes precedence.
CreateFolder 779
Option Argument Description
-ProjectName project_name Required. Name of the project to create the folder in.
-pn The project name is not case sensitive. The project name
cannot exceed 128 characters. The project name cannot
start with a number, and can contain alphanumeric
characters and the following characters:
@ # _
-CreatePath true|false Optional. If true, creates the folder in the specified path.
-cp Default is false.
CreateProject
Creates a project in a Model repository.
-DomainName domain_name Required. Name of the Informatica domain. You can set the
-dn domain name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with
both methods, the -dn option takes precedence.
-Password password Required if you specify the user name. Password for the user
-pd name. The password is case sensitive. You can set a
password with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password
with both methods, the password set with the -pd option
takes precedence.
CreateProject 781
CreateService
Creates a Model Repository Service. Before you create the Model Repository Service, you need to create a
database to store repository tables. Use the database client to create the database.
• The Model repository must have a unique schema. Two Model repositories or the Model repository and
the domain configuration database cannot share the same schema.
• The Model repository must have a unique repository database name.
<-DomainName|-dn> domain_name
<-NodeName|-nn> node_name
[<-SecurityDomain|-sdn> security_domain]
<-UserName|-un> user_name
<-Password|-pd> password
<-ServiceName|-sn> service_name
<-DbUser|-du> db_user
<-DbPassword|-dp> db_password
<-DbUrl|-dl> db_url
[<-DbDriver|-dr> db_driver]
[<-DbDialect|-dd> db_dialect]
[<-SearchIndexRoot|-si> search_index_root]
[<-SecureJDBCParameters|-sjdbcp> secure_jdbc_parameters]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
[<-FolderPath|-fp> full_folder_path]
[<-BackupNodes|-bn> nodename1,nodename2,...]
-DomainName domain_name Required. Name of the Informatica domain. You can set
-dn the domain name with the -dn option or the environment
variable INFA_DEFAULT_DOMAIN. If you set a domain
name with both methods, the -dn option takes
precedence.
NodeName node_name Required. Node where you want to run the Model
-nn Repository Service to run.
-Password password Required if you specify the user name. Password for the
-pd user name. The password is case sensitive. You can set
a password with the -pd option or the environment
variable INFA_DEFAULT_DOMAIN_PASSWORD. If you set
a password with both methods, the password set with
the -pd option takes precedence.
CreateService 783
Option Argument Description
-DbDialect db_dialect Optional. The SQL dialect for a particular database. The
-dd dialect maps java objects to database objects.
For example:
org.hibernate.dialect.Oracle9Dialect
-SearchIndexRoot search_index_root Optional. Changes the directory for the search index.
-si Enter the full path to the directory. Default is the
Informatica installation directory.
-DbSchema db_schema Optional. The schema name for a Microsoft SQL Server
-ds database or PostgreSQL database.
-DbTablespace db_tablespace Required for a DB2 database only. When you configure a
-dt tablespace name, the Model Repository Service creates
all repository tables in the same tablespace. You cannot
use spaces in the tablespace name.
[<-SecureJDBCParameters|- Secure JDBC Parameters If the Model repository database is secured with the SSL
sjdbcp> protocol, you must enter the secure database
secure_jdbc_parameters] parameters.
Enter the parameters as name=value pairs separated by
semicolon characters (;). For
example:param1=value1;param2=value2
-FolderPath full_folder_path Optional. Full path, excluding the domain name, to the
-fp folder in which you want to create the service. Must be in
the following format:
/parent_folder/child_folder
Default is “/” (the domain).
-BackupNodes nodename1,nodename2,... Optional. Nodes on which the service can run if the
-bn primary node is unavailable. You can configure backup
nodes if you have high availability.
<-DomainName|-dn> domain_name
[<-SecurityDomain|-sdn> security_domain]
<-UserName|-un> user_name
<-Password|-pd> password
<-ServiceName|-sn> service_name
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
The following table describes infacmd mrs DeleteContents options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set
-dn the domain name with the -dn option or the environment
variable INFA_DEFAULT_DOMAIN. If you set a domain
name with both methods, the -dn option takes
precedence.
DeleteContents 785
Option Argument Description
-Password password Required if you specify the user name. Password for the
-pd user name. The password is case sensitive. You can set
a password with the -pd option or the environment
variable INFA_DEFAULT_DOMAIN_PASSWORD. If you set
a password with both methods, the password set with
the -pd option takes precedence.
DeleteFolder
Deletes a folder from a project in a Model repository.
To delete a folder that contains objects, set the -ForceDelete option to true.
-DomainName domain_name Required. Name of the Informatica domain. You can set the
-dn domain name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with
both methods, the -dn option takes precedence.
-Password password Required if you specify the user name. Password for the user
-pd name. The password is case sensitive. You can set a
password with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password
with both methods, the password set with the -pd option
takes precedence.
-ProjectName project_name Required. Name of the project that contains the folder.
-pn
-Path folder_path_and_name Required. Path and name of the folder to delete. Path must
-p start with a forward slash (/).
DeleteFolder 787
Option Argument Description
DeleteProject
Deletes a project in a Model repository.
To delete a project that contains folders and objects, set the -ForceDelete option to true.
-DomainName domain_name Required. Name of the Informatica domain. You can set the
-dn domain name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with
both methods, the -dn option takes precedence.
-Password password Required if you specify the user name. Password for the user
-pd name. The password is case sensitive. You can set a
password with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password
with both methods, the password set with the -pd option
takes precedence.
-ForceDelete true|false Optional. If true, deletes a project that contains folders and
-f objects. Default is false.
disableMappingValidationEnvironment
Disables the selected mapping validation environment for mappings that you run from the Developer tool.
Use the ValidationEnvironment parameter to disable a validation environment for a mapping. Repeat the
command for each environment you want to remove.
Use filters to update one or more mappings in a project. If you do include filters, the command updates all
mappings that are not deployed to the Data Integration Service. A mapping must match all specified filters to
be modified.
disableMappingValidationEnvironment 789
[<-ProjectName|-pn> project_name]
[<-MappingNamesFilter|-mnf> mapping_names]
[<-ExecutionEnvironmentFilter|-eef> execution_environment_name]
<-ValidationEnvironment|-ve> validation_environment_name
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
The following table describes the disableMappingValidationEnvironment options and arguments:
Password password Required if you specify the user name. Password for
-pd the user name. The password is case sensitive. You
can set a password with the -pd option or the
environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a
password with both methods, the password set with
the -pd option takes precedence.
enableMappingValidationEnvironment
Enables a mapping validation environment for mappings that you run from the Developer tool. The mapping
validation environment properties indicate the engines that the mapping will be validated to run in.
Use filters to update one or more mappings in a project. If you do not include filters, the command updates
all mappings that are not deployed to the Data Integration Service. A mapping must match all specified filters
to be modified.
enableMappingValidationEnvironment 791
<-ValidationEnvironment|-ve> validation_environment_name
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
The following table describes the enableMappingValidationEnvironment options and arguments:
Password password Required if you specify the user name. Password for
-pd the user name. The password is case sensitive. You
can set a password with the -pd option or the
environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a
password with both methods, the password set with
the -pd option takes precedence.
ListBackupFiles
Lists files in the backup folder.
<-DomainName|-dn> domain_name
[<-SecurityDomain|-sdn> security_domain]
<-UserName|-un> user_name
<-Password|-pd> password
<-ServiceName|-sn> service_name
ListBackupFiles 793
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
The following table describes infacmd mrs ListBackupFiles options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set
-dn the domain name with the -dn option or the environment
variable INFA_DEFAULT_DOMAIN. If you set a domain
name with both methods, the -dn option takes
precedence.
-Password password Required if you specify the user name. Password for the
-pd user name. The password is case sensitive. You can set
a password with the -pd option or the environment
variable INFA_DEFAULT_DOMAIN_PASSWORD. If you set
a password with both methods, the password set with
the -pd option takes precedence.
-DomainName domain_name Required. Name of the Informatica domain. You can set
-dn the domain name with the -dn option or the environment
variable INFA_DEFAULT_DOMAIN. If you set a domain
name with both methods, the -dn option takes
precedence.
ListCheckedOutObjects 795
Option Argument Description
-Password password Required if you specify the user name. Password for the
-pd user name. The password is case sensitive. You can set
a password with the -pd option or the environment
variable INFA_DEFAULT_DOMAIN_PASSWORD. If you set
a password with both methods, the password set with
the -pd option takes precedence.
-ByUser checkedout_by_user Optional. User account that has checked out objects in
-bu the Model repository.
listFolders
Lists the names of all of the folders in the project folder path that you specify.
Use the -Path option to list all the folders in a project, or all the folders that a subfolder contains. Use a slash
character (/) to specify the top level of a project.
For example, the following command lists all the folders in /MRS_1/Project_A/:
infacmd mrs listFolders ... -sn MRS_1 -pn Project_A -p /
If the contents of Project _A are Folder_1 and Folder_2, then the following command lists all the subfolders in
Folder_1:
infacmd mrs listFolders ... -sn MRS_1 -pn Project_A -p /Folder_1/
-DomainName domain_name Required. Name of the Informatica domain. You can set
-dn the domain name with the -dn option or the environment
variable INFA_DEFAULT_DOMAIN. If you set a domain
name with both methods, the -dn option takes
precedence.
-Password password Required if you specify the user name. Password for the
-pd user name. The password is case sensitive. You can set
a password with the -pd option or the environment
variable INFA_DEFAULT_DOMAIN_PASSWORD. If you set
a password with both methods, the password set with
the -pd option takes precedence.
listFolders 797
Option Argument Description
-ProjectName project_name Required. Name of the project for which you want to list
-pn the folders.
The project name is not case sensitive. The project name
cannot exceed 128 characters. The project name cannot
start with a number, and can contain alphanumeric
characters and the following characters:
@ # _
-Path path Required. Path to the parent folder in which you want to
-p list folder contents.
The path must start with a slash (/). The name is not
case sensitive.
ListLockedObjects
Displays a list of objects that are locked by a user. Run this command against a repository that is not
integrated with a version control system.
Note: If you run this command against a versioned repository, the command fails.
-DomainName domain_name Required. Name of the Informatica domain. You can set
-dn the domain name with the -dn option or the environment
variable INFA_DEFAULT_DOMAIN. If you set a domain
name with both methods, the -dn option takes
precedence.
-Password password Required if you specify the user name. Password for the
-pd user name. The password is case sensitive. You can set
a password with the -pd option or the environment
variable INFA_DEFAULT_DOMAIN_PASSWORD. If you set
a password with both methods, the password set with
the -pd option takes precedence.
-ByUser locked_by_user Optional. User account that owns the lock on objects in
-bu the Model repository. Default is objects locked by all
users.
ListLockedObjects 799
Option Argument Description
-ObjectType object_type Optional. Type of the object to search. You can run the
-ot command against one object type. If you omit the
parameter, the command runs against all object types.
-ByObjectPathAndName object_path_and_name Optional. Model repository path and name of the object
-bopn to search.
listMappingEngines
Lists the run-time engines of the mappings that are run from the Developer Tool. You can filter the results
based on project, validation environment, run-time environment, and run-time environment parameters.
<-DomainName|-dn> domain_name
[<-SecurityDomain|-sdn> security_domain]
<-UserName|-un> user_name
<-Password|-pd> password
<-ServiceName|-sn> service_name
[<-ProjectNames|-pn>] project_name
[-ValidationEnvironmentFilter|-vef] validation_environment_name
[<-ExecutionEnvironmentFilter|-eef> execution_environment_name]
[<-ExecutionEnvironmentParameterNameFilter|-pnf> execution_environment_parameter_name]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
-DomainName domain_name Required. Name of the Informatica domain. You can set
-dn the domain name with the -dn option or the environment
variable INFA_DEFAULT_DOMAIN. If you set a domain
name with both methods, the -dn option takes
precedence.
-Password password Required if you specify the user name. Password for the
-pd user name. The password is case sensitive. You can set
a password with the -pd option or the environment
variable INFA_DEFAULT_DOMAIN_PASSWORD. If you set
a password with both methods, the password set with
the -pd option takes precedence.
ProjectName project_name Optional. Name of the project that contains the mapping.
-pn If you do not specify a project name, the command lists
all the projects and the mappings within the projects.
You can specify only one project at a time.
listMappingEngines 801
Option Argument Description
listPermissionOnProject
List all the permissions on multiple projects for groups and users. Separate multiple project names with a
comma. You need read permission on the project to view the list of permissions for the groups and users.
<-DomainName|-dn> domain_name
[<-SecurityDomain|-sdn> security_domain]
<-UserName|-un> user_name
<-Password|-pd> password
<-ServiceName|-sn> service_name
<-ProjectNames|-pn> project_name_list
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
-DomainName domain_name Required. Name of the Informatica domain. You can set
-dn the domain name with the -dn option or the environment
variable INFA_DEFAULT_DOMAIN. If you set a domain
name with both methods, the -dn option takes
precedence.
-Password password Required if you specify the user name. Password for the
-pd user name. The password is case sensitive. You can set
a password with the -pd option or the environment
variable INFA_DEFAULT_DOMAIN_PASSWORD. If you set
a password with both methods, the password set with
the -pd option takes precedence.
-ProjectNames project_name_list Required. Names of the projects for which you want to
-pn list the permissions for users and groups.
The project names are not case sensitive. Separate
multiple project names with a comma.
listPermissionOnProject 803
ListProjects
Lists projects in the Model repository. The command fails if the Model repository does not have repository
content.
<-DomainName|-dn> domain_name
[<-SecurityDomain|-sdn> security_domain]
<-UserName|-un> user_name
<-Password|-pd> password
<-ServiceName|-sn> service_name
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
The following table describes infacmd mrs ListProjects options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set
-dn the domain name with the -dn option or the environment
variable INFA_DEFAULT_DOMAIN. If you set a domain
name with both methods, the -dn option takes
precedence.
-Password password Required if you specify the user name. Password for the
-pd user name. The password is case sensitive. You can set
a password with the -pd option or the environment
variable INFA_DEFAULT_DOMAIN_PASSWORD. If you set
a password with both methods, the password set with
the -pd option takes precedence.
ListServiceOptions
Lists options for the Model Repository Service.
<-DomainName|-dn> domain_name
[<-SecurityDomain|-sdn> security_domain]
<-UserName|-un> user_name
<-Password|-pd> password
<-ServiceName|-sn> service_name
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
ListServiceOptions 805
The following table describes infacmd mrs ListServiceOptions options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set
-dn the domain name with the -dn option or the environment
variable INFA_DEFAULT_DOMAIN. If you set a domain
name with both methods, the -dn option takes
precedence.
-Password password Required if you specify the user name. Password for the
-pd user name. The password is case sensitive. You can set
a password with the -pd option or the environment
variable INFA_DEFAULT_DOMAIN_PASSWORD. If you set
a password with both methods, the password set with
the -pd option takes precedence.
<-DomainName|-dn> domain_name
<-NodeName|-nn> node_name
[<-SecurityDomain|-sdn> security_domain]
<-UserName|-un> user_name
<-Password|-pd> password
<-ServiceName|-sn> service_name
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
The following table describes infacmd mrs ListServiceProcessOptions options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set
-dn the domain name with the -dn option or the environment
variable INFA_DEFAULT_DOMAIN. If you set a domain
name with both methods, the -dn option takes
precedence.
NodeName node_name Required. Node name for which you want to list the
-nn service process options.
ListServiceProcessOptions 807
Option Argument Description
-Password password Required if you specify the user name. Password for the
-pd user name. The password is case sensitive. You can set
a password with the -pd option or the environment
variable INFA_DEFAULT_DOMAIN_PASSWORD. If you set
a password with both methods, the password set with
the -pd option takes precedence.
ManageGroupPermissionOnProject
Manages permissions on multiple projects for a group.
-DomainName domain_name Required. Name of the Informatica domain. You can set
-dn the domain name with the -dn option or the environment
variable INFA_DEFAULT_DOMAIN. If you set a domain
name with both methods, the -dn option takes
precedence.
-Password password Required if you specify the user name. Password for the
-pd user name. The password is case sensitive. You can set
a password with the -pd option or the environment
variable INFA_DEFAULT_DOMAIN_PASSWORD. If you
set a password with both methods, the password set
with the -pd option takes precedence.
-ProjectNames project_name_list Required. Names of the projects for which you want to
-pn allow or revoke permissions.
The project names are not case sensitive.
Separate multiple project names with a comma.
ManageGroupPermissionOnProject 809
Option Argument Description
-RecipientName recipient_name Required. The name of the recipient group for which
-rn you want to manage permissions.
ManageUserPermissionOnProject
Manages permissions on multiple projects for a user.
-DomainName domain_name Required. Name of the Informatica domain. You can set
-dn the domain name with the -dn option or the environment
variable INFA_DEFAULT_DOMAIN. If you set a domain
name with both methods, the -dn option takes
precedence.
-Password password Required if you specify the user name. Password for the
-pd user name. The password is case sensitive. You can set
a password with the -pd option or the environment
variable INFA_DEFAULT_DOMAIN_PASSWORD. If you
set a password with both methods, the password set
with the -pd option takes precedence.
-ProjectNames project_name_list Required. Names of the projects for which you want to
-pn allow or revoke permissions.
The project names are not case sensitive.
Separate multiple project names with a comma.
ManageUserPermissionOnProject 811
Option Argument Description
-RecipientName recipient_name Required. The user name of the recipient user for which
-rn you want to manage permissions.
PopulateVCS
Synchronizes the Model repository with a version control system. Before you synchronize the Model
repository with a version control system, you configure versioning properties.
When you configure versioning properties, you restart the Model repository, and then you run the
PopulateVCS command.
Note: After you run the command, the Model repository is unavailable until synchronization completes.
-DomainName domain_name Required. Name of the Informatica domain. You can set
-dn the domain name with the -dn option or the environment
variable INFA_DEFAULT_DOMAIN. If you set a domain
name with both methods, the -dn option takes
precedence.
-Password password Required if you specify the user name. Password for the
-pd user name. The password is case sensitive. You can set
a password with the -pd option or the environment
variable INFA_DEFAULT_DOMAIN_PASSWORD. If you set
a password with both methods, the password set with
the -pd option takes precedence.
PopulateVCS 813
ReassignCheckedOutObject
Reassigns the ownership of a checked-out object to another user. If the owner of a checked-out object saved
changes, the changes are retained when you reassign the object. If the changes are not saved, the changes
are lost when you reassign the object.
-DomainName domain_name Required. Name of the Informatica domain. You can set
-dn the domain name with the -dn option or the environment
variable INFA_DEFAULT_DOMAIN. If you set a domain
name with both methods, the -dn option takes
precedence.
-Password password Required if you specify the user name. Password for the
-pd user name. The password is case sensitive. You can set
a password with the -pd option or the environment
variable INFA_DEFAULT_DOMAIN_PASSWORD. If you set
a password with both methods, the password set with
the -pd option takes precedence.
-ToUser Username Required. Username of the user who you want to own the
-tu object checked-out state.
-ToUserSecurityDomain Security domain Optional. Security domain of the user who you want to
-tsd own the object checked-out state.
rebuildDependencyGraph
Rebuilds the object dependency graph so that you can view object dependencies after an upgrade. Run this
command if the upgrade of the Model Repository Service failed to rebuild the object dependency graph.
Users must not access Model repository objects until the rebuild process completes, or the object
dependency graph might not be accurate. You might want to run the command when users are not logged in.
<-DomainName|-dn> domain_name
[<-SecurityDomain|-sdn> security_domain]
<-UserName|-un> user_name
<-Password|-pd> password
<-ServiceName|-sn> service_name
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
rebuildDependencyGraph 815
The following table describes infacmd mrs rebuildDependencyGraph options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set
-dn the domain name with the -dn option or the environment
variable INFA_DEFAULT_DOMAIN. If you set a domain
name with both methods, the -dn option takes
precedence.
-Password password Required if you specify the user name. Password for the
-pd user name. The password is case sensitive. You can set
a password with the -pd option or the environment
variable INFA_DEFAULT_DOMAIN_PASSWORD. If you set
a password with both methods, the password set with
the -pd option takes precedence.
-DomainName domain_name Required. Name of the Informatica domain. You can set the
-dn domain name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with
both methods, the -dn option takes precedence.
-Password password Required if you specify the user name. Password for the user
-pd name. The password is case sensitive. You can set a
password with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password
with both methods, the password set with the -pd option
takes precedence.
RenameFolder 817
Option Argument Description
-ProjectName project_name Required. Name of the project that contains the folder to
-pn rename.
-SourceFolder source_folder_path_an Required. Path and name of the folder to rename. Path must
-sf d_name start with a forward slash (/).
replaceMappingHadoopRuntimeConnections
Replaces the Hadoop connection of all mappings in the repository with another Hadoop connection. The Data
Integration Service uses the Hadoop connection to connect to the Hadoop cluster to run mappings in the
Hadoop environment.
The command does not modify Hadoop connections in the transformations. You can specify the project
name to replace the Hadoop connection of the mappings in the project.
replaceMappingHadoopRuntimeConnections
<-DomainName|-dn> domain_name
[<-SecurityDomain|-sdn> security_domain]
<-UserName|-un> user_name
<-Password|-pd> password
<-ServiceName|-sn> service_name
[<-ProjectName|-pn> project_name]
<-OldConnectionName|-oc> connection_name_of_old_connection_to_replace
<-NewConnectionName|-nc> connection_name_of_new_connection
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
replaceMappingHadoopRuntimeConnections 819
Option Argument Description
RestoreContents
Restores content of a Model repository from a backup file.
<-DomainName|-dn> domain_name
[<-SecurityDomain|-sdn> security_domain]
<-UserName|-un> user_name
<-Password|-pd> password
<-ServiceName|-sn> service_name
<-InputFileName|-if> input_file_name
[<-ResilienceTimeout|-re> timeout_period_in_seconds
-DomainName domain_name Required. Name of the Informatica domain. You can set
-dn the domain name with the -dn option or the environment
variable INFA_DEFAULT_DOMAIN. If you set a domain
name with both methods, the -dn option takes
precedence.
-Password password Required if you specify the user name. Password for the
-pd user name. The password is case sensitive. You can set
a password with the -pd option or the environment
variable INFA_DEFAULT_DOMAIN_PASSWORD. If you set
a password with both methods, the password set with
the -pd option takes precedence.
RestoreContents 821
UndoCheckout
Reverts the checkout of a Model repository object. The object is checked in to the Model repository. The
Model repository discards any changes to the object since it was checked out. The version control system
does not increment the version number or add to the version history.
-DomainName domain_name Required. Name of the Informatica domain. You can set
-dn the domain name with the -dn option or the environment
variable INFA_DEFAULT_DOMAIN. If you set a domain
name with both methods, the -dn option takes
precedence.
-Password password Required if you specify the user name. Password for the
-pd user name. The password is case sensitive. You can set
a password with the -pd option or the environment
variable INFA_DEFAULT_DOMAIN_PASSWORD. If you set
a password with both methods, the password set with
the -pd option takes precedence.
setMappingExecutionEnvironment
Specifies the mapping execution environment for mappings that you run from the Developer tool.
Use filters to update one or more mappings in a project. If you do not include filters, the command updates
all mappings that are not deployed to the Data Integration Service. A mapping must match all specified filters
to be modified.
setMappingExecutionEnvironment 823
The following table describes the setMappingExecutionEnvironment options and arguments:
DomainName domain_name Required. Name of the Informatica domain. You can set the
-dn domain name with the -dn option or the environment
variable INFA_DEFAULT_DOMAIN. If you set a domain name
with both methods, the -dn option takes precedence.
Password password Required if you specify the user name. Password for the
-pd user name. The password is case sensitive. You can set a
password with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password
with both methods, the password set with the -pd option
takes precedence.
ProjectName project_name Optional. Name of the project that contains the mapping. If
-pn you do not specify a project name, the command updates all
projects in the Model repository.
MappingNamesFilter mapping_names Optional. The names of mappings that you want to set the
-mnf execution environment for. Separate mapping names with
commas.
Default is all undeployed mappings.
UndoCheckout
Reverts the checkout of a Model repository object. The object is checked in to the Model repository. The
Model repository discards any changes to the object since it was checked out. The version control system
does not increment the version number or add to the version history.
-DomainName domain_name Required. Name of the Informatica domain. You can set
-dn the domain name with the -dn option or the environment
variable INFA_DEFAULT_DOMAIN. If you set a domain
name with both methods, the -dn option takes
precedence.
UndoCheckout 825
Option Argument Description
-Password password Required if you specify the user name. Password for the
-pd user name. The password is case sensitive. You can set
a password with the -pd option or the environment
variable INFA_DEFAULT_DOMAIN_PASSWORD. If you set
a password with both methods, the password set with
the -pd option takes precedence.
UnlockObject
Unlocks a Model repository object that is locked by a user. Run this command against a repository that is not
integrated with a version control system.
Note: If you run this command against a versioned repository, the command fails.
-DomainName domain_name Required. Name of the Informatica domain. You can set
-dn the domain name with the -dn option or the environment
variable INFA_DEFAULT_DOMAIN. If you set a domain
name with both methods, the -dn option takes
precedence.
-Password password Required if you specify the user name. Password for the
-pd user name. The password is case sensitive. You can set
a password with the -pd option or the environment
variable INFA_DEFAULT_DOMAIN_PASSWORD. If you set
a password with both methods, the password set with
the -pd option takes precedence.
UnlockObject 827
UpdateServiceOptions
Updates options for the Model Repository Service. Separate multiple options with a space. To enter a value
that contains a space or other non-alphanumeric character, enclose the value in quotation marks.
<-DomainName|-dn> domain_name
[<-SecurityDomain|-sdn> security_domain]
<-UserName|-un> user_name
<-Password|-pd> password
<-ServiceName|-sn> service_name
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-Options|-o> options
[<-BackupNode|-bn> nodename1,nodename2,...]
[<-SearchIndexRoot|-si> search_index_root]
The following table describes infacmd mrs UpdateServiceOptions options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set
-dn the domain name with the -dn option or the environment
variable INFA_DEFAULT_DOMAIN. If you set a domain
name with both methods, the -dn option takes
precedence.
-Password password Required if you specify the user name. Password for the
-pd user name. The password is case sensitive. You can set
a password with the -pd option or the environment
variable INFA_DEFAULT_DOMAIN_PASSWORD. If you set
a password with both methods, the password set with
the -pd option takes precedence.
-PrimaryNode primary node name Optional. Node where you want to run the Model
-nn Repository Service to run.
-BackupNodes nodename1,nodename2,... Optional. Nodes on which the service can run if the
-bn primary node is unavailable. You can configure backup
nodes if you have high availability.
UpdateServiceOptions 829
The following table describes Model Repository Service options:
CACHE.EnableCache true | false Enables the Model Repository Service to store Model
repository objects in cache memory. To apply changes,
restart the Model Repository Service.
CACHE.CacheJVMOptions -Xmx[heap_size] JVM options for the Model Repository Service cache.
To configure the amount of memory allocated to cache,
configure the maximum heap size. This field must
include the maximum heap size, specified by the -Xmx
option. The default value and minimum value for the
maximum heap size is -Xmx128m.
The options you configure apply when Model
Repository Service cache is enabled. To apply changes,
restart the Model Repository Service. The options you
configure in this field do not apply to the JVM that runs
the Model Repository Service.
PERSISTENCE_DB.DatabaseTabl db_tablespace Required for a DB2 database only. When you configure
espace a tablespace name, the Model Repository Service
creates all repository tables in the same tablespace.
You cannot use spaces in the tablespace name.
For a multi-partition IBM DB2 database, the tablespace
must span a single node and a single partition.
PERSISTENCE_DB.JDBCConnect JDBC Connect String The JDBC connection string to connect to the Model
String repository database. Use the following syntax for each
supported database:
- IBM Db2. jdbc:informatica:db2://<host
name>:<port
number>;DatabaseName=<database
name>;BatchPerformanceWorkaround=true;Dy
namicSections=3000
- Microsoft SQL Server that uses the default instance.
jdbc:informatica:sqlserver://<host
name>:<port
number>;DatabaseName=<database
name>;SnapshotSerializable=true
- Microsoft SQL Server that uses a named instance.
jdbc:informatica:sqlserver://<host name>
\<named instance
name>;DatabaseName=<database
name>;SnapshotSerializable=true
- Azure SQL Server.
jdbc:informatica:sqlserver://<host
name>:<port
number>;DatabaseName=<database
name>;SnapshotSerializable=true;
SnapshotSerializable=true;EncryptionMeth
od=SSL;HostNameInCertificate=*.<hostname
incertificate>;ValidateServerCertificate
=true
- Oracle. jdbc:informatica:oracle://<host
name>:<port number>;SID=<database
name>;MaxPooledStatements=20;CatalogOpti
ons=0;BatchPerformanceWorkaround=true
- PostgreSQL. jdbc:informatica:postgresql://
<host name>:<port number>;DatabaseName=
PERSISTENCE_DB.SecureJDBCP Secure JDBC If the Model repository database is secured with the
arameters Parameters SSL protocol, you must enter the secure database
parameters.
Enter the parameters as name=value pairs separated
by semicolon characters (;). For example:
param1=value1;param2=value2
PERSISTENCE_DB.Dialect Dialect The SQL dialect for a particular database. The dialect
maps java objects to database objects.
For example:
org.hibernate.dialect.Oracle9Dialect
PERSISTENCE_DB.Driver Driver The Data Direct driver used to connect to the database.
For example:
com.informatica.jdbc.oracle.OracleDriver
UpdateServiceOptions 831
Option Argument Description
SEARCH.SearchAnalyzer Fully qualified Java Fully qualified Java class name of the search analyzer.
class name By default, the Model Repository Service uses the
following search analyzer for English:
com.informatica.repository.service.provide
r.search.analysis.MMStandardAnalyzer
You can specify the following Java class name of the
search analyzer for Chinese, Japanese and Korean
languages:
org.apache.lucene.analysis.cjk.CJKAnalyzer
Or, you can create and specify a custom search
analyzer.
SEARCH.SearchAnalyzerFactory Fully qualified Java Fully qualified Java class name of the factory class if
class name you used a factory class when you created a custom
search analyzer.
If you use a custom search analyzer, enter the name of
either the search analyzer class or the search analyzer
factory class.
VCS.URL URL of the Subversion Required to configure versioning properties for the
repository Model repository on SVN and Git.
URL of the Subversion repository. For example:
VCS.URL=https://myserver.company.com/svn/
Do not use this option when you configure Perforce as
the version control system.
UpdateServiceProcessOptions
Updates service process options for the Model Repository Service. Separate multiple options with a space.
To enter a value that contains a space or other nonalphanumeric character, enclose the value in quotation
marks.
<-DomainName|-dn> domain_name
<-NodeName|-nn> node_name
[<-SecurityDomain|-sdn> security_domain]
<-UserName|-un> user_name
<-Password|-pd> password
<-ServiceName|-sn> service_name
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
UpdateServiceProcessOptions 833
<-Options|-o> options
The following table describes infacmd mrs UpdateServiceProcessOptions options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set
-dn the domain name with the -dn option or the environment
variable INFA_DEFAULT_DOMAIN. If you set a domain
name with both methods, the -dn option takes
precedence.
NodeName node_name Required. Node name for which you want to set the
-nn process options.
-Password password Required if you specify the user name. Password for the
-pd user name. The password is case sensitive. You can set
a password with the -pd option or the environment
variable INFA_DEFAULT_DOMAIN_PASSWORD. If you set
a password with both methods, the password set with
the -pd option takes precedence.
UpdateStatistics
Update statistics for Model repository on Microsoft SQL Server. You can run this command if you have the
system administrator privilege for the Microsoft SQL Server database.
<-DomainName|-dn> domain_name
[<-SecurityDomain|-sdn> security_domain]
<-UserName|-un> user_name
<-Password|-pd> password
<-ServiceName|-sn> service_name
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
UpdateStatistics 835
The following table describes infacmd mrs updateStatistics options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set
-dn the domain name with the -dn option or the environment
variable INFA_DEFAULT_DOMAIN. If you set a domain
name with both methods, the -dn option takes
precedence.
-Password password Required if you specify the user name. Password for the
-pd user name. The password is case sensitive. You can set
a password with the -pd option or the environment
variable INFA_DEFAULT_DOMAIN_PASSWORD. If you set
a password with both methods, the password set with
the -pd option takes precedence.
<-DomainName|-dn> domain_name
[<-SecurityDomain|-sdn> security_domain]
<-UserName|-un> user_name
<-Password|-pd> password
<-ServiceName|-sn> service_name
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
The following table describes infacmd mrs UpgradeContents options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set
-dn the domain name with the -dn option or the environment
variable INFA_DEFAULT_DOMAIN. If you set a domain
name with both methods, the -dn option takes
precedence.
UpgradeContents 837
Option Argument Description
-Password password Required if you specify the user name. Password for the
-pd user name. The password is case sensitive. You can set
a password with the -pd option or the environment
variable INFA_DEFAULT_DOMAIN_PASSWORD. If you set
a password with both methods, the password set with
the -pd option takes precedence.
UpgradeExportedObjects
Upgrades objects exported to an .xml file from a previous Informatica release to the current metadata
format. The command then generates an .xml file that contains the upgraded objects.
The command upgrades objects exported from an Informatica 10.1 or later Model repository. Import the .xml
file containing the upgraded objects into a current version Model repository.
The upgrade process is dependent on the Model Repository Service. You must supply the service name of a
Model Repository Service running within the domain when you run the command.
-DomainName domain_name Required. Name of the Informatica domain. You can set
-dn the domain name with the -dn option or the environment
variable INFA_DEFAULT_DOMAIN. If you set a domain
name with both methods, the -dn option takes
precedence.
-Password password Required if you specify the user name. Password for the
-pd user name. The password is case sensitive. You can set
a password with the -pd option or the environment
variable INFA_DEFAULT_DOMAIN_PASSWORD. If you set
a password with both methods, the password set with
the -pd option takes precedence.
-SourceFile source_file Required. Path and file name of the .xml file that
-sf contains the objects to be upgraded. You can specify an
absolute path or a relative path to the file.
-TargetFile target_file Required. Path and file name of the generated .xml file
-tf that contains the upgraded objects. You can specify an
absolute path or a relative path to the file.
UpgradeExportedObjects 839
Option Argument Description
OverwriteFile overwrite_file Optional. You must include this option to overwrite the
-ow target file that has the same name.
• abortAllJobs, 841
• deleteMappingPersistedOutputs, 843
• fetchAggregatedClusterLogs, 845
• getMappingStatus, 847
• getRequestLog, 849
• ListMappingOptions, 851
• listMappingParams, 852
• listMappingPersistedOutputs, 855
• listMappings, 856
• purgeDatabaseWorkTables, 858
• runMapping, 860
• UpdateMappingOptions, 864
• UpdateOptimizationDefaultLevel, 866
• UpdateOptimizationLevel, 868
• upgradeMappingParameterFile, 870
abortAllJobs
Aborts all mapping jobs deployed to the Data Integration Service.
The command affects deployed jobs that are configured to run on the Spark engine. The command affects
jobs in the queue stored in the Model repository that is configured in the Data Integration Service properties.
The command aborts batch jobs that you run from infacmd.
For on-demand jobs, the command aborts jobs on one of the Data Integration Service nodes, and does not
affect other domain nodes.
Note: It is not possible to specify the node on which the command aborts on-demand jobs.
You can use optional flags to apply the command only to queued jobs or running jobs. If you include neither
option, the command affects all jobs.
841
The infacmd ms abortAllJobs command uses the following syntax:
abortAllJobs
<-DomainName|-dn> domain_name
<-ServiceName|-sn> service_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
[<-OnlyQueuedJobs|-q> true|false]
[<-OnlyRunningJobs|-r> true|false]
The following table describes infacmd ms abortAllJobs options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set
-dn the domain name with the -dn option or the environment
variable INFA_DEFAULT_DOMAIN. If you set a domain
name with both methods, the -dn option takes
precedence.
-Password password Required if you specify the user name. Password for the
-pd user name. The password is case sensitive. You can set
a password with the -pd option or the environment
variable INFA_DEFAULT_DOMAIN_PASSWORD. If you set
a password with both methods, the password set with
the -pd option takes precedence.
-OnlyQueuedJobs true | false Optional. Use this option to filter the affected jobs to
-q include only jobs that the Data Integration Service has
queued to run.
-OnlyRunningJobs true | false Optional. Use this option to filter the affected jobs to
-r include only jobs that the Data Integration Service is
running.
deleteMappingPersistedOutputs
Deletes all persisted mapping outputs for a deployed mapping. Specify the outputs to delete using the name
of the application and the run-time instance name of the mapping. To delete specific outputs, use the option -
OutputNamesToDelete.
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-ServiceName|-sn> service_name
<-Application|-a> application_name
<-RuntimeInstanceName|-rin> runtime_instance_name
[<-OutputNamesToDelete|-ontd> output_names_to_delete]
deleteMappingPersistedOutputs 843
The following table describes infacmd ms deleteMappingPersistedOutputs options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set
-dn the domain name with the -dn option or the environment
variable INFA_DEFAULT_DOMAIN. If you set a domain
name with both methods, the -dn option takes
precedence.
-Password password Required if you specify the user name. Password for the
-pd user name. The password is case sensitive. You can set
a password with the -pd option or the environment
variable INFA_DEFAULT_DOMAIN_PASSWORD. If you set
a password with both methods, the password set with
the -pd option takes precedence.
-ServiceName service_name Required. Name of the Data Integration Service that ran
-sn the mapping.
fetchAggregatedClusterLogs
Gets .zip or tar.gz file of the aggregated cluster logs for a mapping based on the job ID and writes the
compressed aggregated log file to a target directory.
<-DomainName|-dn> domain_name
<-ServiceName|-sn> service_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-RequestId|-id> request_id
[<-TargetLogDirectory|-tld> target_log_directory]
[<-ClusterLoginUsername|-clu> cluster_login_username]
[<-ClusterLoginPassword|-clp> cluster_login_password]
[<-CustomProperties|-cp> custom_properties]
fetchAggregatedClusterLogs 845
The following table describes infacmd ms fetchAggregatedClusterLogs options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set the
-dn domain name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with
both methods, the -dn option takes precedence.
-ServiceName service_name Required. Name of the Data Integration Service that ran the
-sn mapping.
-Password password Required if you specify the user name. Password for the
-pd user name. The password is case sensitive. You can set a
password with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password
with both methods, the password set with the -pd option
takes precedence.
-RequestId request_id Required. The job ID for the mapping that you want to write
-id the log file for. Enter the job ID that the infacmd ms
runMapping command returns.
-TargetLogDirectory target_log_directory Optional. The directory to which you want to write the
-tld compressed aggregated log file.
-TargetFilename target filename without Optional. Name and file path of the compressed aggregated
-tf extension log file.
-ClusterLoginPassword cluster_login_password Required if you specify the cluster login user name.
-clp Password to access YARN application. The password is
case sensitive.
getMappingStatus
Gets the current status of a deployed mapping job by job ID. Enter the job ID returned by the infacmd ms
runMapping command.
Note: You must configure the Monitoring Model Repository Service in the Administrator tool before you use
this command.
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
<-ServiceName|-sn> service_name
<-JobId|-ji> job_id
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
The command returns information about a mapping run including job name, job state, and log file path.
If a run-time instance name was passed with the runMapping command, the job name is the run-time
instance name. Otherwise, the job name is one of the following options:
• <mapping name>
• <mapping name>_<parameter set name>
getMappingStatus 847
• <mapping name>_<parameter file name>
-DomainName domain_name Required. Name of the Informatica domain. You can set
-dn the domain name with the -dn option or the environment
variable INFA_DEFAULT_DOMAIN. If you set a domain
name with both methods, the -dn option takes
precedence.
-Password password Required if you specify the user name. Password for the
-pd user name. The password is case sensitive. You can set
a password with the -pd option or the environment
variable INFA_DEFAULT_DOMAIN_PASSWORD. If you set
a password with both methods, the password set with
the -pd option takes precedence.
-ServiceName service_name Required. Name of the Data Integration Service that ran
-sn the mapping.
-JobId job_id Required. The job ID for the mapping that you want to
-jI get the status of. Enter the job ID returned by the
infacmd ms runMapping command.
getRequestLog
Writes the mapping log to the specified file. Enter the job ID returned by the infacmd ms runMapping
command.
<-DomainName|-dn> domain_name
<-ServiceName|-sn> service_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-RequestId|-id> request_id
<-FileName|-f> file_name
The following table describes infacmd ms getRequestLog options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set
-dn the domain name with the -dn option or the environment
variable INFA_DEFAULT_DOMAIN. If you set a domain
name with both methods, the -dn option takes
precedence.
-ServiceName service_name Required. Name of the Data Integration Service that ran
-sn the mapping.
getRequestLog 849
Option Argument Description
-Password password Required if you specify the user name. Password for the
-pd user name. The password is case sensitive. You can set
a password with the -pd option or the environment
variable INFA_DEFAULT_DOMAIN_PASSWORD. If you set
a password with both methods, the password set with
the -pd option takes precedence.
-RequestId request_id Required. The job ID for the mapping that you want to
-id write the log file for. Enter the job ID returned by the
infacmd ms runMapping command.
-FileName file_name Required. Name and file path where you want to write
-f the log file.
<-DomainName|-dn> domain_name
<-ServiceName|-sn> service_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-Application|-a> application_name
<-Mapping|-m> mapping_name
-DomainName domain_name Required. Name of the Informatica domain. You can set
-dn the domain name with the -dn option or the environment
variable INFA_DEFAULT_DOMAIN. If you set a domain
name with both methods, the -dn option takes
precedence.
-Password password Required if you specify the user name. Password for the
-pd user name. The password is case sensitive. You can set
a password with the -pd option or the environment
variable INFA_DEFAULT_DOMAIN_PASSWORD. If you set
a password with both methods, the password set with
the -pd option takes precedence.
ListMappingOptions 851
Option Argument Description
listMappingParams
Lists the parameters for a mapping and creates a mapping parameter file that you can use when you run a
mapping. The command returns an XML file with default values that you can update. Enter the parameter file
name when you run the mapping with infacmd ms runMapping.
<-DomainName|-dn> domain_name
<-ServiceName|-sn> service_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
<-Application|-a> application_name
<-Mapping|-m> mapping_name
-DomainName domain_name Required. Name of the Informatica domain. You can set
-dn the domain name with the -dn option or the environment
variable INFA_DEFAULT_DOMAIN. If you set a domain
name with both methods, the -dn option takes
precedence.
-Password password Required if you specify the user name. Password for the
-pd user name. The password is case sensitive. You can set
a password with the -pd option or the environment
variable INFA_DEFAULT_DOMAIN_PASSWORD. If you set
a password with both methods, the password set with
the -pd option takes precedence.
listMappingParams 853
Option Argument Description
- OutputFile output file_to_write_to Optional. Path and file name of the parameter file to
-o create. If you do not specify a file, the command
displays the parameters in the command prompt.
listMappingParams Output
The listMappingParams command returns a parameter file as an XML file with default values that you can
update.
For example, you run the listMappingParams command on application "MyApp" and mapping "MyMapping."
Mapping "MyMapping" has one parameter "MyParameter." The listMappingParams command returns an XML
file in the following format:
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<root xmlns="http://www.informatica.com/Parameterization/1.0" xmlns:xsi="http://
www.w3.org/2001/XMLSchema">
<!--
<application name="MyApp">
<mapping name="MyMapping">
<!-- Specify deployed application specific parameters here. -->
</mapping>
</application>
-->
<project name="MyProject">
<mapping name="MyMapping">
<parameter name="MyParameter">DefaultValue</parameter>
</mapping>
</project>
</root>
Application element
When you define a parameter within the application top-level element, the Data Integration Service
applies the parameter value when you run the specified mapping in the specified application. You must
include at least one project element within an application/mapping element.
By default, this top-level element is in comments. Remove the comments (!-- and -->) to use this element.
When you define a parameter within a project top-level element, the Data Integration Service applies the
parameter value to the specified mapping in the project in any deployed application. The service also
applies the parameter value to any mapping that uses the objects in the project.
If you define the same parameter in a project and an application top-level element in the same parameter file,
the parameter value defined in the application element takes precedence.
listMappingPersistedOutputs
Lists the persisted mapping outputs for a deployed mapping. The outputs are listed based on the name of the
application and the run-time instance name of the mapping.
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-ServiceName|-sn> service_name
<-Application|-a> application_name
<-RuntimeInstanceName|-rin> runtime_instance_name
-DomainName domain_name Required. Name of the Informatica domain. You can set
-dn the domain name with the -dn option or the environment
variable INFA_DEFAULT_DOMAIN. If you set a domain
name with both methods, the -dn option takes
precedence.
listMappingPersistedOutputs 855
Option Argument Description
-Password password Required if you specify the user name. Password for the
-pd user name. The password is case sensitive. You can set
a password with the -pd option or the environment
variable INFA_DEFAULT_DOMAIN_PASSWORD. If you set
a password with both methods, the password set with
the -pd option takes precedence.
-ServiceName service_name Required. Name of the Data Integration Service that ran
-sn the mapping.
listMappings
Lists the mappings in an application.
<-DomainName|-dn> domain_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-ServiceName|-sn> service_name
<-Application|-a> application_name
-DomainName domain_name Required. Name of the Informatica domain. You can set
-dn the domain name with the -dn option or the environment
variable INFA_DEFAULT_DOMAIN. If you set a domain
name with both methods, the -dn option takes
precedence.
-Password password Required if you specify the user name. Password for the
-pd user name. The password is case sensitive. You can set
a password with the -pd option or the environment
variable INFA_DEFAULT_DOMAIN_PASSWORD. If you set
a password with both methods, the password set with
the -pd option takes precedence.
listMappings 857
Option Argument Description
purgeDatabaseWorkTables
Purges all job information from the queue when you enable data engineering recovery for the Data Integration
Service.
The command purges work queues, certain information about running jobs, and data engineering recovery
information. The command removes rows from database tables of queued and running jobs. Use the
command to remove leftover job information in the Model repository database after you delete the Data
Integration Service that was configured for data engineering recovery.
The command affects jobs in the Model repository that is configured in the Data Integration Service
properties. You can use the -msn option to specify a different Model repository.
You can use the -q option to apply the command only to queued jobs.
You can issue the command only when the Data Integration Service is stopped.
-DomainName domain_name Required. Name of the Informatica domain. You can set
-dn the domain name with the -dn option or the environment
variable INFA_DEFAULT_DOMAIN. If you set a domain
name with both methods, the -dn option takes
precedence.
-Password password Required if you specify the user name. Password for the
-pd user name. The password is case sensitive. You can set
a password with the -pd option or the environment
variable INFA_DEFAULT_DOMAIN_PASSWORD. If you set
a password with both methods, the password set with
the -pd option takes precedence.
purgeDatabaseWorkTables 859
Option Argument Description
-OnlyQueuedJobs true | false Optional. Use this option to filter the results to include
-q only jobs that the Data Integration Service has queued
to run.
runMapping
Runs a mapping that is deployed to a Data Integration Service. You can run the mapping with a parameter set
or a parameter file.
To create a parameter file for a mapping, run infacmd ms listMappingParams. Before you run infacmd ms
listMappingParams, run the infacmd dis startApplication command for the application.
To view the parameters and values for a parameter set, run the command infacmd dis
listParameterSetEntries.
<-DomainName|-dn> domain_name
<-ServiceName|-sn> service_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-Application|-a> application_name
<-Mapping|-m> mapping_name
[<-Wait|-w> true|false]
[<-ParameterFile|-pf> parameter_file_path]
[<-ParameterSet|-ps> parameter_set_name]
[<-OperatingSystemProfile|-osp> operating_system_profile_name]
[<-NodeName|-nn> node_name]
[<-OptimizationLevel|-ol> optimization_level]
[<-PushdownType|-pt> pushdown_type]
[<-CustomProperties|-cp> custom_properties]
[<-RuntimeInstanceName|-rin> runtime_instance_name]
You must enable monitoring to store the run-time instance name. If you purge monitoring statistics, run-time
instance names are deleted and will not be returned by infacmd ms getMappingStatus. The mapping log
might still contain the run-time instance name and the persisted mapping outputs associated with the run-
time instance name can still be used.
-DomainName domain_name Required. Name of the Informatica domain. You can set
-dn the domain name with the -dn option or the environment
variable INFA_DEFAULT_DOMAIN. If you set a domain
name with both methods, the -dn option takes
precedence.
-Password password Required if you specify the user name. Password for the
-pd user name. The password is case sensitive. You can set
a password with the -pd option or the environment
variable INFA_DEFAULT_DOMAIN_PASSWORD. If you set
a password with both methods, the password set with
the -pd option takes precedence.
runMapping 861
Option Argument Description
-ParameterFile parameter_file_path Optional. Name and path of the parameter file. Do not
-pf enter a parameter file and a parameter set.
0 (None)
1 (Minimal)
2 (Normal)
3 (Full)
-PushdownType pushdown_type Optional. Controls the pushdown type that the Data
-pt Integration Service applies to a mapping. Enter one of
the following values:
- None. Select no pushdown type for the mapping.
- Source. The Data Integration Service tries to push
down as much transformation logic as it can to the
source database.
- Full. The Data Integration Service pushes the full
transformation logic to the source database.
This option overrides the pushdown type set in the
mapping run-time properties or in a parameter file or
parameter set.
If you do not use this option, the Data Integration
Service applies the pushdown type set in the mapping
run-time properties or in a parameter file or parameter
set.
runMapping 863
Option Argument Description
UpdateMappingOptions
Updates mapping options in an application.
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-ServiceName|-sn> service_name
<-Application|-a> application_name
<-Mapping|-m> mapping_name
<-Options|-o> options
-DomainName domain_name Required. Name of the Informatica domain. You can set
-dn the domain name with the -dn option or the environment
variable INFA_DEFAULT_DOMAIN. If you set a domain
name with both methods, the -dn option takes
precedence.
-Password password Required if you specify the user name. Password for the
-pd user name. The password is case sensitive. You can set
a password with the -pd option or the environment
variable INFA_DEFAULT_DOMAIN_PASSWORD. If you set
a password with both methods, the password set with
the -pd option takes precedence.
UpdateMappingOptions 865
Option Argument Description
UpdateOptimizationDefaultLevel
Updates the optimization level to -1 (Auto) for all the mappings in an application with optimization level 2
(Normal). Prior to version 10.4.0, Normal was the default optimization level. Auto is the default for all new
mappings. The command does not affect mappings in the application with an optimization level other than
Normal.
<-DomainName|-dn> domain_name
<-ServiceName|-sn> service_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-Application|-a> application_name
-Password password Required if you specify the user name. Password for
-pd the user name. The password is case sensitive. You
can set a password with the -pd option or the
environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a
password with both methods, the password set with
the -pd option takes precedence.
UpdateOptimizationDefaultLevel 867
UpdateOptimizationLevel
Updates optimization level for multiple mappings in an application.
<-DomainName|-dn> domain_name
<-ServiceName|-sn> service_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-Application|-a> application_name
[<-Mapping|-m> mapping_name]
[<-OptimizationLevel|-ol> optimization_level]
-Password password Required if you specify the user name. Password for
-pd the user name. The password is case sensitive. You
can set a password with the -pd option or the
environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a
password with both methods, the password set with
the -pd option takes precedence.
UpdateOptimizationLevel 869
Option Argument Description
0 (None)
1 (Minimal)
2 (Normal)
3 (Full)
upgradeMappingParameterFile
Converts a parameter file you created in a previous Informatica version to a parameter file format that is valid
for Informatica version 10.0.
In Informatica version 10.0, a parameter file can contain mapping parameters and workflow parameters, but
it no longer contains transformation parameters. When you run a mapping or workflow with the previous
version parameter file, the Data Integration Service must convert the parameter file to the Informatica 10.0
version at run time. You can increase performance by converting parameter files to the Informatica 10.0
format.
<-DomainName|-dn> domain_name
<-ServiceName|-sn> service_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-Application|-a> application_name
<-Mapping|-m> mapping_name
<-ParameterFile|-pf> parameter_file_to_upgrade
The following table describes infacmd ms upgradeMappingParameterFile options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set
-dn the domain name with the -dn option or the environment
variable INFA_DEFAULT_DOMAIN. If you set a domain
name with both methods, the -dn option takes
precedence.
-Password password Required if you specify the user name. Password for the
-pd user name. The password is case sensitive. You can set
a password with the -pd option or the environment
variable INFA_DEFAULT_DOMAIN_PASSWORD. If you set
a password with both methods, the password set with
the -pd option takes precedence.
upgradeMappingParameterFile 871
Option Argument Description
- OutputFile output file_to_write_to Optional. Path and file name of the parameter file to
-o create. If you do not specify a file, the command
displays the parameters in the command prompt.
873
Chapter 27
• cancelProfileExecution, 874
• CreateWH, 876
• detectOrphanResults, 877
• DropWH, 879
• Execute, 880
• executeProfile, 882
• getExecutionStatus, 884
• getProfileExecutionStatus, 886
• List, 887
• ListAllProfiles, 889
• migrateProfileResults, 890
• migrateScorecards, 892
• Purge, 893
• purgeOrphanResults, 896
• restoreProfilesAndScorecards, 898
• synchronizeProfile, 899
cancelProfileExecution
Stops all the profile runs including profiles and enterprise discovery profile.
<-DomainName|-dn> domain_name
[<-Gateway|-hp> gateway_name]
[<-NodeName|-nn> node_name]
<-UserName|-un> user_name
<-Password|-pd> password
874
[<-SecurityDomain|-sdn> security_domain]
<-MrsServiceName|-msn> MRS_name
<-DsServiceName|-dsn> data_integration_service_name
<-ObjectPathAndName|-opn> MRS_object_path
The following table describes infacmd ps cancelProfileExecution options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set the
-dn domain name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with both
methods, the -dn option takes precedence.
-NodeName node_name Optional. Name of the node where the Data Integration
-nn Service runs.
-Password password Required if you specify the user name. Password for the user
-pd name. The password is case sensitive. You can set a
password with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password
with both methods, the password set with the -pd option
takes precedence.
cancelProfileExecution 875
Option Argument Description
CreateWH
Creates the content of the profiling warehouse.
<-DomainName|-dn> domain_name
[<-Gateway|-hp>] gateway_name]
<-UserName|-un> user_name
<-Password|-pd> Password
[<-SecurityDomain|-sdn> security_domain]
<-DsServiceName|-dsn> data_integration_service_name
The following table describes infacmd ps CreateWH options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set the
-dn domain name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with both
methods, the -dn option takes precedence.
-Password Password Required if you specify the user name. Password for the user
-pd name. The password is case sensitive. You can set a password
with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password
with both methods, the password set with the -pd option takes
precedence.
detectOrphanResults
Detects profile results in the profiling warehouse that do not have an associated profile in the Model
repository. When you delete a profile before you open it, the Developer tool or the Analyst tool removes the
profile and its metadata from the Model repository. The action results in orphan profile results in the profiling
warehouse. To detect the orphan profile results, you can run the infacmd ps detectOrphanResults command.
To save the command output to a file, run the infacmd ps detectOrphanResults > <filename> command.
<-DomainName|-dn> domain_name
[<-Gateway|-hp> gateway_name]
[<-NodeName|-nn>] node_name
<-UserName|-un> user_name
<-Password|-pd> Password
[<-SecurityDomain|-sdn> security_domain]
<-MrsServiceName|-msn> MRS_name
<-DsServiceName|-dsn> data_integration_service_name
detectOrphanResults 877
The following table describes infacmd ps detectOrphanResults options and arguments:
-Gateway gateway_name Optional if you run the command from the Informatica
-hp installation \bin directory. Required if you run the command
from another location.
The gateway node name.
Use the following syntax:
[Domain_Host]:[HTTP_Port]
-NodeName node_name Required. The name of the node where the Data Integration
-nn Service runs.
-Password Password Required if you specify the user name. Password for the user
-pd name. The password is case sensitive. You can set a password
with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password
with both methods, the password set with the -pd option takes
precedence.
<-DomainName|-dn> domain_name
[<-Gateway|-hp>] gateway_name]
<-UserName|-un> user_name
<-Password|-pd> Password
[<-SecurityDomain|-sdn> security_domain]
<-DsServiceName|-dsn> data_integration_service_name
The following table describes infacmd ps DropWH options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set the
-dn domain name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with both
methods, the -dn option takes precedence.
-Password Password Required if you specify the user name. Password for the user
-pd name. The password is case sensitive. You can set a password
with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password
with both methods, the password set with the -pd option takes
precedence.
DropWH 879
Option Argument Description
Execute
Runs a profile or scorecard.
<-DomainName|-dn> domain_name
[<-NodeName|-nn> node_name]
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
<-MrsServiceName|-msn> MRS_name
<-DsServiceName|-dsn> data_integration_service_name
<-ObjectType|-ot> object_type
<-ObjectPathAndName|-opn> MRS_object_path
[<-ProfileName|-pt> profile_task_name]
[<-wait|-w> true|false]
[<-ospn|-OsProfileName> os_profile_name]
-DomainName domain_name Required. Name of the Informatica domain. You can set the
-dn domain name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with both
methods, the -dn option takes precedence.
-NodeName node_name Optional. Name of the node where the Data Integration
-nn Service runs.
-Password password Required if you specify the user name. Password for the user
-pd name. The password is case sensitive. You can set a
password with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password
with both methods, the password set with the -pd option
takes precedence.
Execute 881
Option Argument Description
-Wait true|false Optional. If true, waits until the command completes before
-w returning the command prompt. If false, returns the
command prompt before the command completes. Default is
false.
-ospn os_profile_name Optional. Name of the operating system profile if the Data
-OsProfileName Integration Service is enabled to use operating system
profiles.
executeProfile
Runs an enterprise discovery profile.
<-DomainName|-dn> domain_name
[<-NodeName|-nn> node_name]
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
<-MrsServiceName|-msn> MRS_name
<-DsServiceName|-dsn> data_integration_service_name
<-ObjectPathAndName|-opn> MRS_object_path
[<-WaitForModelExecToFinish|-w> true|false]
[<-ospn|-OsProfileName> os_profile_name]
-DomainName domain_name Required. Name of the Informatica domain. You can set the
-dn domain name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with both
methods, the -dn option takes precedence.
-NodeName node_name Optional. Name of the node where the Data Integration
-nn Service runs.
-Password password Required if you specify the user name. Password for the user
-pd name. The password is case sensitive. You can set a
password with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password
with both methods, the password set with the -pd option
takes precedence.
executeProfile 883
Option Argument Description
-WaitForModelExecToFinish true|false Optional. If true, waits until the command completes before
-w returning the command prompt. If false, returns the
command prompt before the command completes. Default is
false.
-ospn os_profile_name Optional. Name of the operating system profile if the Data
-OsProfileName Integration Service is enabled to use operating system
profiles.
getExecutionStatus
Gets the run-time status of profile tasks in an enterprise discovery profile.
<-DomainName|-dn> domain_name
[<-Gateway|-hp> gateway_name]
[<-NodeName|-nn> node_name]
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
<-MrsServiceName|-msn> MRS_name
<-DsServiceName|-dsn> data_integration_service_name
<-ObjectType|-ot> object_type
<-ObjectPathAndName|-opn> MRS_object_path
<-ProfileTaskName|-pt> profile_task_name
The following table describes infacmd ps getExecutionStatus options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set the
-dn domain name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with both
methods, the -dn option takes precedence.
-NodeName node_name Optional. Name of the node where the Data Integration
-nn Service runs.
-Password password Required if you specify the user name. Password for the user
-pd name. The password is case sensitive. You can set a
password with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password
with both methods, the password set with the -pd option
takes precedence.
getExecutionStatus 885
getProfileExecutionStatus
Gets the run-time status of an enterprise discovery profile. The command also lists all the profile tasks in the
enterprise discovery profile and their run-time statuses.
<-DomainName|-dn> domain_name
[<-Gateway|-hp> gateway_name]
[<-NodeName|-nn> node_name]
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
<-MrsServiceName|-msn> MRS_name
<-DsServiceName|-dsn> data_integration_service_name
<-ObjectPathAndName|-opn> MRS_object_path
The following table describes infacmd ps getProfileExecutionStatus options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set the
-dn domain name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with both
methods, the -dn option takes precedence.
-NodeName node_name Optional. Name of the node where the Data Integration
-nn Service runs.
-Password password Required if you specify the user name. Password for the user
-pd name. The password is case sensitive. You can set a
password with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password
with both methods, the password set with the -pd option
takes precedence.
List
Lists profiles or scorecards.
<-DomainName|-dn> domain_name
[<-Gateway|-hp> gateway_name]
[<-NodeName|-nn>] node_name
<-MrsServiceName|-msn> MRS_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
<-ObjectType|-ot>
<-FolderPath|-fp> full_folder_path
[<-Recursive|-r>]
List 887
The following table describes infacmd ps List options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set the
-dn domain name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with both
methods, the -dn option takes precedence.
-NodeName node_name Optional. Name of the node where the Data Integration Service
-nn runs.
-Password password Required if you specify the user name. Password for the user
-pd name. The password is case sensitive. You can set a password
with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password
with both methods, the password set with the -pd option takes
precedence.
-FolderPath full_folder_path Required. Enter the path of the folder that contains the objects
-fp you want to list.
Use the following syntax:
Project_name/folder_name/../SubFolderName
-Recursive - Optional. Applies the command to objects in the folder that you
-r specify and its subfolders.
ListAllProfiles
Lists all the profiles in an enterprise discovery profile.
<-DomainName|-dn> domain_name
[<-Gateway|-hp> gateway_name]
[<-NodeName|-nn>] node_name
<-MrsServiceName|-msn> MRS_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
<-ProfilePathAndName|-pn>
-DomainName domain_name Required. Name of the Informatica domain. You can set the
-dn domain name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with both
methods, the -dn option takes precedence.
-NodeName node_name Optional. Name of the node where the Data Integration Service
-nn runs.
ListAllProfiles 889
Option Argument Description
-Password password Required if you specify the user name. Password for the user
-pd name. The password is case sensitive. You can set a password
with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password
with both methods, the password set with the -pd option takes
precedence.
-ProfilePathAndName profile_path_and Required. Enter the path to the enterprise discovery profile and
-pn _name its name.
migrateProfileResults
Migrates column profile results and data domain discovery results from version 9.1.0, 9.5.0, or 9.5.1.
<-DomainName|-dn> domain_name
[<-Gateway|-hp> gateway_name]
[<-NodeName|-nn> node_name]
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
<-MrsServiceName|-msn> MRS_name
<-DsServiceName|-dsn> data_integration_service_name
-DomainName domain_name Required. Name of the Informatica domain. You can set the
-dn domain name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with both
methods, the -dn option takes precedence.
-NodeName node_name Optional. Name of the node where the Data Integration
-nn Service runs.
-Password password Required if you specify the user name. Password for the user
-pd name. The password is case sensitive. You can set a
password with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password
with both methods, the password set with the -pd option
takes precedence.
migrateProfileResults 891
migrateScorecards
Migrates scorecard results from Informatica 9.1.0 or 9.5.0 to 9.5.1.
<-DomainName|-dn> domain_name
[<-Gateway|-hp> gateway_name]
[<-NodeName|-nn> node_name]
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
<-MrsServiceName|-msn> MRS_name
<-DsServiceName|-dsn> data_integration_service_name
<-migrateFrom|-mfr> migrate_from_release
-DomainName domain_name Required. Name of the Informatica domain. You can set the
-dn domain name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with both
methods, the -dn option takes precedence.
-NodeName node_name Optional. Name of the node where the Data Integration
-nn Service runs.
-Password password Required if you specify the user name. Password for the user
-pd name. The password is case sensitive. You can set a
password with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password
with both methods, the password set with the -pd option
takes precedence.
Purge
Purges profile and scorecard results from the profiling warehouse. The infacmd ps Purge command purges
all the profile and scorecard results except for the results from the latest profile or scorecard run.
<-DomainName|-dn> domain_name
[<-Gateway|-hp> gateway_name]
[<-NodeName|-nn>] node_name
<-UserName|-un> user_name
<-Password|-pd> Password
[<-SecurityDomain|-sdn> security_domain]
<-MrsServiceName|-msn> MRS_name
<-DsServiceName|-dsn> data_integration_service_name
<-ObjectType|-ot> object_type
<-ObjectPathAndName|-opn> MRS_object_path
Purge 893
[<-RetainDays|-rd> results_retain_days]
[<-ProjectFolderPath|-pf> project_folder_path]
[<-ProfileName|-pt> profile_task_name]
[<-Recursive|-r> recursive]
[<-PurgeAllResults|-pa> purge_all_results]
The following table describes infacmd ps Purge options and arguments:
-Gateway gateway_name Optional if you run the command from the Informatica
-hp installation \bin directory. Required if you run the command
from another location.
The gateway node name.
Use the following syntax:
[Domain_Host]:[HTTP_Port]
-NodeName node_name Required. The name of the node where the Data Integration
-nn Service runs.
-Password Password Required if you specify the user name. Password for the user
-pd name. The password is case sensitive. You can set a password
with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password
with both methods, the password set with the -pd option takes
precedence.
-RetainDays results_retain_ Optional. Specifies the time range for the profile and scorecard
-rd days results to be eligible for retention in the profiling warehouse.
The Data Integration Service purges the rest of the profile and
scorecard results.
For example, if you enter -rd 10, then the results from the
current day and past nine days are retained and the rest of the
results are purged from the profiling warehouse.
-ProfileName profile_task_na Optional. The name of the profile task that you want to purge. If
-pt * me a folder has only one profile, then you can use only the
ProjectFolderPath option because the ProjectFolderPath
includes the name of the profile that contains the profile task.
If a folder has multiple profiles in a folder, then use the
ProfileName option along with the ProjectFolderPath option to
specify the profile name.
Purge 895
Option Argument Description
-PurgeAllResults purge_all_resul Optional. Set this option to purge all results for the profile or
-pa ts scorecard object.
Use with the -recursive option to apply the command to profile
and scorecard results in the folder that you specify and its
subfolders.
purgeOrphanResults
Purges the orphan profile results from the profiling warehouse. You can run this command after you run the
infacmd ps detectOrphanResults command to detect the orphan profile results.
<-DomainName|-dn> domain_name
[<-Gateway|-hp> gateway_name]
[<-NodeName|-nn>] node_name
<-UserName|-un> user_name
<-Password|-pd> Password
[<-SecurityDomain|-sdn> security_domain]
<-MrsServiceName|-msn> MRS_name
<-DsServiceName|-dsn> data_integration_service_name
<-filePathName|-fpn> filePathName
-Gateway gateway_name Optional if you run the command from the Informatica
-hp installation \bin directory. Required if you run the command
from another location.
The gateway node name.
Use the following syntax:
[Domain_Host]:[HTTP_Port]
-NodeName node_name Required. The name of the node where the Data Integration
-nn Service runs.
-Password Password Required if you specify the user name. Password for the user
-pd name. The password is case sensitive. You can set a password
with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password
with both methods, the password set with the -pd option takes
precedence.
purgeOrphanResults 897
Option Argument Description
-filePathName filePathName Required. The file path with the name of the file that contains a
-fpn list of profile IDs. The profile IDs map to the orphan profile
results that need to be purged.
restoreProfilesAndScorecards
Restores profiles and scorecards from a previous version to the current version.
Sometimes, after you upgrade and drill down on the existing profile results or scorecard results, rule columns
might not appear in the drilldown results. To include rule columns in the results, run the infacmd ps
restoreProfilesAndScorecards command. Make sure that you create a backup of the Model repository
content before you run the command.
<-DomainName|-dn> domain_name
[<-Gateway|-hp> gateway_name]
[<-NodeName|-nn>] node_name
<-UserName|-un> user_name
<-Password|-pd> Password
[<-SecurityDomain|-sdn> security_domain]
<-MrsServiceName|-msn> MRS_name
<-DsServiceName|-dsn> data_integration_service_name
The following table describes infacmd ps restoreProfilesAndScorecards options and arguments:
-Gateway gateway_name Optional if you run the command from the Informatica
-hp installation \bin directory. Required if you run the command
from another location.
The gateway node name.
Use the following syntax:
[Domain_Host]:[HTTP_Port]
-NodeName node_name Required. The name of the node where the Data Integration
-nn Service runs.
-Password Password Required if you specify the user name. Password for the user
-pd name. The password is case sensitive. You can set a password
with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password
with both methods, the password set with the -pd option takes
precedence.
synchronizeProfile
Migrates documented, user-defined, and committed primary keys and foreign keys for all the profiles in a
project from version 9.1.0, 9.5.0, or 9.5.1.
<-DomainName|-dn> domain_name
[<-Gateway|-hp> gateway_name]
synchronizeProfile 899
[<-NodeName|-nn> node_name]
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
<-MrsServiceName|-msn> MRS_name
<-DsServiceName|-dsn> data_integration_service_name
<-ProjectName|-pn> project_name
The following table describes infacmd ps synchronizeProfile options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set the
-dn domain name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with both
methods, the -dn option takes precedence.
-NodeName node_name Optional. Name of the node where the Data Integration
-nn Service runs.
-Password password Required if you specify the user name. Password for the user
-pd name. The password is case sensitive. You can set a
password with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password
with both methods, the password set with the -pd option
takes precedence.
synchronizeProfile 901
Chapter 28
• CloseForceListener, 903
• CloseListener, 905
• CondenseLogger, 907
• createdatamaps, 909
• CreateListenerService, 912
• CreateLoggerService, 914
• DisplayAllLogger, 919
• DisplayCPULogger, 921
• DisplayEventsLogger, 924
• DisplayMemoryLogger, 926
• DisplayRecordsLogger, 928
• displayStatsListener, 931
• DisplayStatusLogger, 934
• FileSwitchLogger, 937
• ListTaskListener, 939
• ShutDownLogger, 941
• StopTaskListener, 944
• UpgradeModels, 946
• UpdateListenerService, 948
• UpdateLoggerService, 951
902
CloseForceListener
Forces the cancellation of long-running subtasks on the PowerExchange Listener Service and stops the
Listener Service.
When you issue the infacmd pwx CloseForceListener command, PowerExchange completes the following
actions:
[<-DomainName|-dn> domain_name]
[<-UserName|-un> user_name]
[<-Password|-pd> password]
<-ServiceName|-sn> service_name
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
[<-SecurityDomain|-sdn> security_domain]
[<-OSUser|-oun> OS_user_name]
[<-OSPassword|-oup> OS_password]
[<-OSEPassword|-ouep> OS_epassword]
The following table describes infacmd pwx CloseForceListener options and arguments:
-DomainName domain_name Name of the Informatica domain. You can set the domain
-dn name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with both
methods, the -dn option takes precedence.
CloseForceListener 903
Option Argument Description
-Password password Required if you specify the user name. Password for the user
-pd name. The password is case sensitive. You can set a
password with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password
with both methods, the password set with the -pd option
takes precedence.
-OSUser OS_user_name Required if you enable operating system security. User name
-oun for the operating system.
Enable operating system security as follows:
- To require users to enter a valid operating system user ID
and password on the command, specify 1 or 2 for the first
parameter of the SECURITY statement in the DBMOVER
configuration file on each Linux, UNIX, or Windows system
that is the target of the command. PowerExchange uses
operating system facilities on the target system to
authenticate the user ID and password for use of the
infacmd pwx program.
- To authorize users to run specific infacmd pwx
commands, specify 2 for the first parameter of the
SECURITY statement and define AUTHGROUP and USER
statements in the PowerExchange sign-on file on each
Linux, UNIX, or Windows system that is the target of the
command. PowerExchange checks the sign-on file to
determine whether to allow the user ID supplied on the
infacmd pwx program to run commands.
For more information, see the PowerExchange Reference
Manual.
-OSPassword OS_password Required if you specify a user name and do not specify an
-oup encrypted password. Password for the operating system.
You can set a plain text password with the -p option or the
environment variable INFA_DEFAULT_PWX_OSPASSWORD. If
you set a password with both methods, the password set
with the -p option takes precedence.
-OSEPassword OS_epassword Required if you specify a user name and do not specify a
-ouep plain text password. Encrypted password for the operating
system.
You can set an encrypted password with the -e option or the
environment variable INFA_DEFAULT_PWX_OSEPASSWORD.
If you set a password with both methods, the password set
with the -e option takes precedence.
CloseListener
Stops the PowerExchange Listener Service after waiting for all outstanding subtasks on the Listener Service
to complete.
Note: If you have long-running subtasks on the Listener Service, issue the infacmd pwx closeforceListener
command instead to force the cancellation of all user subtasks and stop the Listener Service.
[<-DomainName|-dn> domain_name]
[<-UserName|-un> user_name]
[<-Password|-pd> password]
<-ServiceName|-sn> service_name
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
[<-SecurityDomain|-sdn> security_domain]
[<-OSUser|-oun> OS_user_name]
[<-OSPassword|-oup> OS_password]
[<-OSEPassword|-ouep> OS_epassword]
CloseListener 905
The following table describes infacmd pwx CloseListener options and arguments:
-DomainName domain_name Name of the Informatica domain. You can set the domain
-dn name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with
both methods, the -dn option takes precedence.
-Password password Required if you specify the user name. Password for the
-pd user name. The password is case sensitive. You can set a
password with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password
with both methods, the password set with the -pd option
takes precedence.
-OSPassword OS_password Required if you specify a user name and do not specify an
-oup encrypted password. Password for the operating system.
You can set a plain text password with the -p option or the
environment variable INFA_DEFAULT_PWX_OSPASSWORD.
If you set a password with both methods, the password set
with the -p option takes precedence.
-OSEPassword OS_epassword Required if you specify a user name and do not specify a
-ouep plain text password. Encrypted password for the operating
system.
You can set an encrypted password with the -e option or the
environment variable INFA_DEFAULT_PWX_OSEPASSWORD.
If you set a password with both methods, the password set
with the -e option takes precedence.
CondenseLogger
Starts another logging cycle before the wait period for starting another cycle has elapsed when the
PowerExchange Logger Service is running in continuous mode. Specify the wait period in the NO_DATA_WAIT
parameter of the pwxccl.cfg configuration file.
[<-DomainName|-dn> domain_name]
[<-UserName|-un> user_name]
[<-Password|-pd> password]
<-ServiceName|-sn> service_name
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
CondenseLogger 907
[<-SecurityDomain|-sdn> security_domain]
[<-OSUser|-oun> OS_user_name]
[<-OSPassword|-oup> OS_password]
[<-OSEPassword|-ouep> OS_epassword]
The following table describes infacmd pwx CondenseLogger options and arguments:
-DomainName domain_name Name of the Informatica domain. You can set the domain
-dn name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with
both methods, the -dn option takes precedence.
-Password password Required if you specify the user name. Password for the
-pd user name. The password is case sensitive. You can set a
password with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password
with both methods, the password set with the -pd option
takes precedence.
-OSUser OS_user_name Required if you enable operating system security. User name
-oun for the operating system.
Enable operating system security as follows:
- To require users to enter a valid operating system user ID
and password on the command, specify 1 or 2 for the first
parameter of the SECURITY statement in the DBMOVER
configuration file on each Linux, UNIX, or Windows system
that is the target of the command. PowerExchange uses
operating system facilities on the target system to
authenticate the user ID and password for use of the
infacmd pwx program.
- To authorize users to run specific infacmd pwx
commands, specify 2 for the first parameter of the
SECURITY statement and define AUTHGROUP and USER
statements in the PowerExchange sign-on file on each
Linux, UNIX, or Windows system that is the target of the
command. PowerExchange checks the sign-on file to
determine whether to allow the user ID supplied on the
infacmd pwx program to run commands.
-OSPassword OS_password Required if you specify a user name and do not specify an
-oup encrypted password. Password for the operating system.
You can set a plain text password with the -p option or the
environment variable INFA_DEFAULT_PWX_OSPASSWORD. If
you set a password with both methods, the password set
with the -p option takes precedence.
-OSEPassword OS_epassword Required if you specify a user name and do not specify a
-ouep plain text password. Encrypted password for the operating
system.
You can set an encrypted password with the -e option or the
environment variable INFA_DEFAULT_PWX_OSEPASSWORD.
If you set a password with both methods, the password set
with the -e option takes precedence.
createdatamaps
Creates data maps for bulk data movement operations.
Use the createdatamaps command to generate data maps for IMS, SEQ, and VSAM data sources from the
command line. This command provides an alternative to using the PowerExchange Navigator in certain cases
and allows you to generate or regenerate data maps noninteractively.
If the command fails with a Java memory error, increase the system memory available for infacmd. To
increase the system memory, set the -Xmx value in the ICMD_JAVA_OPTS environment variable. For more
information, see “ICMD_JAVA_OPTS” on page 43.
createdatamaps 909
The infacmd pwx createdatamaps command uses the following syntax:
createdatamaps
[<-pwxLocation|-loc> pwx_location]
[<-pwxUserName|-pun> pwx_user_name]
[<-pwxPassword|-ppd> pwx_password]
[<-pwxEncryptedPassword|-epwd> pwx_encrypted_password]
[<-datamapOutputDir|-dod> datamap_output_directory]
[<-replace|-r> replace_existing_datamaps
<-controlFile|-cf> file_path_for_control_file
[<-logFile|-lf> file_path_for_log_file]
[<-verbosity|-v> logging_verbosity]
The following table describes infacmd pwx createdatamaps options and arguments:
-datamapOutputDir datamap_output_directory Optional. The local file directory to which to write the output
-dod data maps. Default is the current working directory.
createdatamaps 911
Option Argument Description
-controlFile file_path_for_control_file Required. Path and file name of the control file that controls
-cf data map generation.
-logFile file_path_for_log_file Optional. Path and file name of the output log file. Default is
-lf STDOUT.
-verbosity logging_verbosity Optional. Verbosity for log files. Default is INFO. Valid
-v values:
- DEBUG. Most detailed logging. Might show stack traces.
- INFO. Informational messages.
- WARN. Indicates a potential problem.
- ERROR. Indicates a failure. Processing continues.
- FATAL. Indicates a fatal condition. Process terminates.
The PowerExchange node name and credentials are optional. If you do not include the pwxLocation option,
the command accesses the local file system directly to read metadata. In this case, PowerExchange does not
need to be installed on the machine on which you run createdatamaps.
For more information about the createdatamaps command, see the PowerExchange Utilities Guide.
CreateListenerService
Creates a PowerExchange Listener Service in a domain. By default, the Listener Service is disabled when you
create it. Run the infacmd isp EnableService command to enable the service.
[<-DomainName|-dn> domain_name]
[<-UserName|-un> user_name]
[<-Password|-pd> password]
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-ServiceName|-sn> service_name
<-NodeName|-nn> node_name
[<-LicenseName|-ln> license_name]
[<-BackupNode|-bn> backup_node]
<-StartParameters|-sp> start_parameters
<-SvcPort|-sp> service_port
-DomainName domain_name Name of the Informatica domain. You can set the domain name
-dn with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with both
methods, the -dn option takes precedence.
-UserName user_name Required if the domain uses Native or LDAP authentication. User
-un name to connect to the domain. You can set the user name with
the -un option or the environment variable
INFA_DEFAULT_DOMAIN_USER. If you set a user name with both
methods, the -un option takes precedence.
Optional if the domain uses Kerberos authentication. To run the
command with single sign-on, do not set the user name. If you
set the user name, the command runs without single sign-on.
-Password password Required if you specify the user name. Password for the user
-pd name. The password is case sensitive. You can set a password
with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password with
both methods, the password set with the -pd option takes
precedence.
-SecurityDomain security_domain Required if the domain uses LDAP authentication. Optional if the
-sdn domain uses native authentication or Kerberos authentication.
Name of the security domain to which the domain user belongs.
You can set a security domain with the -sdn option or the
environment variable INFA_DEFAULT_SECURITY_DOMAIN. If you
set a security domain name with both methods, the -sdn option
takes precedence. The security domain name is case sensitive.
If the domain uses native or LDAP authentication, the default is
Native. If the domain uses Kerberos authentication, the default is
the LDAP security domain created during installation. The name
of the security domain is the same as the user realm specified
during installation.
-Gateway gateway_host1:port Required if -DomainName is not specified. The host names and
-hp gateway_host2:port ... port numbers for the gateway nodes in the domain.
-NodeName node_name Required. Name of the node where you want the Listener Service
-nn to run.
CreateListenerService 913
Option Argument Description
-LicenseName license_name Optional. License to assign to the service. If you do not select a
-ln license now, you can assign a license to the service later.
Required before you can enable the service.
-StartParameters start_parameters Parameters to include when you start the Listener Service.
-sp Separate the parameters with the space character.
The node_name parameter is required.
You can include the following parameters:
- node_name
Required. Node name that identifies the Listener Service. This
name must match the name in the LISTENER statement in the
DBMOVER configuration file.
- config=directory
Optional. Specifies the full path and file name for any
dbmover.cfg configuration file that you want to use instead of
the default dbmover.cfg file. This alternative configuration file
takes precedence over any alternative configuration file that
you specify in the PWX_CONFIG environment variable.
- license=directory/license_key_file
Optional. Specifies the full path and file name for any license
key file that you want to use instead of the default license.key
file. The alternative license key file must have a file name or
path that is different from that of the default file. This
alternative license key file takes precedence over any
alternative license key file that you specify in the
PWX_LICENSE environment variable.
Note: In the config and license parameters, you must provide the
full path only if the file does not reside in the installation
directory. Include quotes around any path and file name that
contains spaces.
-SvcPort service_port Required. Port on which the Listener Service listens for
-sp commands from the Service Manager.
CreateLoggerService
Creates a PowerExchange Logger Service in a domain. By default, the Logger Service is disabled when you
create it. Run the infacmd isp EnableService command to enable the service.
[<-DomainName|-dn> domain_name]
[<-UserName|-un> user_name]
[<-Password|-pd> password]
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-ServiceName|-sn> service_name
<-NodeName|-nn> node_name
[<-LicenseName|-ln> license_name]
[<-BackupNode|-bn> backup_node]
[<-StartParameters|-sp> start_parameters>]
<-SvcPort|-sp> service_port
The following table describes infacmd pwx CreateLoggerService options and arguments:
-DomainName domain_name Name of the Informatica domain. You can set the domain
-dn name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with both
methods, the -dn option takes precedence.
-Password password Required if you specify the user name. Password for the user
-pd name. The password is case sensitive. You can set a
password with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password
with both methods, the password set with the -pd option takes
precedence.
CreateLoggerService 915
Option Argument Description
-NodeName node_name Required. Name of the node where you want the Logger
-nn Service to run.
-LicenseName license_name Optional. License to assign to the service. If you do not select
-ln a license now, you can assign a license to the service later.
Required before you can enable the service.
-StartParameters start_parameters Optional. Parameters to include when you start the Logger
-sp Service. Separate the parameters with the space character.
You can include the following parameters:
- coldstart={Y|N}
Indicates whether to cold start or warm start the Logger
Service. Enter Y to cold start the Logger Service. If the
CDCT file contains log records, the Logger Service deletes
these records. Enter N to warm start the Logger Service
from the restart point that is indicated in the CDCT file.
Default is N.
- config=directory/pwx_config_file
Specifies the full path and file name for any dbmover.cfg
configuration file that you want to use instead of the
default dbmover.cfg file. This alternative configuration file
takes precedence over any alternative configuration file
that you specify in the PWX_CONFIG environment variable.
- cs=directory/pwxlogger_config_file
Specifies the path and file name for the Logger Service
configuration file. You can also use the cs parameter to
specify a Logger Service configuration file that overrides
the default pwxccl.cfg file. The override file must have a
path or file name that is different from that of the default
file.
- encryptepwd=encrypted_password
A password in encrypted format for enabling the encryption
of PowerExchange Logger log files. With this password, the
PowerExchange Logger can generate a unique encryption
key for each Logger log file. The password is stored in the
CDCT file in encrypted format. For security purposes, the
password is not stored in CDCT backup files and is not
displayed in the CDCT reports that you can generate with
the PowerExchange PWXUCDCT utility.
If you specify this parameter, you must also specify
coldstart=Y.
If you specify this parameter and also specify the
ENCRYPTEPWD parameter in the PowerExchange Logger
configuration file, pwxccl.cfg, the parameter in the
configuration file takes precedence. If you specify this
parameter and also specify the ENCRYPTPWD parameter in
the PowerExchange Logger configuration file, an error
occurs.
You can set the AES algorithm to use for log file encryption
in the ENCRYPTOPT parameter of the pwxccl.cfg file. The
default is AES128.
Tip: For optimal security, Informatica recommends that you
specify the encryption password when cold starting the
PowerExchange Logger rather than in the pwxccl.cfg
configuration file. This practice can reduce the risk of
malicious access to the encryption password for the
following reasons: 1) The encryption password is not
stored in the pwxccl.cfg file, and 2) You can remove the
password from the command line after a successful cold
start. If you specify the encryption password for a cold
start and then need to restore the CDCT file later, you must
CreateLoggerService 917
Option Argument Description
Note: In the config, cs, and license parameters, the full path is
required only if the file does not reside in the installation
directory. Include quotes around any path and file name that
contains spaces.
-SvcPort service_port Optional. Port on which the Logger Service listens for
-sp commands from the Service Manager.
DisplayAllLogger
Displays all messages that can be produced by the other PowerExchange Logger Service display commands,
arranged by command.
The infacmd pwx DisplayAllLogger command displays the consolidated output for the following commands:
• DisplayCPULogger
• DisplayEventsLogger
• DisplayMemoryLogger
• DisplayRecordsLogger
• DisplayStatusLogger
[<-DomainName|-dn> domain_name]
[<-UserName|-un> user_name]
[<-Password|-pd> password]
<-ServiceName|-sn> service_name
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
[<-SecurityDomain|-sdn> security_domain]
[<-OSUser|-oun> OS_user_name]
[<-OSPassword|-oup> OS_password]
[<-OSEPassword|-ouep> OS_epassword]
DisplayAllLogger 919
The following table describes infacmd pwx DisplayAllLogger options and arguments:
-DomainName domain_name Name of the Informatica domain. You can set the domain
-dn name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with
both methods, the -dn option takes precedence.
-Password password Required if you specify the user name. Password for the user
-pd name. The password is case sensitive. You can set a
password with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password
with both methods, the password set with the -pd option
takes precedence.
-OSUser OS_user_name Required if you enable operating system security. User name
-oun for the operating system.
Enable operating system security as follows:
- To require users to enter a valid operating system user ID
and password on the command, specify 1 or 2 for the first
parameter of the SECURITY statement in the DBMOVER
configuration file on each Linux, UNIX, or Windows system
that is the target of the command. PowerExchange uses
operating system facilities on the target system to
authenticate the user ID and password for use of the
infacmd pwx program.
- To authorize users to run specific infacmd pwx
commands, specify 2 for the first parameter of the
SECURITY statement and define AUTHGROUP and USER
statements in the PowerExchange sign-on file on each
Linux, UNIX, or Windows system that is the target of the
command. PowerExchange checks the sign-on file to
determine whether to allow the user ID supplied on the
infacmd pwx program to run commands.
-OSPassword OS_password Required if you specify a user name and do not specify an
-oup encrypted password. Password for the operating system.
You can set a plain text password with the -p option or the
environment variable INFA_DEFAULT_PWX_OSPASSWORD. If
you set a password with both methods, the password set
with the -p option takes precedence.
-OSEPassword OS_epassword Required if you specify a user name and do not specify a
-ouep plain text password. Encrypted password for the operating
system.
You can set an encrypted password with the -e option or the
environment variable INFA_DEFAULT_PWX_OSEPASSWORD.
If you set a password with both methods, the password set
with the -e option takes precedence.
DisplayCPULogger
Displays the amount of CPU time, in microseconds, that the PowerExchange Logger Service spends for each
phase of processing during the current logging cycle. Also includes the total CPU time for all Logger Service
processing.
For example, the infacmd pwx DisplayCPULogger command might report the amount of CPU time that the
Logger Service spent to complete the following actions:
DisplayCPULogger 921
The infacmd pwx DisplayCPULogger command uses the following syntax:
DisplayCPULogger
[<-DomainName|-dn> domain_name]
[<-UserName|-un> user_name]
[<-Password|-pd> password]
<-ServiceName|-sn> service_name
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
[<-SecurityDomain|-sdn> security_domain]
[<-OSUser|-oun> OS_user_name]
[<-OSPassword|-oup> OS_password]
[<-OSEPassword|-ouep> OS_epassword]
The following table describes infacmd pwx DisplayCPULogger options and arguments:
-DomainName domain_name Name of the Informatica domain. You can set the domain
-dn name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with
both methods, the -dn option takes precedence.
-Password password Required if you specify the user name. Password for the user
-pd name. The password is case sensitive. You can set a
password with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password
with both methods, the password set with the -pd option
takes precedence.
-OSUser OS_user_name Required if you enable operating system security. User name
-oun for the operating system.
Enable operating system security as follows:
- To require users to enter a valid operating system user ID
and password on the command, specify 1 or 2 for the first
parameter of the SECURITY statement in the DBMOVER
configuration file on each Linux, UNIX, or Windows system
that is the target of the command. PowerExchange uses
operating system facilities on the target system to
authenticate the user ID and password for use of the
infacmd pwx program.
- To authorize users to run specific infacmd pwx
commands, specify 2 for the first parameter of the
SECURITY statement and define AUTHGROUP and USER
statements in the PowerExchange sign-on file on each
Linux, UNIX, or Windows system that is the target of the
command. PowerExchange checks the sign-on file to
determine whether to allow the user ID supplied on the
infacmd pwx program to run commands.
-OSPassword OS_password Required if you specify a user name and do not specify an
-oup encrypted password. Password for the operating system.
You can set a plain text password with the -p option or the
environment variable INFA_DEFAULT_PWX_OSPASSWORD. If
you set a password with both methods, the password set
with the -p option takes precedence.
-OSEPassword OS_epassword Required if you specify a user name and do not specify a
-ouep plain text password. Encrypted password for the operating
system.
You can set an encrypted password with the -e option or the
environment variable INFA_DEFAULT_PWX_OSEPASSWORD.
If you set a password with both methods, the password set
with the -e option takes precedence.
DisplayCPULogger 923
DisplayEventsLogger
Displays events that the Controller, Command Handler, and Writer tasks for the PowerExchange Logger
Service are waiting on. Also indicates if the Writer is processing data or is in a sleep state waiting for an
event or timeout to occur.
[<-DomainName|-dn> domain_name]
[<-UserName|-un> user_name]
[<-Password|-pd> password]
<-ServiceName|-sn> service_name
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
[<-SecurityDomain|-sdn> security_domain]
[<-OSUser|-oun> OS_user_name]
[<-OSPassword|-oup> OS_password]
[<-OSEPassword|-ouep> OS_epassword]
The following table describes infacmd pwx DisplayEventsLogger options and arguments:
-DomainName domain_name Name of the Informatica domain. You can set the domain
-dn name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with
both methods, the -dn option takes precedence.
-Password password Required if you specify the user name. Password for the
-pd user name. The password is case sensitive. You can set a
password with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password
with both methods, the password set with the -pd option
takes precedence.
DisplayEventsLogger 925
Option Argument Description
-OSPassword OS_password Required if you specify a user name and do not specify an
-oup encrypted password. Password for the operating system.
You can set a plain text password with the -p option or the
environment variable INFA_DEFAULT_PWX_OSPASSWORD.
If you set a password with both methods, the password set
with the -p option takes precedence.
-OSEPassword OS_epassword Required if you specify a user name and do not specify a
-ouep plain text password. Encrypted password for the operating
system.
You can set an encrypted password with the -e option or the
environment variable INFA_DEFAULT_PWX_OSEPASSWORD.
If you set a password with both methods, the password set
with the -e option takes precedence.
DisplayMemoryLogger
Displays memory use, in bytes, for each PowerExchange Logger Service task and subtask, with totals for the
entire Logger Service process.
• Application. Memory that the Logger Service application requested for its own use.
• Total. Total memory in use for the Logger Service application and for related header overhead. This value
fluctuates as PowerExchange allocates and frees memory during Logger Service processing.
• Maximum. The largest memory amount that has been recorded for the Total category up to the point in
time when this command runs.
[<-DomainName|-dn> domain_name]
[<-UserName|-un> user_name]
[<-Password|-pd> password]
<-ServiceName|-sn> service_name
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
[<-SecurityDomain|-sdn> security_domain]
[<-OSUser|-oun> OS_user_name]
[<-OSPassword|-oup> OS_password]
[<-OSEPassword|-ouep> OS_epassword]
-DomainName domain_name Name of the Informatica domain. You can set the domain
-dn name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with
both methods, the -dn option takes precedence.
-Password password Required if you specify the user name. Password for the
-pd user name. The password is case sensitive. You can set a
password with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password
with both methods, the password set with the -pd option
takes precedence.
DisplayMemoryLogger 927
Option Argument Description
-OSPassword OS_password Required if you specify a user name and do not specify an
-oup encrypted password. Password for the operating system.
You can set a plain text password with the -p option or the
environment variable INFA_DEFAULT_PWX_OSPASSWORD.
If you set a password with both methods, the password set
with the -p option takes precedence.
-OSEPassword OS_epassword Required if you specify a user name and do not specify a
-ouep plain text password. Encrypted password for the operating
system.
You can set an encrypted password with the -e option or the
environment variable INFA_DEFAULT_PWX_OSEPASSWORD.
If you set a password with both methods, the password set
with the -e option takes precedence.
DisplayRecordsLogger
Displays counts of change records that the PowerExchange Logger Service processed during the current
processing cycle. If the Logger Service did not receive changes in the current cycle, displays counts of
change records for the current set of Logger Service log files.
The infacmd pwx DisplayRecordsLogger command displays counts of records for each type of change record
processed and for total records processed. Change record types include Delete, Insert, Update, and Commit.
Depending on whether the command displays counts for the current cycle or the current log files, the output
includes all or some of the following types of information:
• Cycle. Counts of change records for the current Logger Service processing cycle. The Logger Service
resets these counts to zero when the wait interval that is specified in the NO_DATA_WAIT2 parameter of
the pwxccl.cfg file expires and no change data has been received.
• File. Counts of change records for the current set of PowerExchange log files. The Logger Service resets
these counts to zero when a file switch occurs.
[<-DomainName|-dn> domain_name]
[<-UserName|-un> user_name]
[<-Password|-pd> password]
<-ServiceName|-sn> service_name
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
[<-SecurityDomain|-sdn> security_domain]
[<-OSUser|-oun> OS_user_name]
[<-OSPassword|-oup> OS_password]
[<-OSEPassword|-ouep> OS_epassword]
The following table describes infacmd pwx DisplayRecordsLogger options and arguments:
-DomainName domain_name Name of the Informatica domain. You can set the domain
-dn name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with
both methods, the -dn option takes precedence.
-Password password Required if you specify the user name. Password for the
-pd user name. The password is case sensitive. You can set a
password with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password
with both methods, the password set with the -pd option
takes precedence.
DisplayRecordsLogger 929
Option Argument Description
-OSPassword OS_password Required if you specify a user name and do not specify an
-oup encrypted password. Password for the operating system.
You can set a plain text password with the -p option or the
environment variable INFA_DEFAULT_PWX_OSPASSWORD.
If you set a password with both methods, the password set
with the -p option takes precedence.
-OSEPassword OS_epassword Required if you specify a user name and do not specify a
-ouep plain text password. Encrypted password for the operating
system.
You can set an encrypted password with the -e option or the
environment variable INFA_DEFAULT_PWX_OSEPASSWORD.
If you set a password with both methods, the password set
with the -e option takes precedence.
The command can print the following types of statistics, depending on the -type option that you specify:
• PowerExchange Listener summary statistics on memory usage, CPU processing time, and activity on
behalf of client requests. These statistics include counts of client tasks, connections, messages sent and
received, and bytes of data sent and received.
• Message and data volumes that client tasks sent and received for client requests, by task ID and access
method. The message and data volumes are totals as of the time the statistics are generated.
• Information about the active tasks that are running under the Listener to process client requests. These
statistics include the task start time, CPU processing time, access method, read or write mode, and
associated process and session IDs. Also includes the port number and IP address of the client that
issued the request to the PowerExchange Listener.
Important: For PowerExchange to collect PowerExchange Listener monitoring statistics, you must specify the
MONITOR parameter in the STATS statement in the DBMOVER configuration file where the Listener runs.
[<-DomainName|-dn> domain_name]
[<-UserName|-un> user_name]
[<-Password|-pd> password]
<-ServiceName|-sn> service_name
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
[<-SecurityDomain|-sdn> security_domain]
[<-OSUser|-oun> OS_user_name]
[<-OSPassword|-oup> OS_password]
[<-OSEPassword|-ouep> OS_epassword]
[<-Type|-tp> report_type]
displayStatsListener 931
The following table describes infacmd pwx displayStatsListener options and arguments:
-DomainName domain_name Name of the Informatica domain. You can set the domain name
-dn with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with both
methods, the -dn option takes precedence.
-UserName user_name Required if the domain uses Native or LDAP authentication. User
-un name to connect to the domain. You can set the user name with
the -un option or the environment variable
INFA_DEFAULT_DOMAIN_USER. If you set a user name with both
methods, the -un option takes precedence.
Optional if the domain uses Kerberos authentication. To run the
command with single sign-on, do not set the user name. If you
set the user name, the command runs without single sign-on.
-Password password Required if you specify the user name. Password for the user
-pd name. The password is case sensitive. You can set a password
with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password with
both methods, the password set with the -pd option takes
precedence.
-SecurityDomain security_domain Required if the domain uses LDAP authentication. Optional if the
-sdn domain uses native authentication or Kerberos authentication.
Name of the security domain to which the domain user belongs.
You can set a security domain with the -sdn option or the
environment variable INFA_DEFAULT_SECURITY_DOMAIN. If you
set a security domain name with both methods, the -sdn option
takes precedence. The security domain name is case sensitive.
If the domain uses native or LDAP authentication, the default is
Native. If the domain uses Kerberos authentication, the default is
the LDAP security domain created during installation. The name
of the security domain is the same as the user realm specified
during installation.
-OSUser OS_user_name Required if you enable operating system security. User name for
-oun the operating system.
Enable operating system security as follows:
- To require users to enter a valid operating system user ID and
password on the command, specify 1 or 2 for the first
parameter of the SECURITY statement in the DBMOVER
configuration file on each Linux, UNIX, or Windows system that
is the target of the command. PowerExchange uses operating
system facilities on the target system to authenticate the user
ID and password for use of the infacmd pwx program.
- To authorize users to run specific infacmd pwx commands,
specify 2 for the first parameter of the SECURITY statement
and define AUTHGROUP and USER statements in the
PowerExchange sign-on file on each Linux, UNIX, or Windows
system that is the target of the command. PowerExchange
checks the sign-on file to determine whether to allow the user
ID supplied on the infacmd pwx program to run commands.
-OSPassword OS_password Required if you specify a user name and do not specify an
-oup encrypted password. Password for the operating system.
You can set a plain text password with the -p option or the
environment variable INFA_DEFAULT_PWX_OSPASSWORD. If you
set a password with both methods, the password set with the -p
option takes precedence.
displayStatsListener 933
Option Argument Description
-OSEPassword OS_epassword Required if you specify a user name and do not specify a plain
-ouep text password. Encrypted password for the operating system.
You can set an encrypted password with the -e option or the
environment variable INFA_DEFAULT_PWX_OSEPASSWORD. If
you set a password with both methods, the password set with
the -e option takes precedence.
-type report_type Optional. The type of monitoring statistics to report for the
-tp PowerExchange Listener and its client tasks and connections.
The report_type must be one of the following values:
- listener. For a specific PowerExchange Listener, reports
memory usage, CPU processing time, total number of client
tasks, active tasks, high-watermark tasks, maximum allowed
tasks, total number of connections attempted, connections
accepted, active connections, number of messages sent and
received, and bytes of data sent and received.
- accessmethods. For each access method of each active task,
reports the number of rows read and written, bytes of data
read and written, the source or target file name or data map
file name depending on the access method, and the CPU
processing time.
- clients. For each active task, reports the task ID, status,
access method, read or write mode, process and session IDs if
available, CPU processing time, and start date and time. Also
reports the port number and IP address of the client that
issued the request for which the task was created. If the client
is PowerCenter, reports the PowerCenter session ID and the
application name for CDC.
Default is listener.
Note: In these reports, an access method can be a source type
such as NRDB. A client task might be associated with multiple
access methods: one for reading the source data, and one for
mapping nonrelational data to a relational format.
DisplayStatusLogger
Displays the status of the Writer subtask for a PowerExchange Logger Service.
For example, the infacmd pwx DisplayStatusLogger command can report when the Writer completes the
following actions:
• Initializes
• Reads or waits for source data
• Writes source data to a Logger Service log file
• Writes CDCT records during a file switch
• Deletes of expired CDCT records
• Shuts down
[<-DomainName|-dn> domain_name]
[<-UserName|-un> user_name]
[<-Password|-pd> password]
<-ServiceName|-sn> service_name
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
[<-SecurityDomain|-sdn> security_domain]
[<-OSUser|-oun> OS_user_name]
[<-OSPassword|-oup> OS_password]
[<-OSEPassword|-ouep> OS_epassword]
The following table describes infacmd pwx DisplayStatusLogger options and arguments:
-DomainName domain_name Name of the Informatica domain. You can set the domain
-dn name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with
both methods, the -dn option takes precedence.
-Password password Required if you specify the user name. Password for the
-pd user name. The password is case sensitive. You can set a
password with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password
with both methods, the password set with the -pd option
takes precedence.
DisplayStatusLogger 935
Option Argument Description
-OSUser OS_user_name Required if you enable operating system security. User name
-oun for the operating system.
Enable operating system security as follows:
- To require users to enter a valid operating system user ID
and password on the command, specify 1 or 2 for the first
parameter of the SECURITY statement in the DBMOVER
configuration file on each Linux, UNIX, or Windows system
that is the target of the command. PowerExchange uses
operating system facilities on the target system to
authenticate the user ID and password for use of the
infacmd pwx program.
- To authorize users to run specific infacmd pwx
commands, specify 2 for the first parameter of the
SECURITY statement and define AUTHGROUP and USER
statements in the PowerExchange sign-on file on each
Linux, UNIX, or Windows system that is the target of the
command. PowerExchange checks the sign-on file to
determine whether to allow the user ID supplied on the
infacmd pwx program to run commands.
-OSPassword OS_password Required if you specify a user name and do not specify an
-oup encrypted password. Password for the operating system.
You can set a plain text password with the -p option or the
environment variable INFA_DEFAULT_PWX_OSPASSWORD. If
you set a password with both methods, the password set
with the -p option takes precedence.
-OSEPassword OS_epassword Required if you specify a user name and do not specify a
-ouep plain text password. Encrypted password for the operating
system.
You can set an encrypted password with the -e option or the
environment variable INFA_DEFAULT_PWX_OSEPASSWORD.
If you set a password with both methods, the password set
with the -e option takes precedence.
Note: If you use continuous extraction mode, you generally do not need to complete file switches manually.
[<-DomainName|-dn> domain_name]
[<-UserName|-un> user_name]
[<-Password|-pd> password]
<-ServiceName|-sn> service_name
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
[<-SecurityDomain|-sdn> security_domain]
[<-OSUser|-oun> OS_user_name]
[<-OSPassword|-oup> OS_password]
[<-OSEPassword|-ouep> OS_epassword]
The following table describes infacmd pwx FileSwitchLogger options and arguments:
-DomainName domain_name Name of the Informatica domain. You can set the domain
-dn name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with
both methods, the -dn option takes precedence.
-Password password Required if you specify the user name. Password for the user
-pd name. The password is case sensitive. You can set a
password with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password
with both methods, the password set with the -pd option
takes precedence.
FileSwitchLogger 937
Option Argument Description
-OSUser OS_user_name Required if you enable operating system security. User name
-oun for the operating system.
Enable operating system security as follows:
- To require users to enter a valid operating system user ID
and password on the command, specify 1 or 2 for the first
parameter of the SECURITY statement in the DBMOVER
configuration file on each Linux, UNIX, or Windows system
that is the target of the command. PowerExchange uses
operating system facilities on the target system to
authenticate the user ID and password for use of the
infacmd pwx program.
- To authorize users to run specific infacmd pwx
commands, specify 2 for the first parameter of the
SECURITY statement and define AUTHGROUP and USER
statements in the PowerExchange sign-on file on each
Linux, UNIX, or Windows system that is the target of the
command. PowerExchange checks the sign-on file to
determine whether to allow the user ID supplied on the
infacmd pwx program to run commands.
-OSPassword OS_password Required if you specify a user name and do not specify an
-oup encrypted password. Password for the operating system.
You can set a plain text password with the -p option or the
environment variable INFA_DEFAULT_PWX_OSPASSWORD. If
you set a password with both methods, the password set
with the -p option takes precedence.
-OSEPassword OS_epassword Required if you specify a user name and do not specify a
-ouep plain text password. Encrypted password for the operating
system.
You can set an encrypted password with the -e option or the
environment variable INFA_DEFAULT_PWX_OSEPASSWORD.
If you set a password with both methods, the password set
with the -e option takes precedence.
ListTaskListener
Displays information about each active task for the PowerExchange Listener Service, including the TCP/IP
address, port number, application name, access type, and status.
[<-DomainName|-dn> domain_name]
[<-UserName|-un> user_name]
[<-Password|-pd> password]
<-ServiceName|-sn> service_name
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
[<-SecurityDomain|-sdn> security_domain]
[<-OSUser|-oun> OS_user_name]
[<-OSPassword|-oup> OS_password]
[<-OSEPassword|-ouep> OS_epassword]
ListTaskListener 939
The following table describes infacmd pwx ListTaskListener options and arguments:
-DomainName domain_name Name of the Informatica domain. You can set the domain
-dn name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with
both methods, the -dn option takes precedence.
-Password password Required if you specify the user name. Password for the user
-pd name. The password is case sensitive. You can set a
password with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password
with both methods, the password set with the -pd option
takes precedence.
-OSUser OS_user_name Required if you enable operating system security. User name
-oun for the operating system.
Enable operating system security as follows:
- To require users to enter a valid operating system user ID
and password on the command, specify 1 or 2 for the first
parameter of the SECURITY statement in the DBMOVER
configuration file on each Linux, UNIX, or Windows system
that is the target of the command. PowerExchange uses
operating system facilities on the target system to
authenticate the user ID and password for use of the
infacmd pwx program.
- To authorize users to run specific infacmd pwx
commands, specify 2 for the first parameter of the
SECURITY statement and define AUTHGROUP and USER
statements in the PowerExchange sign-on file on each
Linux, UNIX, or Windows system that is the target of the
command. PowerExchange checks the sign-on file to
determine whether to allow the user ID supplied on the
infacmd pwx program to run commands.
-OSPassword OS_password Required if you specify a user name and do not specify an
-oup encrypted password. Password for the operating system.
You can set a plain text password with the -p option or the
environment variable INFA_DEFAULT_PWX_OSPASSWORD. If
you set a password with both methods, the password set
with the -p option takes precedence.
-OSEPassword OS_epassword Required if you specify a user name and do not specify a
-ouep plain text password. Encrypted password for the operating
system.
You can set an encrypted password with the -e option or the
environment variable INFA_DEFAULT_PWX_OSEPASSWORD.
If you set a password with both methods, the password set
with the -e option takes precedence.
ShutDownLogger
Stops the PowerExchange Logger Service in a controlled manner. The command closes the Logger Service
log files and then writes the latest restart position to the CDCT file.
Use this command to stop a PowerExchange Logger Service that is running in continuous mode.
During shutdown processing, the Logger Service completes the following actions:
ShutDownLogger 941
The infacmd pwx ShutDownLogger command uses the following syntax:
ShutDownLogger
[<-DomainName|-dn> domain_name]
[<-UserName|-un> user_name]
[<-Password|-pd> password]
<-ServiceName|-sn> service_name
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
[<-SecurityDomain|-sdn> security_domain]
[<-OSUser|-oun> OS_user_name]
[<-OSPassword|-oup> OS_password]
[<-OSEPassword|-ouep> OS_epassword]
The following table describes infacmd pwx ShutDownLogger options and arguments:
-DomainName domain_name Name of the Informatica domain. You can set the domain
-dn name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with
both methods, the -dn option takes precedence.
-Password password Required if you specify the user name. Password for the
-pd user name. The password is case sensitive. You can set a
password with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password
with both methods, the password set with the -pd option
takes precedence.
-OSPassword OS_password Required if you specify a user name and do not specify an
-oup encrypted password. Password for the operating system.
You can set a plain text password with the -p option or the
environment variable INFA_DEFAULT_PWX_OSPASSWORD.
If you set a password with both methods, the password set
with the -p option takes precedence.
-OSEPassword OS_epassword Required if you specify a user name and do not specify a
-ouep plain text password. Encrypted password for the operating
system.
You can set an encrypted password with the -e option or the
environment variable INFA_DEFAULT_PWX_OSEPASSWORD.
If you set a password with both methods, the password set
with the -e option takes precedence.
ShutDownLogger 943
StopTaskListener
Stops a PowerExchange Listener Service task based on an application name or task ID that you specify.
During change data extraction, infacmd pwx StopTaskListener waits to stop the task until either the end UOW
is encountered or the commit threshold is reached.
[<-DomainName|-dn> domain_name]
[<-UserName|-un> user_name]
[<-Password|-pd> password]
<-ServiceName|-sn> service_name
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
[<-SecurityDomain|-sdn> security_domain]
[<-OSUser|-oun> OS_user_name]
[<-OSPassword|-oup> OS_password]
[<-OSEPassword|-ouep> OS_epassword]
[<-applicationid|-a> appname]
[<-taskid|-t> taskid]
The following table describes infacmd pwx StopTaskListener options and arguments:
-DomainName domain_name Name of the Informatica domain. You can set the domain
-dn name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with
both methods, the -dn option takes precedence.
-Password password Required if you specify the user name. Password for the
-pd user name. The password is case sensitive. You can set a
password with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password
with both methods, the password set with the -pd option
takes precedence.
-OSUser OS_user_name Required if you enable operating system security. User name
-oun for the operating system.
Enable operating system security as follows:
- To require users to enter a valid operating system user ID
and password on the command, specify 1 or 2 for the first
parameter of the SECURITY statement in the DBMOVER
configuration file on each Linux, UNIX, or Windows system
that is the target of the command. PowerExchange uses
operating system facilities on the target system to
authenticate the user ID and password for use of the
infacmd pwx program.
- To authorize users to run specific infacmd pwx
commands, specify 2 for the first parameter of the
SECURITY statement and define AUTHGROUP and USER
statements in the PowerExchange sign-on file on each
Linux, UNIX, or Windows system that is the target of the
command. PowerExchange checks the sign-on file to
determine whether to allow the user ID supplied on the
infacmd pwx program to run commands.
-OSPassword OS_password Required if you specify a user name and do not specify an
-oup encrypted password. Password for the operating system.
You can set a plain text password with the -p option or the
environment variable INFA_DEFAULT_PWX_OSPASSWORD. If
you set a password with both methods, the password set
with the -p option takes precedence.
StopTaskListener 945
Option Argument Description
-OSEPassword OS_epassword Required if you specify a user name and do not specify a
-ouep plain text password. Encrypted password for the operating
system.
You can set an encrypted password with the -e option or the
environment variable INFA_DEFAULT_PWX_OSEPASSWORD.
If you set a password with both methods, the password set
with the -e option takes precedence.
UpgradeModels
Upgrades PowerExchange 9.0.1 nonrelational data objects. You must upgrade the data objects before you
can use them.
The command displays the results of the upgrade, sorted by connection name and then schema and map
name. You can run the UpgradeModels command multiple times if some objects are not upgraded the first
time.
The command verifies that the data map is consistent with the nonrelational operations that were defined for
it when the nonrelational object was imported. If discrepancies exist, the nonrelational operations are deleted
and re-created to match the data map. You must modify any affected mappings or mapplets to use the re-
created nonrelational operations.
[<-DomainName|-dn> domain_name]
[<-UserName|-un> user_name]
[<-Password|-pd> password]
<-MrsServiceName|-msn> mrs_service_name
<-ConnectionName|-cn> connection_name
<-DataObjectSchemaName|ds> data_object_schema_name
<-DataObjectName|do> data_object_name
<-Preview|pr> preview
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
[<-ServiceName|-sn> service_name]
The following table describes infacmd pwx UpgradeModels options and arguments:
-DomainName domain_name Name of the Informatica domain. You can set the domain name with
-dn the -dn option or the environment variable INFA_DEFAULT_DOMAIN.
If you set a domain name with both methods, the -dn option takes
precedence.
-UserName user_name Required if the domain uses Native or LDAP authentication. User
-un name to connect to the domain. You can set the user name with the
-un option or the environment variable
INFA_DEFAULT_DOMAIN_USER. If you set a user name with both
methods, the -un option takes precedence.
Optional if the domain uses Kerberos authentication. To run the
command with single sign-on, do not set the user name. If you set
the user name, the command runs without single sign-on.
-Password password Required if you specify the user name. Password for the user name.
-pd The password is case sensitive. You can set a password with the -
pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password with
both methods, the password set with the -pd option takes
precedence.
-ConnectionName connection_name Required. Name of the connection that contains the nonrelational
-cn data objects that you want to upgrade. To specify all connections or
all connections with the same initial name pattern, include the
asterisk (*) wildcard character in double quotes, for example "*" or
ABC"*".
- data_object_schema_ Required. Name of the schema that contains the data maps of the
DataObjectSchemaN name nonrelational data objects that you want to upgrade. To specify all
ame schemas or all schemas with the same initial name pattern, include
-ds the asterisk (*) wildcard character in double quotes, for example "*"
or ABC"*".
-DataObjectName data_object_name Required. Name of the data map of the nonrelational data object
-do that you want to upgrade. To specify all data maps or all data maps
with the same initial name pattern, include the asterisk (*) wildcard
character in double quotes, for example "*" or ABC"*".
UpgradeModels 947
Option Argument Description
-SecurityDomain security_domain Required if the domain uses LDAP authentication. Optional if the
-sdn domain uses native authentication or Kerberos authentication.
Name of the security domain to which the domain user belongs.
You can set a security domain with the -sdn option or the
environment variable INFA_DEFAULT_SECURITY_DOMAIN. If you set
a security domain name with both methods, the -sdn option takes
precedence. The security domain name is case sensitive.
If the domain uses native or LDAP authentication, the default is
Native. If the domain uses Kerberos authentication, the default is
the LDAP security domain created during installation. The name of
the security domain is the same as the user realm specified during
installation.
UpdateListenerService
Updates the properties of a PowerExchange Listener Service.
[<-DomainName|-dn> domain_name]
[<-UserName|-un> user_name]
[<-Password|-pd> password]
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-ServiceName|-sn> service_name
[<-NodeName|-nn> node_name]
[<-BackupNode|-bn> backup_node]
[<-StartParameters|-sp> start_parameters>]
[<-SvcPort|-sp> service_port]
The following table describes infacmd pwx UpdateListenerService options and arguments:
UpdateListenerService 949
Option Argument Description
UpdateLoggerService
Updates the properties of a PowerExchange Logger Service.
[<-DomainName|-dn> domain_name]
[<-UserName|-un> user_name]
[<-Password|-pd> password]
[<-SecurityDomain|-sdn> security_domain]
UpdateLoggerService 951
[<-Gateway|-hp> gateway_host1:port gateway_host2:port...]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-ServiceName|-sn> service_name
<-NodeName|-nn> node_name
[<-LicenseName|-ln> license_name]
[<-BackupNode|-bn> backup_node]
[<-StartParameters|-sp> start_parameters>]
[<-SvcPort|-sp> service_port]
The following table describes infacmd pwx UpdateLoggerService options and arguments:
-DomainName domain_name Name of the Informatica domain. You can set the domain
-dn name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with both
methods, the -dn option takes precedence.
-Password password Required if you specify the user name. Password for the user
-pd name. The password is case sensitive. You can set a
password with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password
with both methods, the password set with the -pd option takes
precedence.
-NodeName node_name Required. Name of the node where you want the Logger
-nn Service to run.
UpdateLoggerService 953
Option Argument Description
-StartParameters start_parameters Optional. Parameters to include when you start the Logger
-sp Service. Separate the parameters with the space character.
You can include the following parameters:
- coldstart={Y|N}
Indicates whether to cold start or warm start the Logger
Service. Enter Y to cold start the Logger Service. If the
CDCT file contains log records, the Logger Service deletes
these records. Enter N to warm start the Logger Service
from the restart point that is indicated in the CDCT file.
Default is N.
- config=directory/pwx_config_file
Specifies the full path and file name for any dbmover.cfg
configuration file that you want to use instead of the
default dbmover.cfg file. This alternative configuration file
takes precedence over any alternative configuration file
that you specify in the PWX_CONFIG environment variable.
- cs=directory/pwxlogger_config_file
Specifies the path and file name for the Logger Service
configuration file. You can also use the cs parameter to
specify a Logger Service configuration file that overrides
the default pwxccl.cfg file. The override file must have a
path or file name that is different from that of the default
file.
- encryptepwd=encrypted_password
A password in encrypted format for enabling the encryption
of PowerExchange Logger log files. With this password, the
PowerExchange Logger can generate a unique encryption
key for each Logger log file. The password is stored in the
CDCT file in encrypted format. For security purposes, the
password is not stored in CDCT backup files and is not
displayed in the CDCT reports that you can generate with
the PowerExchange PWXUCDCT utility.
If you specify this parameter, you must also specify
coldstart=Y.
If you specify this parameter and also specify the
ENCRYPTEPWD parameter in the PowerExchange Logger
configuration file, pwxccl.cfg, the parameter in the
configuration file takes precedence. If you specify this
parameter and also specify the ENCRYPTPWD parameter in
the PowerExchange Logger configuration file, an error
occurs.
You can set the AES algorithm to use for log file encryption
in the ENCRYPTOPT parameter of the pwxccl.cfg file. The
default is AES128.
Tip: For optimal security, Informatica recommends that you
specify the encryption password when cold starting the
PowerExchange Logger rather than in the pwxccl.cfg
configuration file. This practice can reduce the risk of
malicious access to the encryption password for the
following reasons: 1) The encryption password is not
stored in the pwxccl.cfg file, and 2) You can remove the
password from the command line after a successful cold
start. If you specify the encryption password for a cold
start and then need to restore the CDCT file later, you must
UpdateLoggerService 955
Option Argument Description
-SvcPort service_port Port on which the Logger Service listens for commands from
-sp the Service Manager.
• listProcessProperties, 957
• listReverseProxyServerOptions, 958
• listServiceProcessOptions, 960
• updateReverseProxyServerOptions, 961
• updateServiceProcessOptions, 963
• updateServiceOptions, 965
listProcessProperties
Lists the REST Operations Hub process properties.
-DomainName domain_name Required. Name of the Informatica domain. You can set the
-dn domain name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with both
methods, the -dn option takes precedence.
-UserName user-name Required if the domain uses Native or LDAP authentication. User
-un name to connect to the domain. You can set the user name with
the -un option or the environment variable
INFA_DEFAULT_DOMAIN_USER. If you set a user name with both
methods, the -un option takes precedence.
Optional if the domain uses Kerberos authentication. To run the
command with single sign-on, do not set the user name. If you set
the user name, the command runs without single sign-on.
957
Option Argument Description
-Password password Required if you specify the user name. Password for the user
-pd name. The password is case sensitive. You can set a password
with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password with
both methods, the password set with the -pd option takes
precedence.
-SecurityDomain security_domain Required if the domain uses LDAP authentication. Optional if the
-sdn domain uses native authentication or Kerberos authentication.
Name of the security domain to which the domain user belongs.
You can set a security domain with the -sdn option or the
environment variable INFA_DEFAULT_SECURITY_DOMAIN. If you
set a security domain name with both methods, the -sdn option
takes precedence. The security domain name is case sensitive.
If the domain uses native or LDAP authentication, the default is
Native. If the domain uses Kerberos authentication, the default is
the LDAP security domain created during installation. The name
of the security domain is the same as the user realm specified
during installation.
-Gateway Domain gateway host:port Required if the gateway connectivity information in the
-hp domains.infa file is out of date. Enter the host name and port
number for the gateway node in the domain.
listReverseProxyServerOptions
Lists the reverse proxy server properties.
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-NodeName|-nn> Node_name]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
-DomainName domain_name Required. Name of the Informatica domain. You can set the
-dn domain name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with both
methods, the -dn option takes precedence.
-UserName user_name Required if the domain uses Native or LDAP authentication. User
-un name to connect to the domain. You can set the user name with
the -un option or the environment variable
INFA_DEFAULT_DOMAIN_USER. If you set a user name with both
methods, the -un option takes precedence.Optional if the domain
uses Kerberos authentication. To run the command with single
sign-on, do not set the user name. If you set the user name, the
command runs without single sign-on.
-Password password Required if you specify the user name. Password for the user
-pd name. The password is case sensitive. You can set a password
with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password with
both methods, the password set with the -pd option takes
precedence.
-SecurityDomain security_domain Required if the domain uses LDAP authentication. Optional if the
-sdn domain uses native authentication or Kerberos authentication.
Name of the security domain to which the domain user belongs.
You can set a security domain with the -sdn option or the
environment variable INFA_DEFAULT_SECURITY_DOMAIN. If you
set a security domain name with both methods, the -sdn option
takes precedence. The security domain name is case sensitive.If
the domain uses native or LDAP authentication, the default is
Native. If the domain uses Kerberos authentication, the default is
the LDAP security domain created during installation. The name
of the security domain is the same as the user realm specified
during installation.
listReverseProxyServerOptions 959
listServiceProcessOptions
Lists the REST Operations Hub Service Process properties.
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-NodeName|-nn> Node_name]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
The following table describes the infacmd roh listServiceProcessOptions options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set the
-dn domain name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with both
methods, the -dn option takes precedence.
-UserName user_name Required if the domain uses Native or LDAP authentication. User
-un name to connect to the domain. You can set the user name with
the -un option or the environment variable
INFA_DEFAULT_DOMAIN_USER. If you set a user name with both
methods, the -un option takes precedence.Optional if the domain
uses Kerberos authentication. To run the command with single
sign-on, do not set the user name. If you set the user name, the
command runs without single sign-on.
-Password password Required if you specify the user name. Password for the user
-pd name. The password is case sensitive. You can set a password
with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password with
both methods, the password set with the -pd option takes
precedence.
-SecurityDomain security_domain Required if the domain uses LDAP authentication. Optional if the
-sdn domain uses native authentication or Kerberos authentication.
Name of the security domain to which the domain user belongs.
You can set a security domain with the -sdn option or the
environment variable INFA_DEFAULT_SECURITY_DOMAIN. If you
set a security domain name with both methods, the -sdn option
takes precedence. The security domain name is case sensitive.If
the domain uses native or LDAP authentication, the default is
Native. If the domain uses Kerberos authentication, the default is
the LDAP security domain created during installation. The name
of the security domain is the same as the user realm specified
during installation.
updateReverseProxyServerOptions
Updates the reverse proxy server properties.
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
<-NodeName|-nn> Node_name
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
updateReverseProxyServerOptions 961
The following table describes the infacmd roh updateReverseProxyServerOptions options and arguments:
updateServiceProcessOptions
Updates REST Operations Hub Service process properties in a domain.
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
<-NodeName|-nn> Node_name
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
updateServiceProcessOptions 963
The following table describes the infacmd roh updateServiceProcessOption options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set the
-dn domain name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with both
methods, the -dn option takes precedence.
-UserName user_name Required if the domain uses Native or LDAP authentication. User
-un name to connect to the domain. You can set the user name with
the -un option or the environment variable
INFA_DEFAULT_DOMAIN_USER. If you set a user name with both
methods, the -un option takes precedence.Optional if the domain
uses Kerberos authentication. To run the command with single
sign-on, do not set the user name. If you set the user name, the
command runs without single sign-on.
-Password password Required if you specify the user name. Password for the user
-pd name. The password is case sensitive. You can set a password
with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password with
both methods, the password set with the -pd option takes
precedence.
-SecurityDomain security_domain Required if the domain uses LDAP authentication. Optional if the
-sdn domain uses native authentication or Kerberos authentication.
Name of the security domain to which the domain user belongs.
You can set a security domain with the -sdn option or the
environment variable INFA_DEFAULT_SECURITY_DOMAIN. If you
set a security domain name with both methods, the -sdn option
takes precedence. The security domain name is case sensitive.If
the domain uses native or LDAP authentication, the default is
Native. If the domain uses Kerberos authentication, the default is
the LDAP security domain created during installation. The name
of the security domain is the same as the user realm specified
during installation.
-ServiceOptions option_name=value ... Optional. Service properties that define how the REST Operations
-so Hub Service runs.
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
-DomainName domain_name Required. Name of the Informatica domain. You can set the
-dn domain name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with both
methods, the -dn option takes precedence.
-UserName user_name Required if the domain uses Native or LDAP authentication. User
-un name to connect to the domain. You can set the user name with
the -un option or the environment variable
INFA_DEFAULT_DOMAIN_USER. If you set a user name with both
methods, the -un option takes precedence.Optional if the domain
uses Kerberos authentication. To run the command with single
sign-on, do not set the user name. If you set the user name, the
command runs without single sign-on.
-Password password Required if you specify the user name. Password for the user
-pd name. The password is case sensitive. You can set a password
with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password with
both methods, the password set with the -pd option takes
precedence.
-SecurityDomain security_domain Required if the domain uses LDAP authentication. Optional if the
-sdn domain uses native authentication or Kerberos authentication.
Name of the security domain to which the domain user belongs.
You can set a security domain with the -sdn option or the
environment variable INFA_DEFAULT_SECURITY_DOMAIN. If you
set a security domain name with both methods, the -sdn option
takes precedence. The security domain name is case sensitive.If
the domain uses native or LDAP authentication, the default is
Native. If the domain uses Kerberos authentication, the default is
the LDAP security domain created during installation. The name
of the security domain is the same as the user realm specified
during installation.
-NodeName Node_name Required. Node name that belongs to a grid where the service
-nn process runs.
updateServiceOptions 965
Option Argument Description
• ListComputeNodeAttributes, 967
• ListServiceOptions, 969
• SetComputeNodeAttributes, 970
• UpdateServiceOptions, 972
ListComputeNodeAttributes
Lists the compute node attributes that have been overridden for the specified node or for all nodes. Use the
infacmd rms SetComputeNodeAttributes command to override compute node attributes.
The default values for the attributes are the actual number of cores and memory available on the machine. If
the infacmd rms ListComputeNodeAttributes command does not list a value for an attribute, then the
Resource Manager Service is using the default values.
<-DomainName|-dn> domain_name
[<-SecurityDomain|-sdn> security_domain]
<-UserName|-un> user_name
<-Password|-pd> password
[<-NodeName|-nn> node_name]
[<-ServiceName|-sn> service_name]
967
The following table describes infacmd rms ListComputeNodeAttributes options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set
-dn the domain name with the -dn option or the environment
variable INFA_DEFAULT_DOMAIN. If you set a domain
name with both methods, the -dn option takes
precedence.
-Password password Required if you specify the user name. Password for the
-pd user name. The password is case sensitive. You can set
a password with the -pd option or the environment
variable INFA_DEFAULT_DOMAIN_PASSWORD. If you set
a password with both methods, the password set with
the -pd option takes precedence.
-NodeName node_name Optional. Name of the compute node that you want to
-nn list the attributes for.
If you omit the option, the command lists the attributes
set for all compute nodes in the domain.
<-DomainName|-dn> domain_name
[<-SecurityDomain|-sdn> security_domain]
<-UserName|-un> user_name
<-Password|-pd> password
[<-ServiceName|-sn> service_name]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
The following table describes infacmd rms ListServiceOptions options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set
-dn the domain name with the -dn option or the environment
variable INFA_DEFAULT_DOMAIN. If you set a domain
name with both methods, the -dn option takes
precedence.
ListServiceOptions 969
Option Argument Description
-Password password Required if you specify the user name. Password for the
-pd user name. The password is case sensitive. You can set
a password with the -pd option or the environment
variable INFA_DEFAULT_DOMAIN_PASSWORD. If you set
a password with both methods, the password set with
the -pd option takes precedence.
SetComputeNodeAttributes
Overrides the compute node attributes for the specified node.
The default values for the attributes are the actual number of cores and memory available on the machine. To
reset an option to its default value, specify -1 as the value.
<-DomainName|-dn> domain_name
[<-SecurityDomain|-sdn> security_domain]
<-UserName|-un> user_name
<-Password|-pd> password
<-NodeName|-nn> node_name
[<-MaxCores|-mc> max_number_of_cores_to_allocate]
[<-MaxMem|-mm> max_memory_in_mb_to_allocate]
[<-ServiceName|-sn> service_name]
-DomainName domain_name Required. Name of the Informatica domain. You can set the
-dn domain name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with both
methods, the -dn option takes precedence.
-Password password Required if you specify the user name. Password for the user
-pd name. The password is case sensitive. You can set a
password with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password
with both methods, the password set with the -pd option
takes precedence.
-NodeName node_name Required. Name of the compute node that you want to set
-nn attributes for.
SetComputeNodeAttributes 971
Option Argument Description
UpdateServiceOptions
Updates Resource Manager Service properties. Run this command to configure the primary and back-up
nodes for the Resource Manager Service.
You can change the properties while the service is running, but you must recycle the service for the changed
properties to take effect.
<-DomainName|-dn> domain_name
[<-SecurityDomain|-sdn> security_domain]
<-UserName|-un> user_name
<-Password|-pd> password
[<-ServiceName|-sn> service_name]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
[<-Options|-o> options]
[<-NodeName|-nn> primary_node_name]
[<-BackupNodes|-bn> backup_node_name1,backup_node_name2,...]
-DomainName domain_name Required. Name of the Informatica domain. You can set
-dn the domain name with the -dn option or the environment
variable INFA_DEFAULT_DOMAIN. If you set a domain
name with both methods, the -dn option takes
precedence.
-Password password Required if you specify the user name. Password for the
-pd user name. The password is case sensitive. You can set
a password with the -pd option or the environment
variable INFA_DEFAULT_DOMAIN_PASSWORD. If you set
a password with both methods, the password set with
the -pd option takes precedence.
UpdateServiceOptions 973
Option Argument Description
-BackupNodes backup_node_name1,back Optional. Nodes on which the service can run if the
-bn up_node_name2,... primary node is unavailable.
Option Description
ResourceManagerServiceOptions.Log_Level Level of error messages that the Resource Manager Service writes to
the service log. Choose one of the following message levels: Fatal,
Error, Warning, Info, Trace, or Debug.
• DeployImport, 975
• Export, 977
• Import, 979
DeployImport
Imports content from an application file to the database that is read by the Model repository.
<-Password|-pd> Password
975
The following table describes infacmd rtm DeployImport options and arguments:
-UserName User name Required if the domain uses Native or LDAP authentication.
-un User name to connect to the domain. You can set the user
name with the -un option or the environment variable
INFA_DEFAULT_DOMAIN_USER. If you set a user name with
both methods, the -un option takes precedence.
Optional if the domain uses Kerberos authentication. To run the
command with single sign-on, do not set the user name. If you
set the user name, the command runs without single sign-on.
-Password Password Required if you specify the user name. Password for the user
-pd name. The password is case sensitive. You can set a password
with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password
with both methods, the password set with the -pd option takes
precedence.
-securityDomain Security domain Required if the domain uses LDAP authentication. Optional if
-sdn the domain uses native authentication or Kerberos
authentication. Name of the security domain to which the
domain user belongs. You can set a security domain with the -
sdn option or the environment variable
INFA_DEFAULT_SECURITY_DOMAIN. If you set a security
domain name with both methods, the -sdn option takes
precedence. The security domain name is case sensitive.
If the domain uses native or LDAP authentication, the default is
Native. If the domain uses Kerberos authentication, the default
is the LDAP security domain created during installation. The
name of the security domain is the same as the user realm
specified during installation.
-NodeName Node name Optional. Name of the gateway node for the Model Repository
-nn Service.
-CodePage Code page Required. Code page for the reference data to import.
-cp
-Folder The folder to Required. Path to the folder that contains the files to import.
-f import from You run the DeployImport command on the machine that stores
the folder. The folder option describes a path on the machine
that runs the command.
-MetadataFile Metadata file Required. Full name and path for the application file that you
-mf apply the command to.
Export
Exports data from reference tables. You can export reference table objects or just the data. You can export
data from managed and unmanaged reference tables.
When you configure an object list, create a text file that contains a list of objects with the following syntax:
ProjectName/FolderName/reference_table_object1
ProjectName/FolderName/reference_table_object2
ProjectName/FolderName/reference_table_object3
Note: You must configure each path in the object list to have slashes. Do not use backslash in the path.
<-Password|-pd> Password
Export 977
The following table describes infacmd rtm Export options and arguments:
-UserName User name Required if the domain uses Native or LDAP authentication.
-un User name to connect to the domain. You can set the user
name with the -un option or the environment variable
INFA_DEFAULT_DOMAIN_USER. If you set a user name with
both methods, the -un option takes precedence.
Optional if the domain uses Kerberos authentication. To run the
command with single sign-on, do not set the user name. If you
set the user name, the command runs without single sign-on.
-Password Password Required if you specify the user name. Password for the user
-pd name. The password is case sensitive. You can set a password
with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password
with both methods, the password set with the -pd option takes
precedence.
-SecurityDomain Security domain Required if the domain uses LDAP authentication. Optional if
-sdn the domain uses native authentication or Kerberos
authentication. Name of the security domain to which the
domain user belongs. You can set a security domain with the -
sdn option or the environment variable
INFA_DEFAULT_SECURITY_DOMAIN. If you set a security
domain name with both methods, the -sdn option takes
precedence. The security domain name is case sensitive.
If the domain uses native or LDAP authentication, the default is
Native. If the domain uses Kerberos authentication, the default
is the LDAP security domain created during installation. The
name of the security domain is the same as the user realm
specified during installation.
-NodeName Node name Optional. Name of the gateway node for the Model Repository
-nn Service.
-CodePage Code Page Required. Code page for the reference data.
-cp
-Folder The folder to Required. Target location for the export file.
-f export to
-ObjectList List of Obects to Fully qualified file name containing the list of reference table
-ol export objects.
Do not configure this option with the ProjectFolder or
metadataFile option.
-ProjectFolder Name of the Name of the project and folder to export. Use the following
-pf project folder to syntax:
export ProjectName/FolderName
Do not configure with the metadataFile or ObjectList option.
-metadataFile Metadata file Required for object export. Full path and name for a
-mf metadata.xml file that you want to apply the command to.
Exports all reference tables that the metadata. xml file
contains.
Do not configure this option with the ProjectFolder or
ObjectList option.
-Recursive Include Optional. Use with the ProjectFolder option. Export more than
-r subfolders when one level of object. Default is not recursive.
exporting
project folder
-SkipDatGeneration Skip Data Optional. Writes a .dat file that describes the reference table
-sdg Generation structure to the directory set in the folder property. The
reference table import process does not use this file. Default is
False.
Import
Performs a metadata and data import from object export files. Imports reference table metadata into the
Model repository and imports the data into the reference data database. Also imports reference data without
the metadata.
Before you import reference table data, the destination project must exist in the Model repository.
<-Password|-pd> Password
Import 979
<-ConflictResolution|-cr> Conflict resolution
-UserName User name Required if the domain uses Native or LDAP authentication.
-un User name to connect to the domain. You can set the user
name with the -un option or the environment variable
INFA_DEFAULT_DOMAIN_USER. If you set a user name with
both methods, the -un option takes precedence.
Optional if the domain uses Kerberos authentication. To run the
command with single sign-on, do not set the user name. If you
set the user name, the command runs without single sign-on.
-Password Password Required if you specify the user name. Password for the user
-pd name. The password is case sensitive. You can set a password
with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password
with both methods, the password set with the -pd option takes
precedence.
-securityDomain Security domain Required if the domain uses LDAP authentication. Optional if
-sdn the domain uses native authentication or Kerberos
authentication. Name of the security domain to which the
domain user belongs. You can set a security domain with the -
sdn option or the environment variable
INFA_DEFAULT_SECURITY_DOMAIN. If you set a security
domain name with both methods, the -sdn option takes
precedence. The security domain name is case sensitive.
If the domain uses native or LDAP authentication, the default is
Native. If the domain uses Kerberos authentication, the default
is the LDAP security domain created during installation. The
name of the security domain is the same as the user realm
specified during installation.
-NodeName Node name Optional. Name of the gateway node for the Model Repository
-nn Service.
-CodePage Code page Required. Code page for the reference data.
-cp
-ConflictResolution Conflict Required. Defines the behavior when a name conflict occurs.
-cr resolution Enter one of the following arguments:
- Replace. Replace the current reference table object with the
object that you import.
- Rename. Create a reference table object with a different
name.
- Skip. Do not import the reference table.
Note: The Replace argument specifies the resolution policy for
the reference table object and not for the underlying table in the
reference data database. When you use the Replace argument,
the import command creates a table for the data that the new
object represents in the reference data database. The
command does not drop the table that the previous object
identified.
To remove unused tables from the reference data database, run
the infacmd cms Purge command.
-Folder The folder to Required for metadata and data import. Full path to the folder
-f import from that contains the reference data file you want to import.
-FileName Required only Required for metadata and data import if you are importing
-fn for importing a data from a single file. Name of the file that contains the
single dictionary reference data you want to import. The file name is relative to
the folder path.
-MetadataFile Required only Required when you import reference data values only. Full path
-mf for Object and name for the metadata.xml file that you apply the
import command to. The metadata.xml file contains the metadata
associated with the reference data values. Do not use with the
ProjectFolder option.
-ProjectFolder Name of the Required when you import reference data and metadata. Name
-pf project folder to of the Model repository project that you want to import into. Do
import into not use with the MetadataFile option.
-NotRecursive - Don't include Optional. Use with metadata and data import. Import one level
-nr subfolders of objects only. Default is recursive.
Import 981
Chapter 32
• CreateSchedule, 982
• DeleteSchedule, 990
• ListSchedule, 992
• ListServiceOptions, 994
• ListServiceProcessOptions, 995
• PauseAll, 997
• PauseSchedule, 998
• ResumeAll, 999
• ResumeSchedule, 1001
• UpdateSchedule, 1002
• UpdateServiceOptions, 1006
• UpdateServiceProcessOptions, 1008
• Upgrade, 1011
CreateSchedule
Creates a schedule for deployed mappings and deployed workflows.
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-ScheduleName|-scn> schedule_name
[<-ScheduleDescription|-scd> schedule_description]
<-Recurrence|-r> once|daily|weekly|monthly
982
<-StartTime|-st> yyyy-MM-dd HH:mm
[<-TimeZone|-tz> time_zone]
[<-DailyRunEvery|-dre> daily_run_every]
[<-RunDaysOfWeek|-rdw> mon|tue|wed|thu|fri|sat|sun]
[<-RunDayOfWeekMonth|-rdwm> monday|tuesday|wednesday|thursday|friday|saturday|sunday]
[<-RunDayOfMonth|-rdm> 1-30|LAST_DAY_OF_MONTH]
[<-RepeatCount|-rc> repeat_count]
[<-RunnableObjects|-ro> runnable_objects]
[<-Status|-ss> SCHEDULED|SUSPENDED]
[<-RunNow|-rn> true|false]
To configure multiple values for an argument, separate the values with commas.
The following table describes infacmd sch CreateSchedule options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set the
-dn domain name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with both
methods, the -dn option takes precedence.
-Password password Required if you specify the user name. Password for the user
-pd name. The password is case sensitive. You can set a
password with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password
with both methods, the password set with the -pd option
takes precedence.
CreateSchedule 983
Option Argument Description
-ScheduleName schedule_name Required. Name of the schedule. The schedule name is case
-scn sensitive.
-Recurrence once|daily|weekly|monthly Required. Specify whether the schedule runs once or recurs.
-r
-StartTime yyyy-MM-dd HH:mm Required. Date and time that the recurrence starts.
-st
-EndTime yyyy-MM-dd HH:mm Optional. Date and time that the recurrence ends.
-et
-TimeZone timezone Optional. Time zone for the schedule start time.
-tz To configure the time zone, you can enter the time zone ID
number or the Olson Database ID.
Default is locale of the client machine.
-RunDaysOfWeek mon|tue|wed|thu|fri|sat|sun Optional. Run the schedule on certain days of the week.
-rdw
-RunDayOfWeekMonth monday|tuesday| Optional. Run the schedule on certain days of the week every
-rdwm wednesday|thursday|friday| month. Use the -dre options to run the schedule every first,
saturday|sunday second, third, fourth, or last n day of the month.
-RepeatCount repeat_count Optional. End the recurrence after a number of runs instead of
-rc on a date.
CreateSchedule 985
Option Argument Description
-RunnableObjects runnableObjects Optional. Objects that you would like to schedule. Enter the
-ro object type, followed by the path to the object on the Data
Integration Service. For example:
"workflow://DIS_hw2288/App_DMPA_run/
wf_run_DMPA"
Optionally, use the following arguments to configure a
parameter file, parameter set, run as user, or operating
system profile for the object:
- parameterFilePath=PATH_TO_PARAMETER_FILE
- parameterSet=PARAMETER_SET_NAME
- runAsUser=USER_NAME
&runAsUserSecurityDomain=SECURITY_DOMAIN
&runAsUserPassword=PASSWORD
- osProfileName=OS_PROFILE_NAME
For example:
"workflow:DIS_1234/Application_workflow/
Workflow_abc?
parameterFilePath=C://Informatica/Parameter
Files/Parameter.xml
&runAsUser=Administrator
&runAsUserSecurityDomain=Native
&runAsUserPassword=Administrator"
The following table lists the values you can enter for the time zone:
CreateSchedule 987
ID Olson Database ID Name
CreateSchedule 989
ID Olson Database ID Name
DeleteSchedule
Deletes one or more schedules that the Scheduler Service manages.
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-ScheduleName|-scn> schedule_name
-DomainName domain_name Required. Name of the Informatica domain. You can set
-dn the domain name with the -dn option or the environment
variable INFA_DEFAULT_DOMAIN. If you set a domain
name with both methods, the -dn option takes
precedence.
-Password password Required if you specify the user name. Password for the
-pd user name. The password is case sensitive. You can set
a password with the -pd option or the environment
variable INFA_DEFAULT_DOMAIN_PASSWORD. If you set
a password with both methods, the password set with
the -pd option takes precedence.
DeleteSchedule 991
ListSchedule
Lists schedules or scheduled objects that the Scheduler Service manages. The command returns schedules
or scheduled objects that meet all of the entered options.
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
[<-ScheduleName|-scn> schedule_name]
[<-Description|-scd> description]
[<-RunnableObjects|-ro> runnable_objects]
[<-ScheduleStatus|-ss> created|scheduled|paused|complete]
[<-NumberOfFireTimes|-n> number_of_fire_times]
[<-MaxResults|-m> max_results]
The following table describes infacmd isp ListSchedule options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set
-dn the domain name with the -dn option or the environment
variable INFA_DEFAULT_DOMAIN. If you set a domain
name with both methods, the -dn option takes
precedence.
-Password password Required if you specify the user name. Password for the
-pd user name. The password is case sensitive. You can set
a password with the -pd option or the environment
variable INFA_DEFAULT_DOMAIN_PASSWORD. If you set
a password with both methods, the password set with
the -pd option takes precedence.
RunnableObjects runnableObjects Optional. Lists the schedules that run an object. Enter
-ro the object type and path on the Data Integration Service
in the following format:
'{mapping|workflow}://dis_name/app_name/
obj_name'
For example,
'mapping://dis_demo/app_demo/mapping_demo'
ListSchedule 993
ListServiceOptions
Returns a list of the properties that are configured for the Scheduler Service.
<-DomainName|-dn> domain_name
<-ServiceName|-sn> service_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
The following table describes infacmd sch ListServiceOptions options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set the
-dn domain name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with both
methods, the -dn option takes precedence.
-UserName user_name Required if the domain uses Native or LDAP authentication. User
-un name to connect to the domain. You can set the user name with
the -un option or the environment variable
INFA_DEFAULT_DOMAIN_USER. If you set a user name with both
methods, the -un option takes precedence.
Optional if the domain uses Kerberos authentication. To run the
command with single sign-on, do not set the user name. If you
set the user name, the command runs without single sign-on.
-Password password Required if you specify the user name. Password for the user
-pd name. The password is case sensitive. You can set a password
with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password with
both methods, the password set with the -pd option takes
precedence.
-SecurityDomain security_domain Required if the domain uses LDAP authentication. Optional if the
-sdn domain uses native authentication or Kerberos authentication.
Name of the security domain to which the domain user belongs.
You can set a security domain with the -sdn option or the
environment variable INFA_DEFAULT_SECURITY_DOMAIN. If you
set a security domain name with both methods, the -sdn option
takes precedence. The security domain name is case sensitive.
If the domain uses native or LDAP authentication, the default is
Native. If the domain uses Kerberos authentication, the default
is the LDAP security domain created during installation. The
name of the security domain is the same as the user realm
specified during installation.
ListServiceProcessOptions
Returns a list of the properties that are configured for a Scheduler Service process.
<-DomainName|-dn> domain_name
<-ServiceName|-sn> service_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-NodeName|-nn> node_name
ListServiceProcessOptions 995
The following table describes infacmd sch ListServiceProcessOptions options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set the
-dn domain name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with both
methods, the -dn option takes precedence.
-UserName user_name Required if the domain uses Native or LDAP authentication. User
-un name to connect to the domain. You can set the user name with
the -un option or the environment variable
INFA_DEFAULT_DOMAIN_USER. If you set a user name with both
methods, the -un option takes precedence.
Optional if the domain uses Kerberos authentication. To run the
command with single sign-on, do not set the user name. If you
set the user name, the command runs without single sign-on.
-Password password Required if you specify the user name. Password for the user
-pd name. The password is case sensitive. You can set a password
with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password with
both methods, the password set with the -pd option takes
precedence.
-SecurityDomain security_domain Required if the domain uses LDAP authentication. Optional if the
-sdn domain uses native authentication or Kerberos authentication.
Name of the security domain to which the domain user belongs.
You can set a security domain with the -sdn option or the
environment variable INFA_DEFAULT_SECURITY_DOMAIN. If you
set a security domain name with both methods, the -sdn option
takes precedence. The security domain name is case sensitive.
If the domain uses native or LDAP authentication, the default is
Native. If the domain uses Kerberos authentication, the default
is the LDAP security domain created during installation. The
name of the security domain is the same as the user realm
specified during installation.
-NodeName node_name Name of the node on which the service process runs.
-nn
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
The following table describes infacmd sch PauseAll options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set the
-dn domain name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with both
methods, the -dn option takes precedence.
-UserName user_name Required if the domain uses Native or LDAP authentication. User
-un name to connect to the domain. You can set the user name with
the -un option or the environment variable
INFA_DEFAULT_DOMAIN_USER. If you set a user name with both
methods, the -un option takes precedence.
Optional if the domain uses Kerberos authentication. To run the
command with single sign-on, do not set the user name. If you
set the user name, the command runs without single sign-on.
-Password password Required if you specify the user name. Password for the user
-pd name. The password is case sensitive. You can set a password
with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password with
both methods, the password set with the -pd option takes
precedence.
-SecurityDomain security_domain Required if the domain uses LDAP authentication. Optional if the
-sdn domain uses native authentication or Kerberos authentication.
Name of the security domain to which the domain user belongs.
You can set a security domain with the -sdn option or the
environment variable INFA_DEFAULT_SECURITY_DOMAIN. If you
set a security domain name with both methods, the -sdn option
takes precedence. The security domain name is case sensitive.
If the domain uses native or LDAP authentication, the default is
Native. If the domain uses Kerberos authentication, the default is
the LDAP security domain created during installation. The name
of the security domain is the same as the user realm specified
during installation.
PauseAll 997
Option Argument Description
PauseSchedule
Pauses a schedule that the Scheduler Service manages. When you a pause a schedule, the objects that run
on the schedule stop running until you resume the schedule.
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-ScheduleName|-scn> schedule_name
The following table describes infacmd sch PauseSchedule options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set
-dn the domain name with the -dn option or the environment
variable INFA_DEFAULT_DOMAIN. If you set a domain
name with both methods, the -dn option takes
precedence.
-Password password Required if you specify the user name. Password for the
-pd user name. The password is case sensitive. You can set
a password with the -pd option or the environment
variable INFA_DEFAULT_DOMAIN_PASSWORD. If you set
a password with both methods, the password set with
the -pd option takes precedence.
-ScheduleName schedule_name Name of the schedule that you want to pause. The
-scn schedule name is case sensitive.
ResumeAll
Resumes all paused schedules that the Scheduler Service manages.
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
ResumeAll 999
The following table describes infacmd sch ResumeAll options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set the
-dn domain name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with both
methods, the -dn option takes precedence.
-UserName user_name Required if the domain uses Native or LDAP authentication. User
-un name to connect to the domain. You can set the user name with
the -un option or the environment variable
INFA_DEFAULT_DOMAIN_USER. If you set a user name with both
methods, the -un option takes precedence.
Optional if the domain uses Kerberos authentication. To run the
command with single sign-on, do not set the user name. If you
set the user name, the command runs without single sign-on.
-Password password Required if you specify the user name. Password for the user
-pd name. The password is case sensitive. You can set a password
with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password with
both methods, the password set with the -pd option takes
precedence.
-SecurityDomain security_domain Required if the domain uses LDAP authentication. Optional if the
-sdn domain uses native authentication or Kerberos authentication.
Name of the security domain to which the domain user belongs.
You can set a security domain with the -sdn option or the
environment variable INFA_DEFAULT_SECURITY_DOMAIN. If you
set a security domain name with both methods, the -sdn option
takes precedence. The security domain name is case sensitive.
If the domain uses native or LDAP authentication, the default is
Native. If the domain uses Kerberos authentication, the default is
the LDAP security domain created during installation. The name
of the security domain is the same as the user realm specified
during installation.
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-ScheduleName|-scn> schedule_name
The following table describes infacmd sch ResumeSchedule options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set
-dn the domain name with the -dn option or the environment
variable INFA_DEFAULT_DOMAIN. If you set a domain
name with both methods, the -dn option takes
precedence.
-Password password Required if you specify the user name. Password for the
-pd user name. The password is case sensitive. You can set
a password with the -pd option or the environment
variable INFA_DEFAULT_DOMAIN_PASSWORD. If you set
a password with both methods, the password set with
the -pd option takes precedence.
ResumeSchedule 1001
Option Argument Description
ScheduleName schedule_name Name of the paused schedule that you want to resume.
-scn
UpdateSchedule
Updates a schedule that the Scheduler Service manages. Update a schedule to change the start or end times,
recurrence, or objects that run on the schedule. To view the current options, run the infacmd sch
ListSchedule command.
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-ScheduleName|-scn> schedule_name
[<-ScheduleDescription|-scd> schedule_description]
<-Recurrence|-r> once|daily|weekly|monthly
[<-TimeZone|-tz> time_zone]
[<-DailyRunEvery|-dre> daily_run_every]
[<-RunDaysOfWeek|-rdw> mon|tue|wed|thu|fri|sat|sun]
[<-RunDayOfWeekMonth|-rdwm> monday|tuesday|wednesday|thursday|friday|saturday|sunday]
[<-RunDayOfMonth|-rdm> 1-30|LAST_DAY_OF_MONTH]
[<-RepeatCount|-rc> repeat_count]
[<-RemoveRunnableObjects|-rro> removeRunnableObjects]
[<-AddRunnableObjects|-aro> addRunnableObjects]
To configure multiple values for an argument, separate the values with commas.
The following table describes infacmd sch UpdateSchedule options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set the
-dn domain name with the -dn option or the environment
variable INFA_DEFAULT_DOMAIN. If you set a domain name
with both methods, the -dn option takes precedence.
-Password password Required if you specify the user name. Password for the
-pd user name. The password is case sensitive. You can set a
password with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password
with both methods, the password set with the -pd option
takes precedence.
UpdateSchedule 1003
Option Argument Description
-StartTime yyyy-MM-dd HH:mm Required. Date and time that the recurrence starts.
-st
-EndTime yyyy-MM-dd HH:mm Optional. Date and time that the recurrence ends.
-et
-TimeZone timezone Optional. Time zone for the schedule start time.
-tz To configure the time zone, you can enter the time zone ID
number or the Olson Database ID.
Default is locale of the client machine.
-RunDaysOfWeek mon|tue|wed|thu|fri|sat|sun Optional. Run the schedule on certain days of the week.
-rdw
-RunDayOfWeekMonth monday|tuesday| Optional. Run the schedule on certain days of the week
-rdwm wednesday|thursday|friday| every month. Use the -dre options to run the schedule every
saturday|sunday first, second, third, fourth, or last n day of the month.
-RepeatCount repeat_count Optional. End the recurrence after a number of runs instead
-rc of on a date.
RemoveRunnableObjects removeRunnableObjects Optional. Removes objects from the schedule. Enter objects
-rro in the following format:
"{mapping|workflow}:Data Integration Service/
Application/{Mapping|Workflow}[[?]
[parameterFilePath=PATH_TO_PARAMETER_FILE|
parameterSet=PARAMETER_SET_NAME]
&runAsUser=USER_NAME
&runAsUserSecurityDomain=SECURITY_DOMAIN
&runAsUserPassword=PASSWORD]]"]
-AddRunnableObjects addRunnableObjects Optional. Adds objects to the schedule. Objects that you
-aro would like to schedule. Enter the object type, followed by
the path to the object on the Data Integration Service. For
example:
"mapping:DIS_1234/Application_mapping/
Mapping_abc"
Optionally, use the following arguments to configure a
parameter file, parameter set, run as user, or operating
system profile for the object:
- parameterFilePath=PATH_TO_PARAMETER_FILE
- parameterSet=PARAMETER_SET_NAME
- runAsUser=USER_NAME
&runAsUserSecurityDomain=SECURITY_DOMAIN
&runAsUserPassword=PASSWORD
- osProfileName=OS_PROFILE_NAME
For example:
"workflow:DIS_1234/Application_workflow/
Workflow_abc?parameterFilePath=
C://Informatica/Parameter Files/Parameter.xml
&runAsUser=Administrator
&runAsUserSecurityDomain=Native
&runAsUserPassword=Administrator"
For a list of the valid time zone values, see “Valid Time Zone Parameters” on page 986.
UpdateSchedule 1005
UpdateServiceOptions
Updates the properties for the Scheduler Service. To view the current options, run the infacmd sch
ListServiceOptions command.
<-DomainName:-dn> domain_name
<-ServiceName|-sn> service_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
[<-BackupNodes|-bn> node_name1,node_name2,...]
<-Options|-o> options
The following table describes infacmd sch UpdateServiceOptions options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set the
-dn domain name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with both
methods, the -dn option takes precedence.
-Password password Required if you specify the user name. Password for the user
-pd name. The password is case sensitive. You can set a password
with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password
with both methods, the password set with the -pd option takes
precedence.
-NodeName primary node name Optional. Primary node on which the service runs.
-nn
-BackupNodes node_name1,node_name2,... Optional. Nodes on which the service can run if the primary
-bn node is unavailable.
Option Description
UpdateServiceOptions 1007
Option Description
UpdateServiceProcessOptions
Updates the properties for a Scheduler Service process. To view the current process configuration, run the
infacmd sch ListServiceProcessOptions command.
<-DomainName:-dn> domain_name
<-ServiceName|-sn> service_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
[<-NodeName|-nn> node_name]
<-Options|-o> options
The following table describes infacmd sch UpdateServiceProcessOptions options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set the
-dn domain name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with both
methods, the -dn option takes precedence.
-UserName user_name Required if the domain uses Native or LDAP authentication. User
-un name to connect to the domain. You can set the user name with
the -un option or the environment variable
INFA_DEFAULT_DOMAIN_USER. If you set a user name with both
methods, the -un option takes precedence.
Optional if the domain uses Kerberos authentication. To run the
command with single sign-on, do not set the user name. If you
set the user name, the command runs without single sign-on.
-Password password Required if you specify the user name. Password for the user
-pd name. The password is case sensitive. You can set a password
with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password with
both methods, the password set with the -pd option takes
precedence.
-SecurityDomain security_domain Required if the domain uses LDAP authentication. Optional if the
-sdn domain uses native authentication or Kerberos authentication.
Name of the security domain to which the domain user belongs.
You can set a security domain with the -sdn option or the
environment variable INFA_DEFAULT_SECURITY_DOMAIN. If you
set a security domain name with both methods, the -sdn option
takes precedence. The security domain name is case sensitive.
If the domain uses native or LDAP authentication, the default is
Native. If the domain uses Kerberos authentication, the default
is the LDAP security domain created during installation. The
name of the security domain is the same as the user realm
specified during installation.
UpdateServiceProcessOptions 1009
Option Argument Description
NodeName node_name Name of the node on which the service process runs.
-nn
Option Description
SchedulerServiceAdvancedOptions.JVMOptions Java Virtual Machine (JVM) command line options to run Java-
based programs. When you configure the JVM options, you must
set the Java SDK classpath, Java SDK minimum memory, and Java
SDK maximum memory properties.
You must set the following JVM command line options:
- Xms. Minimum heap size. Default value is 256 m.
- MaxPermSize. Maximum permanent generation size. Default is
128 m.
- Dfile.encoding. File encoding. Default is UTF-8.
HttpConfigurationOptions.KeyStoreFile Path and file name of the keystore file that contains the keys and
certificates. Required if you use HTTPS connections for the service.
You can create a keystore file with a keytool. Keytool is a utility that
generates and stores private or public key pairs and associated
certificates in a keystore file. You can use the self-signed
certificate or use a certificate signed by a certificate authority.
HttpConfigurationOptions.TrustStoreFile Path and file name of the truststore file that contains
authentication certificates trusted by the service.
SchedulerServiceSecurityOptions.HttpPort Unique HTTP port number for the Scheduler Service process when
the service uses the HTTP protocol.
Default is 6211.
SchedulerServiceSecurityOptions.HttpsPort Unique HTTPS port number for the Scheduler Service process when
the service uses the HTTPS protocol.
When you set an HTTPS port number, you must also define the
keystore file that contains the required keys and certificates.
Upgrade
Upgrades the Scheduler Service configuration. Run sch Upgrade when you upgrade to the current version of
Informatica.
<-DomainName:-dn> domain_name
<-ServiceName|-sn> service_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
The following table describes infacmd sch Upgrade options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set the
-dn domain name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with both
methods, the -dn option takes precedence.
-UserName user_name Required if the domain uses Native or LDAP authentication. User
-un name to connect to the domain. You can set the user name with
the -un option or the environment variable
INFA_DEFAULT_DOMAIN_USER. If you set a user name with both
methods, the -un option takes precedence.
Optional if the domain uses Kerberos authentication. To run the
command with single sign-on, do not set the user name. If you
set the user name, the command runs without single sign-on.
Upgrade 1011
Option Argument Description
-Password password Required if you specify the user name. Password for the user
-pd name. The password is case sensitive. You can set a password
with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password with
both methods, the password set with the -pd option takes
precedence.
-SecurityDomain security_domain Required if the domain uses LDAP authentication. Optional if the
-sdn domain uses native authentication or Kerberos authentication.
Name of the security domain to which the domain user belongs.
You can set a security domain with the -sdn option or the
environment variable INFA_DEFAULT_SECURITY_DOMAIN. If you
set a security domain name with both methods, the -sdn option
takes precedence. The security domain name is case sensitive.
If the domain uses native or LDAP authentication, the default is
Native. If the domain uses Kerberos authentication, the default
is the LDAP security domain created during installation. The
name of the security domain is the same as the user realm
specified during installation.
• CreateService, 1013
• ListServiceOptions, 1016
• ListServiceProcessOptions, 1017
• UpdateServiceOptions, 1018
• UpdateServiceProcessOptions, 1020
CreateService
Creates a Search Service. By default, the Search Service is enabled when you create it.
<-DomainName|-dn> domain_name
<-NodeName|-nn> node_name
[<-SecurityDomain|-sdn> security_domain]
<-UserName|-un> user_name
<-Password|-pd> password
<-ServiceName|-sn> service_name
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
[<-FolderPath|-fp> full_folder_path]
[<-BackupNodes|-bn> node_name1,node_name2,...]
<-SearchServicePort|-sp> search_service_port_number
<-IndexLocation|-il> search_index_location
<-ExtractionInterval|-ei> search_extraction_interval
<-RepositoryService|-rsn> model_repository_service_name
1013
<-searchUserName|-sun> username_for_search_repositories
<-searchPassword|-spd> password_for_search_repositories
[<-searchSecurityDomain|-ssd> security_domain_of_search_repositories]
The following table describes infacmd search CreateService options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set the
-dn domain name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with both
methods, the -dn option takes precedence.
-Password password Required if you specify the user name. Password for the user
-pd name. The password is case sensitive. You can set a password
with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password
with both methods, the password set with the -pd option takes
precedence.
-FolderPath full_folder_path Optional. Full path, excluding the domain name, to the folder in
-fp which you want to add the Search Service. Must be in the
following format:
/parent_folder/child_folder
Default is “/” (the domain).
-BackupNodes node_name1,node Optional. Nodes on which the service can run if the primary
-bn _name2,... node is unavailable. You can configure backup nodes if you
have high availability.
-ExtractionInterval search_extraction Interval in seconds at which the Search Service updates the
-ei _interval search index.
-RepositoryService model_repository_ Model Repository Service to associate with the Search Service.
-rsn service_name The Model Repository Service cannot be assigned to another
Search Service.
-searchUserName username_for_sea User name to access the Model Repository Service. The Model
-sun rch_repositories repository user must have the Administrator role.
CreateService 1015
ListServiceOptions
Lists the properties for a Search Service.
<-DomainName|-dn> domain_name
<-NodeName|-nn> node_name
[<-SecurityDomain|-sdn> security_domain]
<-UserName|-un> user_name
<-Password|-pd> password
<-ServiceName|-sn> service_name
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
The following table describes infacmd search ListServiceOptions options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set
-dn the domain name with the -dn option or the environment
variable INFA_DEFAULT_DOMAIN. If you set a domain
name with both methods, the -dn option takes
precedence.
-Password password Required if you specify the user name. Password for the
-pd user name. The password is case sensitive. You can set
a password with the -pd option or the environment
variable INFA_DEFAULT_DOMAIN_PASSWORD. If you set
a password with both methods, the password set with
the -pd option takes precedence.
ListServiceProcessOptions
Lists the properties of a Search Service process.
<-DomainName|-dn> domain_name
<-NodeName|-nn> node_name
[<-SecurityDomain|-sdn> security_domain]
<-UserName|-un> user_name
<-Password|-pd> password
<-ServiceName|-sn> service_name
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
The following table describes infacmd search ListServiceProcessOptions options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set
-dn the domain name with the -dn option or the environment
variable INFA_DEFAULT_DOMAIN. If you set a domain
name with both methods, the -dn option takes
precedence.
-NodeName node_name Required. Name of node where the service process runs.
-nn
ListServiceProcessOptions 1017
Option Argument Description
-Password password Required if you specify the user name. Password for the
-pd user name. The password is case sensitive. You can set
a password with the -pd option or the environment
variable INFA_DEFAULT_DOMAIN_PASSWORD. If you set
a password with both methods, the password set with
the -pd option takes precedence.
UpdateServiceOptions
Updates Search Service properties. To view current properties run the infacmd search ListServiceOptions
command.
You can change the properties while the service is running. However, you must recycle the service for
changes to take effect.
<-DomainName|-dn> domain_name
[<-SecurityDomain|-sdn> security_domain]
<-UserName|-un> user_name
<-Password|-pd> password
<-ServiceName|-sn> service_name
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
[<-Options|-o> options]
[<-BackupNodes|-bn> node_name1,node_name2,...]
The following table describes infacmd search UpdateServiceOptions options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set
-dn the domain name with the -dn option or the environment
variable INFA_DEFAULT_DOMAIN. If you set a domain
name with both methods, the -dn option takes
precedence.
UpdateServiceOptions 1019
Option Argument Description
-Password password Required if you specify the user name. Password for the
-pd user name. The password is case sensitive. You can set
a password with the -pd option or the environment
variable INFA_DEFAULT_DOMAIN_PASSWORD. If you set
a password with both methods, the password set with
the -pd option takes precedence.
-NodeName node name Optional. Node on which the Search Service runs.
-nn
-BackupNodes node_name1,node_name2,. Optional. Nodes on which the service can run if the
-bn .. primary node is unavailable. You can configure backup
nodes if you have high availability.
UpdateServiceProcessOptions
Updates properties for a Search Service process. To view current properties, run the infacmd search
ListServiceProcessOptions command.
<-DomainName|-dn> domain_name
<-NodeName|-nn> node_name
[<-SecurityDomain|-sdn> security_domain]
<-UserName|-un> user_name
<-Password|-pd> password
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-Options|-o> options
The following table describes infacmd search UpdateServiceProcessOptions options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set
-dn the domain name with the -dn option or the environment
variable INFA_DEFAULT_DOMAIN. If you set a domain
name with both methods, the -dn option takes
precedence.
-Password password Required if you specify the user name. Password for the
-pd user name. The password is case sensitive. You can set
a password with the -pd option or the environment
variable INFA_DEFAULT_DOMAIN_PASSWORD. If you set
a password with both methods, the password set with
the -pd option takes precedence.
UpdateServiceProcessOptions 1021
Option Argument Description
• ExecuteSQL, 1023
• ListColumnOptions, 1024
• ListColumnPermissions, 1026
• ListSQLDataServiceOptions, 1027
• ListSQLDataServicePermissions, 1029
• ListSQLDataServices, 1030
• ListStoredProcedurePermissions, 1032
• ListTableOptions, 1033
• ListTablePermissions, 1035
• PurgeTableCache, 1037
• RefreshTableCache , 1038
• RenameSQLDataService, 1040
• SetColumnPermissions, 1041
• SetSQLDataServicePermissions, 1043
• SetStoredProcedurePermissions, 1045
• SetTablePermissions, 1048
• StartSQLDataService, 1050
• StopSQLDataService, 1052
• UpdateColumnOptions, 1053
• UpdateSQLDataServiceOptions, 1056
• UpdateTableOptions, 1059
ExecuteSQL
Runs SQL statements that access an SQL data service.
Run infacmd sql ExecuteSQL in interactive or non-interactive mode. When you run ExecuteSQL in interactive
mode, you can enter SQL statements without writing a script. When you use the interactive mode, enter the
connect string without the -Sql option. You can run subsequent SQL statements without entering the
connection information for each statement.
1023
The infacmd sql ExecuteSQL command uses the following syntax:
ExecuteSQL
<-ConnectString|-cs> connection_string
[<-Sql> sql_statement]
The following table describes infacmd sql ExecuteSQL options and arguments:
-ConnectString connection_string Required. Enter an SQL data service connect string with the following
-cs syntax:
jdbc:informatica:sqlds/
<optional security domain\>
<optional user name>/
<optional user password>@
<domain host name>:
<domain HTTP port>?dis=
<Data Integration Service name>&sqlds=
<runtime SQL data service name>
Optionally, add options in the following format:
... &<option_name>=<option_value>
The connect string has the following option and value:
SQLDataServiceOptions.disableResultSetCache=true
Disables result set caching for a SQL data service query when the
SQL data service is configured to cache the result set.
-Sql sql_statement Optional. Enter an SQL statement if you do not want to run in
interactive mode.
ListColumnOptions
Lists the properties for columns in a virtual table.
-DomainName domain_name Required. Name of the Informatica domain. You can set the
-dn domain name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with both
methods, the -dn option takes precedence.
-ServiceName service_name Required. Name of the Data Integration Service where the
-sn application is deployed.
-Password password Required if you specify the user name. Password for the user
-pd name. The password is case sensitive. You can set a password
with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password
with both methods, the password set with the -pd option takes
precedence.
-Table schema.table Required. Name of the table. Define the table with the following
-t syntax:
<schema_name>.<table_name>
ListColumnOptions 1025
ListColumnPermissions
Lists user and group permissions for a virtual column.
<-DomainName|-dn> domain_name
<-ServiceName|-sn> service_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-SQLDataService|-sqlds> sql_data_service
<-Table|-t> schema.table
<-Column|-c> column
<<-Direct> direct_permission_only|<-Effective> effective_permission_only>
The following table describes infacmd sql ListTablePermissions options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set the
-dn domain name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with both
methods, the -dn option takes precedence.
-ServiceName service_name Required. Name of the Data Integration Service where the
-sn application is deployed.
-Password password Required if you specify the user name. Password for the user
-pd name. The password is case sensitive. You can set a password
with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password
with both methods, the password set with the -pd option takes
precedence.
-Table schema.table Required. Name of the table. Define the table with the following
-t syntax:
<schema_name>.<table_name>
-Direct | direct | effective Required. Enter either direct or effective. Direct permissions are
-Effective> permissions assigned directly to the user or group. Effective
permissions include direct permissions and inherited
permissions.
ListSQLDataServiceOptions
Lists the properties of an SQL data service that is deployed to a Data Integration Service.
<-DomainName|-dn> domain_name
<-ServiceName|-sn> service_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-SQLDataService|-sqlds> sql_data_service
ListSQLDataServiceOptions 1027
The following table describes infacmd sql ListSQLDataServiceOptions options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set the
-dn domain name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with both
methods, the -dn option takes precedence.
-ServiceName service_name Required. Name of the Data Integration Service where the
-sn application is deployed.
-Password password Required if you specify the user name. Password for the user
-pd name. The password is case sensitive. You can set a password
with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password
with both methods, the password set with the -pd option takes
precedence.
<-DomainName|-dn> domain_name
<-ServiceName|-sn> service_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-SQLDataService|-sqlds> sql_data_service
-DomainName domain_name Required. Name of the Informatica domain. You can set
-dn the domain name with the -dn option or the environment
variable INFA_DEFAULT_DOMAIN. If you set a domain
name with both methods, the -dn option takes
precedence.
-ServiceName service_name Required. Name of the Data Integration Service where the
-sn application is deployed.
-Password password Required if you specify the user name. Password for the
-pd user name. The password is case sensitive. You can set a
password with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a
password with both methods, the password set with the -
pd option takes precedence.
ListSQLDataServicePermissions 1029
Option Argument Description
ListSQLDataServices
Lists the SQL data services for a Data Integration Service.
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-ServiceName|-sn> service_name
-DomainName domain_name Required. Name of the Informatica domain. You can set the
-dn domain name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with both
methods, the -dn option takes precedence.
-Password password Required if you specify the user name. Password for the user
-pd name. The password is case sensitive. You can set a password
with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password
with both methods, the password set with the -pd option takes
precedence.
ListSQLDataServices 1031
ListStoredProcedurePermissions
Lists the permissions for a stored procedure.
<-DomainName|-dn> domain_name
<-ServiceName|-sn> service_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-SQLDataService|-sqlds> sql_data_service
<-StoredProcedure|-sp> stored_procedure
-DomainName domain_na Required. Name of the Informatica domain. You can set the
-dn me domain name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with both
methods, the -dn option takes precedence.
-ServiceName service_na Required. Name of the Data Integration Service where the
-sn me application is deployed.
-Password password Required if you specify the user name. Password for the user
-pd name. The password is case sensitive. You can set a password
with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password
with both methods, the password set with the -pd option takes
precedence.
ListTableOptions
Lists the properties for a virtual table.
<-DomainName|-dn> domain_name
<-ServiceName|-sn> service_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
ListTableOptions 1033
<-SQLDataService|-sqlds> sql_data_service
<-Table|-t> schema.table
The following table describes infacmd sql ListTableOptions options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set the
-dn domain name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with both
methods, the -dn option takes precedence.
-ServiceName service_name Required. Name of the Data Integration Service where the
-sn application is deployed.
-Password password Required if you specify the user name. Password for the user
-pd name. The password is case sensitive. You can set a password
with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password
with both methods, the password set with the -pd option takes
precedence.
-Table schema.table Required. Name of the table. Define the table with the following
-t syntax:
<schema_name>.<table_name>
ListTablePermissions
Lists user and group permissions for a virtual table.
<-DomainName|-dn> domain_name
<-ServiceName|-sn> service_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-SQLDataService|-sqlds> sql_data_service
<-Table|-t> schema.table
-DomainName domain_name Required. Name of the Informatica domain. You can set the
-dn domain name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with both
methods, the -dn option takes precedence.
-ServiceName service_name Required. Name of the Data Integration Service where the
-sn application is deployed.
ListTablePermissions 1035
Option Argument Description
-Password password Required if you specify the user name. Password for the user
-pd name. The password is case sensitive. You can set a password
with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password
with both methods, the password set with the -pd option takes
precedence.
-Table schema.table Required. Name of the table. Define the table with the following
-t syntax:
<schema_name>.<table_name>
-Direct | direct | effective Required. Enter either direct or effective. Direct permissions are
-Effective> permissions assigned directly to the user or group. Effective
permissions include direct permissions and inherited
permissions.
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-ServiceName|-sn> service_name
<-SQLDataService|-sqlds> sql_data_service
<-Table|-t> table
The following table describes infacmd sql PurgeTableCache options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set the
-dn domain name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with both
methods, the -dn option takes precedence.
-Password password Required if you specify the user name. Password for the user
-pd name. The password is case sensitive. You can set a password
with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password
with both methods, the password set with the -pd option takes
precedence.
PurgeTableCache 1037
Option Argument Description
-ServiceName service_name Required. Name of the Data Integration Service where the
-sn application is deployed.
RefreshTableCache
Refreshes a virtual table cache.
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-ServiceName|-sn> service_name
<-SQLDataService|-sqlds> sql_data_service
<-Table|-t> table
-DomainName domain_name Required. Name of the Informatica domain. You can set the
-dn domain name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with both
methods, the -dn option takes precedence.
-Password password Required if you specify the user name. Password for the user
-pd name. The password is case sensitive. You can set a password
with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password
with both methods, the password set with the -pd option takes
precedence.
-ServiceName service_name Required. Name of the Data Integration Service where the
-sn application is deployed.
RefreshTableCache 1039
RenameSQLDataService
Renames a SQL data service that is deployed to a Data Integration Service.
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-ServiceName|-sn> service_name
<-SQLDataService|-sqlds> sql_data_service
<-NewName|-n> new_name
The following table describes infacmd sql RenameSQLDataService options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set the
-dn domain name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with both
methods, the -dn option takes precedence.
-Password password Required if you specify the user name. Password for the user
-pd name. The password is case sensitive. You can set a password
with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password
with both methods, the password set with the -pd option takes
precedence.
-ServiceName service_name Required. Name of the Data Integration Service where the SQL
-sn data service is deployed.
NewName new_name Required. New name for the SQL data service.
-n
SetColumnPermissions
Denies a group or user from accessing a column in a SQL query.
<-DomainName|-dn> domain_name
<-ServiceName|-sn> service_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-SQLDataService|-sqlds> sql_data_service
<-Table|-t> schema.table
<-Column|-c> column_name
[<-GranteeSecurityDomain|-gsdn> grantee_security_domain]
<-DeniedPermissions|-dp> denied_permissions
SetColumnPermissions 1041
The following table describes infacmd sql SetColumnPermissions options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set the
-dn domain name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with both
methods, the -dn option takes precedence.
-ServiceName service_name Required. Name of the Data Integration Service where the
-sn application is deployed.
-Password password Required if you specify the user name. Password for the user
-pd name. The password is case sensitive. You can set a
password with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password
with both methods, the password set with the -pd option
takes precedence.
-SQLDataService sql_data_service Required. Name of the SQL data service with the virtual
-sqlds table.
You must prefix the SQL data service name with the
application name.
Use the following syntax:
<application_name>.<SQL_data_service_name>
-Table schema.table Required. Name of the virtual table. Enter table in the
-t following format:
<schema_name>.<table_name>
SetSQLDataServicePermissions
Sets permissions to groups or users for an SQL data service. You can also deny permissions.
<-DomainName|-dn> domain_name
<-ServiceName|-sn> service_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-SQLDataService|-sqlds> sql_data_service
[<-GranteeSecurityDomain|-gsdn> grantee_security_domain]
<-AllowedPermissions|-ap> allowed_permissions
<-DeniedPermissions|-dp> denied_permissions
SetSQLDataServicePermissions 1043
The following table describes infacmd sql SetSQLDataServicePermissions options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set
-dn the domain name with the -dn option or the environment
variable INFA_DEFAULT_DOMAIN. If you set a domain
name with both methods, the -dn option takes
precedence.
-Password password Required if you specify the user name. Password for the
-pd user name. The password is case sensitive. You can set
a password with the -pd option or the environment
variable INFA_DEFAULT_DOMAIN_PASSWORD. If you
set a password with both methods, the password set
with the -pd option takes precedence.
-GranteeSecurityDomain grantee_security_domain Required if you use LDAP authentication and you are
-gsdn granting user permissions. Name of the security
domain that the user belongs to.
SetStoredProcedurePermissions
Sets user and group permissions for a stored procedure. You can also deny permissions.
<-DomainName|-dn> domain_name
<-ServiceName|-sn> service_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-SQLDataService|-sqlds> sql_data_service
SetStoredProcedurePermissions 1045
<-StoredProcedure|-sp> stored_procedure
[<-GranteeSecurityDomain|-gsdn> grantee_security_domain]
<-AllowedPermissions|-ap> allowed_permissions
<-DeniedPermissions|-dp> denied_permissions
The following table describes infacmd sql SetStoredProcedurePermissions options and arguments:
SetStoredProcedurePermissions 1047
Option Argument Description
SetTablePermissions
Sets group and user permissions on a virtual table.
<-DomainName|-dn> domain_name
<-ServiceName|-sn> service_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-SQLDataService|-sqlds> sql_data_service
<-Table|-t> schema.table
[<-GranteeSecurityDomain|-gsdn> grantee_security_domain]
<-AllowedPermissions|-ap> allowed_permissions
<-DeniedPermissions|-dp> denied_permissions
[<-RLSPredicate|-rls> row_level_security_predicate]
SetTablePermissions 1049
Option Argument Description
-SQLDataService sql_data_service Required. Name of the SQL data service with the
-sqlds virtual table.
You must prefix the SQL data service name with
the application name.
Use the following syntax:
<application_name>.<SQL_data_service_n
ame>
StartSQLDataService
Starts an SQL data service.
<-DomainName|-dn> domain_name
<-ServiceName|-sn> service_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-SQLDataService|-sqlds> sql_data_service
The following table describes infacmd sql StartSQLDataService options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set the
-dn domain name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with both
methods, the -dn option takes precedence.
-ServiceName service_name Required. Name of the Data Integration Service where the
-sn application is deployed.
-Password password Required if you specify the user name. Password for the user
-pd name. The password is case sensitive. You can set a password
with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password
with both methods, the password set with the -pd option takes
precedence.
StartSQLDataService 1051
Option Argument Description
StopSQLDataService
Stops an SQL data service from running.
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-ServiceName|-sn> service_name
<-SQLDataService|-sqlds> sql_data_service
The following table describes infacmd sql StopSQLDataService options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set the
-dn domain name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with both
methods, the -dn option takes precedence.
-Password password Required if you specify the user name. Password for the user
-pd name. The password is case sensitive. You can set a password
with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password
with both methods, the password set with the -pd option takes
precedence.
-ServiceName service_name Required. Name of the Data Integration Service where the SQL
-sn data service is deployed.
UpdateColumnOptions
Sets column options to determine what happens when a user selects a restricted column in a query. You can
substitute the value with NULL or with a constant value.
<-DomainName|-dn> domain_name
<-ServiceName|-sn> service_name
<-UserName|-un> user_name
<-Password|-pd> password
UpdateColumnOptions 1053
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-SQLDataService|-sqlds> sql_data_service
<-Table|-t> schema.table
<-Column|-c> column_name
<-Options|-o> options
The following table describes infacmd sql UpdateColumnOptions options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set the
-dn domain name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with both
methods, the -dn option takes precedence.
-ServiceName service_name Required. Name of the Data Integration Service where the
-sn application is deployed.
-Password password Required if you specify the user name. Password for the user
-pd name. The password is case sensitive. You can set a
password with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password
with both methods, the password set with the -pd option takes
precedence.
-SQLDataService sql_data_service Required. Name of the SQL data service with the virtual table.
-sqlds You must prefix the SQL data service name with the
application name.
Use the following syntax:
<application_name>.<SQL_data_service_name>
-Table schema.table Required. Name of the virtual table. Enter table in the
-t following format:
<schema_name>.<table_name>
Column Options
Use column options to update a column. Use the column options with the infacmd sql UpdateColumnOptions
command.
Options Description
ColumnOptions.DenyWith When you use column level security, this property determines whether
to substitute the restricted column value or to fail the query. If you
substitute the column value, you can choose to substitute the value
with NULL or with a constant value.
Select one of the following options:
- ERROR. Fails the query and returns an error.
- NULL. Returns null values for a restricted column in each row.
- VALUE. Returns a constant value in place of the restricted column in
each row. Configure the constant value in the
InsufficientPermissionValue option.
ColumnOptions.InsuffiicientPermissionValue Substitutes the restricted column value with a constant value. The
default is an empty string. If you do not configure
ColumnOptions.DenyWith the Data Integration Service ignores the
InsufficientPermissionValue option.
UpdateColumnOptions 1055
UpdateSQLDataServiceOptions
Updates SQL data service properties. You must stop the SQL data service before you update the properties.
<-DomainName|-dn> domain_name
<-ServiceName|-sn> service_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-SQLDataService|-sqlds> sql_data_service
<-Options|-o> options
The following table describes infacmd sql UpdateSQLDataServiceOptions options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set the
-dn domain name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with both
methods, the -dn option takes precedence.
-ServiceName service_name Required. Name of the Data Integration Service where the
-sn application is deployed.
-Password password Required if you specify the user name. Password for the user
-pd name. The password is case sensitive. You can set a password
with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password
with both methods, the password set with the -pd option takes
precedence.
options options Required. List of options to update. Enter options and values
-o separated by spaces. To view options for a SQL data service,
run infacmd sql ListSQLDataServiceOptions.
UpdateSQLDataServiceOptions 1057
The following table describes connection options for infacmd sql UpdateSQLDataServiceOptions:
Option Description
SQLDataServiceOptions.sortOrder Sort order that the Data Integration Service uses for
sorting and comparing data when running in Unicode
mode. You can choose the sort order based on your code
page. When the Data Integration runs in ASCII mode, it
ignores the sort order value and uses a binary sort order.
Default is binary.
UpdateTableOptions
Updates virtual table properties. You must stop the SQL data service before you update the properties.
<-DomainName|-dn> domain_name
<-ServiceName|-sn> service_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-SQLDataService|-sqlds> sql_data_service
<-Table|-t> schema.table
<-Options|-o> options
UpdateTableOptions 1059
The following table describes infacmd sql UpdateTableOptions options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set the
-dn domain name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with both
methods, the -dn option takes precedence.
-ServiceName service_name Required. Name of the Data Integration Service where the
-sn application is deployed.
-Password password Required if you specify the user name. Password for the user
-pd name. The password is case sensitive. You can set a password
with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password
with both methods, the password set with the -pd option takes
precedence.
-Table schema.table Required. Name of the table. Use the following syntax:
-t <schema_name>.<table_name>
Option Description
VirtualTableOptions.CachingEnabled Cache the virtual table in the data object cache database. True or false.
Default is true.
VirtualTableOptions.CacheTableName The name of the user-managed table from which the Data Integration
Service accesses the virtual table cache. A user-managed cache table is a
table in the data object cache database that you create, populate, and
manually refresh when needed.
If you specify a cache table name, the Data Object Cache Manager does
not manage the cache for the object and ignores the cache refresh period.
If you do not specify a cache table name, the Data Object Cache Manager
manages the cache for the object.
UpdateTableOptions 1061
Chapter 35
You can create the service, add content to the service, enable the service and disable the service with
theinfacmd tdm commands.
CreateService
Creates a Test Data Manager Service in a domain.
<-DomainName|-dn> domain_name
<-ServiceName|-sn> service_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-NodeName|-nn> node_name
<-LicenseName|-ln> license_name
<-MRSServiceName|-mrs> model_repo_service
<-MRSUserName|-rsun> model_repo_service_username
<-MRSPassword|-rspd> model_repo_service_password
[<-MRSSecurityDomain|-rsdn> model_repo_security_domain]
<-EnableProfiling|-ep> enable_profiling
<-DISServiceName|-dis> data_integration_service
1062
<-DBUsername|-du> db_user
<-DBPassword|-dp> db_password
<-DBUrl|-dl> db_url
<-DBConnString|-dc> db_conn_string
[<-HttpPort> http_port]
[<-HttpsPort> https_port]
[<-KeystoreFile|-kf> keystore_file_location]
[<-KeystorePassword|-kp> keystore_password]
[<-SSLProtocol|-sp> ssl_protocol]
[<-jvmParams|-jp> jvmParameters]
[<-connPoolSize|-cp> conn_pool_size]
[<-jmxPort> jmx_port]
[<-shutdownPort> shutdown_port]
The following table describes infacmd tdm CreateService options and arguments:
CreateService 1063
Option Argument Description
-NodeName node_name Required. Name of the node where the service will
-nn run.
CreateService 1065
Option Argument Description
-KeystoreFile keystore_file_location] Optional. Keystore file that contains the keys and
-kf certificates required if you use the SSL security
protocol with PowerCenter.
-hadoopKerbKeytab Hadoop Kerberos The file path to the Kerberos keytab file on the
-hkt Keytab machine on which the Data Integration Service
runs.
Not required when you run the MapR Hadoop
distribution. Required for other Hadoop
distributions.
CreateService 1067
CreateContents
Creates repository content for the Test Data Manager repository.
[<-SecurityDomain|-sdn> security_domain]
<-UserName|-un> user_name
<-Password|-pd> password
<-ServiceName|-sn> service_name
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
The following table describes infacmd tdm CreateContents options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set
-dn the domain name with the -dn option or the environment
variable INFA_DEFAULT_DOMAIN. If you set a domain
name with both methods, the -dn option takes
precedence.
-Password password Required if you specify the user name. Password for the
-pd user name. The password is case sensitive. You can set
a password with the -pd option or the environment
variable INFA_DEFAULT_DOMAIN_PASSWORD. If you set
a password with both methods, the password set with
the -pd option takes precedence.
EnableService
Enables the Test Data Manager Service.
<-ServiceName|-sn> service_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
The following table describes infacmd tdm EnableService options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set the domain
-dn name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with both
methods, the -dn option takes precedence.
-ServiceName service_name Required. Name of the service you want to run the command
-sn against. To enter a name that contains a space or other non-
alphanumeric character, enclose the name in quotation marks.
-UserName user_name Required if the domain uses Native or LDAP authentication. User
-un name to connect to the domain. You can set the user name with the
-un option or the environment variable
INFA_DEFAULT_DOMAIN_USER. If you set a user name with both
methods, the -un option takes precedence.
Optional if the domain uses Kerberos authentication. To run the
command with single sign-on, do not set the user name. If you set
the user name, the command runs without single sign-on.
EnableService 1069
Option Argument Description
-Password password Required if you specify the user name. Password for the user name.
-pd The password is case sensitive. You can set a password with the -
pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password with
both methods, the password set with the -pd option takes
precedence.
-SecurityDomain security_domain Required if the domain uses LDAP authentication. Optional if the
-sdn domain uses native authentication or Kerberos authentication.
Name of the security domain to which the domain user belongs. You
can set a security domain with the -sdn option or the environment
variable INFA_DEFAULT_SECURITY_DOMAIN. If you set a security
domain name with both methods, the -sdn option takes precedence.
The security domain name is case sensitive.
If the domain uses native or LDAP authentication, the default is
Native. If the domain uses Kerberos authentication, the default is
the LDAP security domain created during installation. The name of
the security domain is the same as the user realm specified during
installation.
DisableService
Disables the Test Data Manager Service. When you disable the Test Data Manager Service, all the service
processes stop.
<-ServiceName|-sn> service_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
-DomainName domain_name Required. Name of the Informatica domain. You can set the domain
-dn name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with both
methods, the -dn option takes precedence.
-ServiceName service_name Required. Name of the service you want to run the command
-sn against. To enter a name that contains a space or other non-
alphanumeric character, enclose the name in quotation marks.
-UserName user_name Required if the domain uses Native or LDAP authentication. User
-un name to connect to the domain. You can set the user name with the
-un option or the environment variable
INFA_DEFAULT_DOMAIN_USER. If you set a user name with both
methods, the -un option takes precedence.
Optional if the domain uses Kerberos authentication. To run the
command with single sign-on, do not set the user name. If you set
the user name, the command runs without single sign-on.
-Password password Required if you specify the user name. Password for the user name.
-pd The password is case sensitive. You can set a password with the -
pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password with
both methods, the password set with the -pd option takes
precedence.
-SecurityDomain security_domain Required if the domain uses LDAP authentication. Optional if the
-sdn domain uses native authentication or Kerberos authentication.
Name of the security domain to which the domain user belongs.
You can set a security domain with the -sdn option or the
environment variable INFA_DEFAULT_SECURITY_DOMAIN. If you set
a security domain name with both methods, the -sdn option takes
precedence. The security domain name is case sensitive.
If the domain uses native or LDAP authentication, the default is
Native. If the domain uses Kerberos authentication, the default is
the LDAP security domain created during installation. The name of
the security domain is the same as the user realm specified during
installation.
DisableService 1071
Chapter 36
• deployApplication, 1072
• exportObjects, 1073
• exportResources, 1076
• importObjects, 1077
• patchApplication, 1081
deployApplication
Deploys an application to an .iar file.
Deploy an application to a file when the application contains a large number of objects. After you run the
infacmd tools deployApplication command, run the infacmd dis deployApplication command to deploy the
application to a Data Integration Service.
<-Password|-pd> Password
1072
The following table describes infacmd tools deployApplication options and arguments:
-DomainName Domain name Required. Name of the Informatica domain. You can set the
-dn domain name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with both
methods, the -dn option takes precedence.
-UserName User name Required if the domain uses Native or LDAP authentication.
-un User name to connect to the domain. You can set the user
name with the -un option or the environment variable
INFA_DEFAULT_DOMAIN_USER. If you set a user name with
both methods, the -un option takes precedence.
Optional if the domain uses Kerberos authentication. To run the
command with single sign-on, do not set the user name. If you
set the user name, the command runs without single sign-on.
-Password Password Required if you specify the user name. Password for the user
-pd name. The password is case sensitive. You can set a password
with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password
with both methods, the password set with the -pd option takes
precedence.
-SecurityDomain Security domain Required if the domain uses LDAP authentication. Optional if
-sdn the domain uses native authentication or Kerberos
authentication. Name of the security domain to which the
domain user belongs. You can set a security domain with the -
sdn option or the environment variable
INFA_DEFAULT_SECURITY_DOMAIN. If you set a security
domain name with both methods, the -sdn option takes
precedence. The security domain name is case sensitive.
If the domain uses native or LDAP authentication, the default is
Native. If the domain uses Kerberos authentication, the default
is the LDAP security domain created during installation. The
name of the security domain is the same as the user realm
specified during installation.
- OutputDirectory Output Directory Required. Directory where you want to write the .iar file.
-od
- ApplicationPath Application Path Required. Application path, starting with the project name,
-ap folder names, and followed by the application name. Separate
the project name, folder names, and the application name with
a slash (/). For example, "Project/Folder1/Folder2/Application".
exportObjects
Exports objects from a project in the Model repository to an XML file.
If you do not want to export all objects in the project, use an infacmd export control file to filter the Model
repository objects that you want to export.
exportObjects 1073
If the project being exported contains reference tables, you must run the command from the Informatica
services installation directory. The command exports the reference table metadata from the Model repository
to the XML file. The command exports the reference table data to a zip file. When you run the command,
specify the path and file name of both the XML and zip files to be created.
If the command fails with a Java memory error, increase the system memory available for infacmd. To
increase system memory, set the -Xmx value in the ICMD_JAVA_OPTS environment variable.
<-Password|-pd> Password
[<-OtherOptions|-oo>]
The following table describes infacmd tools exportObjects options and arguments:
-DomainName Domain name Required. Name of the Informatica domain. You can set the
-dn domain name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with both
methods, the -dn option takes precedence.
-UserName User name Required if the domain uses Native or LDAP authentication.
-un User name to connect to the domain. You can set the user
name with the -un option or the environment variable
INFA_DEFAULT_DOMAIN_USER. If you set a user name with
both methods, the -un option takes precedence.
Optional if the domain uses Kerberos authentication. To run the
command with single sign-on, do not set the user name. If you
set the user name, the command runs without single sign-on.
-Password Password Required if you specify the user name. Password for the user
-pd name. The password is case sensitive. You can set a password
with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password
with both methods, the password set with the -pd option takes
precedence.
-SecurityDomain Security domain Required if the domain uses LDAP authentication. Optional if
-sdn the domain uses native authentication or Kerberos
authentication. Name of the security domain to which the
domain user belongs. You can set a security domain with the -
sdn option or the environment variable
INFA_DEFAULT_SECURITY_DOMAIN. If you set a security
domain name with both methods, the -sdn option takes
precedence. The security domain name is case sensitive.
If the domain uses native or LDAP authentication, the default is
Native. If the domain uses Kerberos authentication, the default
is the LDAP security domain created during installation. The
name of the security domain is the same as the user realm
specified during installation.
-ProjectName Project name Required. Name of the project from which you export the
-pn objects.
-ExportFilePath Path of file to export Required. Path and XML file name of the export file to be
-fp to created. You can specify an absolute path or a relative path to
the file name.Use an easily distinguishable name for the file.
For example, use the following suggested naming convention:
exp_<project_name>
Note: The command appends the .xml file extension to the
output file.
-OverwriteExportFile Set to "true" to Optional. Set to true to overwrite an existing export file. If an
-ow overwrite export file if export file exists and this option is set to false, the export fails.
it exists. Default is false.
-ControlFilePath Path of export control Optional. Path and file name of the export control file that
-cp file filters the objects that are exported. You can specify an
absolute path or a relative path to the file name.
exportObjects 1075
exportResources
Exports the scorecard objects and lineage information in a project or folder to an XML file that you use in
Metadata Manager.
If you do not want to export all objects in the project, use an infacmd export control file to filter the objects
that you want to export. The command does not export empty folders.
If the command fails with a Java memory error, increase the system memory available for infacmd. To
increase system memory, set the -Xmx value in the ICMD_JAVA_OPTS environment variable.
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
<-ProjectName|-pn> project_name
<-RepositoryService|-rs> model_repository_service_name
<-ExportFilePath|-fp> export_file_path
[<-OverwriteExportFile|-ow> overwrite_export_file]
[<-ControlFilePath|-cp> control_file_path]
The following table describes infacmd tools exportResources options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set the
-dn domain name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with both
methods, the -dn option takes precedence.
-Password password Required if you specify the user name. Password for the user
-pd name. The password is case sensitive. You can set a password
with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password
with both methods, the password set with the -pd option takes
precedence.
-ProjectName project_name Required. Name of the project from which you export the
-pn objects.
-ExportFilePath export_file_path Required. Path and XML file name of the export file the
-fp command line program creates when you run the command.
You can specify an absolute path or a relative path to the file
name. Use an easily distinguishable name for the file. For
example, use the following suggested naming convention:
exp_<project_name>.xml
-ControlFilePath control_file_path Optional. Path and file name of the export control file that
-cp filters the objects that the command line program exports. You
can specify an absolute path or a relative path to the file name.
importObjects
Imports objects from an XML file into an existing project in the Model repository.
If you do not want to import all objects in the file, use an infacmd import control file to filter the Model
repository objects that you want to import.
If the file being imported contains reference tables, you must run the command from the Informatica services
installation directory. The command imports the reference table metadata from the XML file into the Model
repository. The command imports the reference table data from a zip file. When you run the command,
specify the path and file name of both the XML and zip files to be imported.
If the command fails with a Java memory error, increase the system memory available for infacmd. To
increase the system memory, set the -Xmx value in the ICMD_JAVA_OPTS environment variable.
importObjects 1077
The infacmd tools importObjects command uses the following syntax:
importObjects
<-Password|-pd> Password
<-ImportFilePath|-fp> import_file_path
[<-TargetFolder|-tf> Target folder to import to <omit for root, ignored if control file
is specified>]
[<-OtherOptions|-oo>]
The following table describes infacmd tools importObjects options and arguments:
-TargetProject Target Project name <ignored if Optional. Name of the project into which you
-tp control file is specified> want to import the objects. The project must
exist in the repository before you import the
objects. The option is ignored if you use an
import control file.
-RepositoryService Model Repository Service name Required. Model Repository Service name.
- rs
-ImportFilePath import_file_path Required. Path and file name of the XML file to
-fp import the objects from. You can specify an
absolute path or a relative path to the file
name.
-SourceProject Source project name in import Optional. Source project name in the file to
-sp file <ignored if control file is import. The option is ignored if you use an
specified> import control file.
-TargetFolder Target folder to import to <omit Optional. Target folder into which you want to
-tf for root, ignored if control file is import the objects. If you do not specify a
specified> target folder, the objects are imported into the
target project. The folder must exist in the
repository before you import the objects. The
option is ignored if you use an import control
file.
importObjects 1079
Option Argument Description
-SkipCRC Set to "true" to skip CRC check Indicates whether to skip the cyclic
-sc on imported file. redundancy check (CRC) that detects whether
the file to import was modified. Set to true to
skip the check. Default is false.
-ConflictResolution Resolution type specified Optional. Conflict resolution strategy. You can
-cr specify one of the following options for all
objects being imported:
- rename
- replace
- reuse
- none
The option is ignored if you use an import
control file. If the conflict resolution strategy
is set to none and a conflict occurs, the import
fails. Default is none.
-ControlFilePath Path of import control file Optional. Path and file name of the import
-cp control file that filters the objects that are
imported. You can specify an absolute path or
a relative path.
-SkipCnxValidation Set to "true" to skip connection Optional. Indicates whether to skip target
-scv validation. connection validation during the import. By
default, the import process verifies that
connections used by the imported objects exist
in the target repository. If the connections do
not exist, the import fails.
To skip target connection validation and
continue with the import, set this option to
true. If the imported objects use connections
that do not exist in the target repository, the
import process imports the objects with an
"Unspecified" connection. Use the Developer
tool to select the correct connection after the
import process has completed.
Default is false.
Note: If an import control file specifies a
source connection that does not exist in the
file that you are importing, the import process
fails regardless of the value for this option. To
correct the error, verify that the connection
rebind element in the import control file
includes source connections that exist in the
file that you are importing.
patchApplication
Deploys an application patch using a .piar file to a Data Integration Service. The Data Integration Service
applies the patch to the corresponding incremental application. The incremental application must be
deployed on the same Data Integration Service where you want to deploy the patch.
If you created the patch based on a previous version of the incremental application, the patch might not be
valid. A patch is not valid if the application objects in the patch have been updated by other application
patchApplication 1081
patches since the patch that you currently want to deploy was created. To proceed, you can force the Data
Integration Service to apply the patch.
You can also choose to retain or discard state information. State information refers to mapping properties
and the properties of run-time objects such as mapping outputs or the Sequence Generator transformation.
For more information about state information, see the "Application Deployment" chapter in the Informatica
Developer Tool Guide.
Note: If you deploy a previous version of a patch, the Data Integration Service does not roll back the
incremental application to the time that the patch was created. The Data Integration Service updates the
application based on the application objects in the patch.
<-Password|-pd> Password
-DomainName Domain Required. Name of the Informatica domain. You can set the domain name
-dn name with the -dn option or the environment variable INFA_DEFAULT_DOMAIN. If
you set a domain name with both methods, the -dn option takes
precedence.
-UserName User name Required if the domain uses Native or LDAP authentication. User name to
-un connect to the domain. You can set the user name with the -un option or
the environment variable INFA_DEFAULT_DOMAIN_USER. If you set a user
name with both methods, the -un option takes precedence.
Optional if the domain uses Kerberos authentication. To run the command
with single sign-on, do not set the user name. If you set the user name, the
command runs without single sign-on.
-Password Password Required if you specify the user name. Password for the user name. The
-pd password is case sensitive. You can set a password with the -pd option or
the environment variable INFA_DEFAULT_DOMAIN_PASSWORD. If you set a
password with both methods, the password set with the -pd option takes
precedence.
-SecurityDomain Security Required if the domain uses LDAP authentication. Optional if the domain
-sdn domain uses native authentication or Kerberos authentication. Name of the
security domain to which the domain user belongs. You can set a security
domain with the -sdn option or the environment variable
INFA_DEFAULT_SECURITY_DOMAIN. If you set a security domain name
with both methods, the -sdn option takes precedence. The security domain
name is case sensitive.
If the domain uses native or LDAP authentication, the default is Native. If
the domain uses Kerberos authentication, the default is the LDAP security
domain created during installation. The name of the security domain is the
same as the user realm specified during installation.
-DataIntegrationService Data Required. The name of the Data Integration Service where the incremental
-dis Integration application is deployed.
Service
name
-FilePath Patch file Required. Path and .piar file name of the patch to deploy. You can specify
-fp path an absolute path or a relative path to the file name.
-force True | False Optional. Use true to ignore the validity of the patch and force the Data
-f Integration Service to apply the patch to the application. Default is false.
-RetainStateInformation True | False Optional. Indicates whether state information is retained or discarded.
-rsi Note: This option overrides the setting to retain or discard state
information in the application patch archive file.
patchApplication 1083
Chapter 37
• abortWorkflow, 1084
• bulkComplete, 1086
• cancelWorkflow, 1088
• completeTask, 1090
• createTables, 1092
• delegateTask, 1094
• dropTables, 1096
• listActiveWorkflowInstances, 1097
• listMappingPersistedOutputs, 1099
• listTasks, 1100
• listWorkflowParams, 1104
• listWorkflows, 1106
• pruneOldInstances, 1107
• recoverWorkflow, 1109
• releaseTask, 1111
• setMappingPersistedOutputs, 1113
• startTask, 1115
• startWorkflow, 1116
• upgradeWorkflowParameterFile, 1118
abortWorkflow
Aborts a running workflow instance.
If an Assignment task or an Exclusive gateway is running, the Data Integration Service completes the task or
gateway. After the task aborts or completes, the service aborts the workflow instance. The service does not
start running any subsequent workflow objects.
1084
<-DomainName|-dn> domain_name
<-ServiceName|-sn> service_name
<-UserName|-un> user_name
<-Password|-pd> password
<-InstanceId|-iid> instance_id
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
The following table describes infacmd wfs abortWorkflow options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set
-dn the domain name with the -dn option or the environment
variable INFA_DEFAULT_DOMAIN. If you set a domain
name with both methods, the -dn option takes
precedence.
-Password password Required if you specify the user name. Password for the
-pd user name. The password is case sensitive. You can set
a password with the -pd option or the environment
variable INFA_DEFAULT_DOMAIN_PASSWORD. If you set
a password with both methods, the password set with
the -pd option takes precedence.
abortWorkflow 1085
Option Argument Description
bulkComplete
Stops all operations for a Human task in a workflow that you specify, and passes the records that the task
identifies to the next stage in the workflow. The bulkComplete command updates the status of the steps in
the Human task to indicate that the steps are complete. The command does not edit or update the status of
the records that the task identifies.
<-DomainName|-dn> domain_name
<-ServiceName|-sn> service_name
<-UserName|-un> user_name
<-Password|-pd> password
<-InstanceId|-iid> Instance_id
<-StepName|-sid> Step_name
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
-DomainName domain_name Required. Name of the Informatica domain. You can set
-dn the domain name with the -dn option or the environment
variable INFA_DEFAULT_DOMAIN. If you set a domain
name with both methods, the -dn option takes
precedence.
-ServiceName service_name Required. Name of the Data Integration Service that runs
-sn the workflow instance.
-Password password Required if you specify the user name. Password for the
-pd user name. The password is case sensitive. You can set
a password with the -pd option or the environment
variable INFA_DEFAULT_DOMAIN_PASSWORD. If you set
a password with both methods, the password set with
the -pd option takes precedence.
InstanceID Instance_ID Required. Unique identifier for the workflow that runs the
-iid Human task that you want to complete.
You can read the workflow instance ID from the workflow
properties on the Monitoring tab of the Administrator
tool. Or, run infacmd wfs ListActiveWorkflowInstances to
find the workflow instance ID.
StepName Step_name Required. The name of the Human task that the workflow
-sid uses to create the Human task instances.
bulkComplete 1087
Option Argument Description
cancelWorkflow
Cancels a running workflow instance. When you cancel a workflow instance, the Data Integration Service
finishes processing any running task and then stops processing the workflow instance. The service does not
start running any subsequent objects.
<-DomainName|-dn> domain_name
<-ServiceName|-sn> service_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
<-InstanceID|-iid> instance_ID
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
-DomainName domain_name Required. Name of the Informatica domain. You can set
-dn the domain name with the -dn option or the environment
variable INFA_DEFAULT_DOMAIN. If you set a domain
name with both methods, the -dn option takes
precedence.
-Password password Required if you specify the user name. Password for the
-pd user name. The password is case sensitive. You can set
a password with the -pd option or the environment
variable INFA_DEFAULT_DOMAIN_PASSWORD. If you set
a password with both methods, the password set with
the -pd option takes precedence.
cancelWorkflow 1089
Option Argument Description
completeTask
Completes a Human task instance that you specify.
A Human task instance is a set of records that a workflow assigns to a user or group for analysis in
Informatica Analyst. The completeTask command updates the status of the task instance to Complete and
passes the records in the task instance to another step in the workflow. For example, you might configure the
command to send the records to another task instance for review.
Each Human task instance has a unique task instance ID. When you run infacmd wfs completeTask, you
enter an ID value to identify the task instance to complete.
• Log in to Informatica Analyst and read the task instance ID in the Monitoring tool.
• Run infacmd wfs listTasks.
• Ask the business administrator or the user who owns the task instance. The business administrator or the
user can read the task instance ID in Informatica Analyst.
The infacmd wfs completeTask command uses the following syntax:
completeTask
<-DomainName|-dn> domain_name
<-ServiceName|-sn> service_name
<-UserName|-un> user_name
<-Password|-pd> password
<-TaskId|-tid> task_id
<-NextTask|-to> next_task
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
-DomainName domain_name Required. Name of the Informatica domain. You can set
-dn the domain name with the -dn option or the environment
variable INFA_DEFAULT_DOMAIN. If you set a domain
name with both methods, the -dn option takes
precedence.
-ServiceName service_name Required. Name of the Data Integration Service that runs
-sn the workflow instance.
-Password password Required if you specify the user name. Password for the
-pd user name. The password is case sensitive. You can set
a password with the -pd option or the environment
variable INFA_DEFAULT_DOMAIN_PASSWORD. If you set
a password with both methods, the password set with
the -pd option takes precedence.
-TaskID task_id Required. Unique identifier for the Human task instance.
-tid
-NextTask next_task Required. The name of the step in the workflow to which
-to the command passes the task instance records.
The Human task configuration in the workflow
determines the steps that the task instance records can
pass to.
completeTask 1091
Option Argument Description
createTables
Creates the database tables that store run-time metadata for the workflow. The command creates empty
tables. Identify the service that runs the workflows when you run the command.
Before you create the database tables, verify the following options on the Data Integration Service that runs
the workflows:
• The Workflow Orchestration Service module is active on the Data Integration Service.
• The Workflow Orchestration Service properties identify the connection for the database that stores the
workflow metadata.
The createTables command uses the following syntax:
createTables
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
<-ServiceName|-sn> service_name
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
-DomainName domain_name Required. Name of the Informatica domain. You can set
-dn the domain name with the -dn option or the environment
variable INFA_DEFAULT_DOMAIN. If you set a domain
name with both methods, the -dn option takes
precedence.
-Password password Required if you specify the user name. Password for the
-pd user name. The password is case sensitive. You can set
a password with the -pd option or the environment
variable INFA_DEFAULT_DOMAIN_PASSWORD. If you set
a password with both methods, the password set with
the -pd option takes precedence.
createTables 1093
delegateTask
Assigns ownership of a Human task instance to another user or group.
You might assign to another user or group a task instance when the task instance has no owner. Or, you
might assign a task instance to another user or group when the current user cannot complete the task
instance.
You can assign a task instance to a user or group if you are the task instance owner or the business
administrator on the task. You can also assign the task instance to another user or group if you are a
potential owner of the task instance. You are a potential owner if you are one of a set of users to whom the
Human task assigned the task instance and no user owns the task.
When you run infacmd wfs delegateTask, enter the task instance ID of the task instance that you want to
assign.
• Log in to Informatica Analyst and read the task instance ID in the Monitoring tool.
• Run infacmd wfs listTasks.
• Ask the business administrator or the user who owns the task instance. The business administrator or the
user can read the task instance ID in Informatica Analyst.
The infacmd wfs delegateTask command uses the following syntax:
delegateTask
<-DomainName|-dn> domain_name
<-ServiceName|-sn> service_name
<-UserName|-un> user_name
<-Password|-pd> password
<-TaskId|-tid> task_id
<-Entity|-to> to_entity
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
The following table describes infacmd wfs delegateTask options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set
-dn the domain name with the -dn option or the environment
variable INFA_DEFAULT_DOMAIN. If you set a domain
name with both methods, the -dn option takes
precedence.
-ServiceName service_name Required. Name of the Data Integration Service that runs
-sn the workflow instance.
-Password password Required if you specify the user name. Password for the
-pd user name. The password is case sensitive. You can set
a password with the -pd option or the environment
variable INFA_DEFAULT_DOMAIN_PASSWORD. If you set
a password with both methods, the password set with
the -pd option takes precedence.
delegateTask 1095
dropTables
Drops the database tables that store run-time metadata for the workflow.
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> Password
[<-SecurityDomain|-sdn> security_domain]
<-ServiceName|-sn> service_name
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
The following table describes infacmd wfs dropTables options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set
-dn the domain name with the -dn option or the environment
variable INFA_DEFAULT_DOMAIN. If you set a domain
name with both methods, the -dn option takes
precedence.
-Password Password Required if you specify the user name. Password for the
-pd user name. The password is case sensitive. You can set
a password with the -pd option or the environment
variable INFA_DEFAULT_DOMAIN_PASSWORD. If you set
a password with both methods, the password set with
the -pd option takes precedence.
-ServiceName service_name Required. Name of the service that runs the workflows
-sn for which you want to delete data.
listActiveWorkflowInstances
Lists active workflow instances. An active workflow instance is an instance on which an action can be
performed. Lists the state, workflow instance ID, workflow name, and application name for each active
workflow instance.
Active workflow instances include workflow instances that are running and workflow instances enabled for
recovery that are canceled.
<-DomainName|-dn> domain_name
<-ServiceName|-sn> service_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
listActiveWorkflowInstances 1097
The following table describes infacmd wfs listActiveWorkflowInstances options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set
-dn the domain name with the -dn option or the environment
variable INFA_DEFAULT_DOMAIN. If you set a domain
name with both methods, the -dn option takes
precedence.
-Password password Required if you specify the user name. Password for the
-pd user name. The password is case sensitive. You can set
a password with the -pd option or the environment
variable INFA_DEFAULT_DOMAIN_PASSWORD. If you set
a password with both methods, the password set with
the -pd option takes precedence.
<-DomainName|-dn> domain_name
<-ServiceName|-sn> service_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-Application|-a> application_name
<-Workflow|-wf> workflow_name
<-MappingTaskInstance|-mti> mapping_task_instance_name
The following table describes infacmd wfs listMappingPersistedOutputs options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set
-dn the domain name with the -dn option or the environment
variable INFA_DEFAULT_DOMAIN. If you set a domain
name with both methods, the -dn option takes
precedence.
-Password password Required if you specify the user name. Password for the
-pd user name. The password is case sensitive. You can set
a password with the -pd option or the environment
variable INFA_DEFAULT_DOMAIN_PASSWORD. If you set
a password with both methods, the password set with
the -pd option takes precedence.
listMappingPersistedOutputs 1099
Option Argument Description
- mti MappingTaskInstance Required. The name of a mapping task that created the
mapping outputs.
listTasks
Lists the Human task instances in the workflow database in which you have a role and that meet the filter
criteria that you specify. Use the command options to set one or more filters.
If you do not set a filter option, the command returns a list of the first ten Human task instances in the
database in which you have a role. Use the -MaxTasks option to change the number of task instances that
the command returns.
<-DomainName|-dn> domain_name
<-ServiceName|-sn> service_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-MaxTasks|-max> max_tasks]
[<-FilterByStatus|-st> READY|RESERVED|IN_PROGRESS|SUSPENDED]
[<-FilterByType|-tt> CleanseTask|ClusterTask|CleanseTaskReviewTask|ClusterTaskReviewTask]
[<-TasksOffset|-offset> tasks_offset]
[<-Role> role]
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
The following table describes the infacmd wfs listTasks options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set
-dn the domain name with the -dn option or the environment
variable INFA_DEFAULT_DOMAIN. If you set a domain
name with both methods, the -dn option takes
precedence.
-ServiceName service_name Required. Name of the Data Integration Service that runs
-sn the workflow instance.
listTasks 1101
Option Argument Description
-Password password Required if you specify the user name. Password for the
-pd user name. The password is case sensitive. You can set
a password with the -pd option or the environment
variable INFA_DEFAULT_DOMAIN_PASSWORD. If you set
a password with both methods, the password set with
the -pd option takes precedence.
-FilterByOwner e.g. Native\user_name Optional. Filters the list of the Human task instances in
-ow the workflow database by the name of the user or group
that owns the task.
-FilterByStatus READY|RESERVED| Optional. Filters the list of the Human task instances in
-st IN_PROGRESS|SUSPENDED the workflow database by the task status.
-FilterByCreationDate e.g. 2024-12-31 Optional. Filters the list of the Human task instances in
-cd the workflow database by the creation date of the tasks.
-FilterByType CleanseTask|ClusterTask| Optional. Filters the list of the Human task instances in
-tt CleanseTaskReviewTask| the workflow database by the task type.
ClusterTaskReviewTask
-FilterByDueDate e.g. 2024-12-31 Optional. Filters the list of the Human task instances in
-dd the workflow database by the task due date. The due
date indicates the current deadline for task completion.
-FilterByID e.g. 42 Optional. Filters the list of the Human task instances in
-tid the workflow database by the Human task instance ID.
-FilterByName e.g. "ExceptionStep {1 - 9}" Optional. Filters the list of the Human task instances in
-tn the workflow database by the Human task instance name
that you specify.
Do not use -FilterByName and -FilterByNameLike in the
same command.
-FilterByNameLike e.g. "Step {% - %}" Optional. Filters the list of the Human task instances in
-tnl the workflow database by the Human task name and
allows a wildcard character in the filter string. You can
use the percent (%) wildcard character.
Do not use -FilterByName and -FilterByNameLike in the
same command.
-TasksOffset tasks_offset Optional. Specifies an offset from the first task instance
-offset in the list of task instances that meet the filter criteria.
When you specify an offset, the command skips the task
instances that the offset specifies and returns a list that
begins with the next task instance that meets the filter
criteria.
You can use the -offset option with the -max option to
organize the results of successive listTasks commands.
For example, if you run infacmd wfs listTasks with a -
max value of 50, you return a list of task instances in the
range 1 through 50. If you run the command with a -max
value of 50 and an -offset value of 51, you return the list
of tasks in the range 51 through 100.
-Role -role Optional. Filters the list of the Human task instances in
the workflow database by the Human task role.
You can enter the following values:
- ADMINISTRATORS
- ALL
- OWNERS
- POTENTIAL_OWNERS
If you do not set the option, the command returns task
instances for all roles.
listTasks 1103
listWorkflowParams
Lists the parameters for a workflow and creates a parameter file that you can use when you run a workflow.
The command returns an XML file with default values that you can update. Enter the parameter file name
when you run the workflow with infacmd wfs startWorkflow.
<-DomainName|-dn> domain_name
<-ServiceName|-sn> service_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-Application|-a> application_name
<-Workflow|-wf> workflow_name
-DomainName domain_name Required. Name of the Informatica domain. You can set
-dn the domain name with the -dn option or the environment
variable INFA_DEFAULT_DOMAIN. If you set a domain
name with both methods, the -dn option takes
precedence.
-Password password Required if you specify the user name. Password for the
-pd user name. The password is case sensitive. You can set
a password with the -pd option or the environment
variable INFA_DEFAULT_DOMAIN_PASSWORD. If you set
a password with both methods, the password set with
the -pd option takes precedence.
- OutputFile output file_to_write_to Optional. Path and file name of the parameter file to
-o create. If you do not specify a file, the command
displays the parameters in the command prompt.
listWorkflowParams Output
The listWorkflowParams command returns a parameter file as an XML file with default values that you can
update.
For example, you run the listWorkflowParams command on application "MyApp" and workflow "MyWorkflow."
Workflow "MyWorkflow" has one parameter, "MyParameter."
listWorkflowParams 1105
Application element
When you define a parameter within the application top-level element, the Data Integration Service
applies the parameter value when you run the specified workflow in the specified application. You must
include at least one project element within an application/workflow element.
By default, this top-level element is in comments. Remove the comments (!-- and -->) to use this element.
Project element
When you define a parameter within a project top-level element, the Data Integration Service applies the
parameter value to the specified workflow in the project in any deployed application. The service also
applies the parameter value to any workflow that uses the objects in the project.
If you define the same parameter in a project and an application top-level element in the same parameter file,
the parameter value defined in the application element takes precedence.
listWorkflows
Lists the workflows in an application.
<-DomainName|-dn> domain_name
<-ServiceName|-sn> service_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-Application|-a> application_name
The following table describes infacmd wfs listWorkflows options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set
-dn the domain name with the -dn option or the environment
variable INFA_DEFAULT_DOMAIN. If you set a domain
name with both methods, the -dn option takes
precedence.
-Password password Required if you specify the user name. Password for the
-pd user name. The password is case sensitive. You can set
a password with the -pd option or the environment
variable INFA_DEFAULT_DOMAIN_PASSWORD. If you set
a password with both methods, the password set with
the -pd option takes precedence.
pruneOldInstances
Deletes workflow process data from the workflow database.
When the Data Integration Service runs a workflow, the workflow process writes process data to the
workflow database. Over time, the quantity of process data in the database can adversely affect the startup
performance of workflow processes. To delete the process data from the database, run the wfs
pruneOldInstances 1107
pruneOldInstances command. You can configure the command to delete all of the process data in the
workflow database. Or, you can delete the process data that the workflows generated during a time period
that you specify.
The pruneOldInstances command deletes process data only. The command does not delete any data that a
workflow instance or any object in the workflow reads or writes. Likewise, the command does not delete any
workflow object metadata.
To delete the process data, you must have the Manage Service privilege on the domain.
<-DomainName|-dn> domain_name
<-ServiceName|-sn> service_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
<-Days|-d> days
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
The following table describes infacmd wfs pruneOldInstances options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set
-dn the domain name with the -dn option or the environment
variable INFA_DEFAULT_DOMAIN. If you set a domain
name with both methods, the -dn option takes
precedence.
-Password password Required if you specify the user name. Password for the
-pd user name. The password is case sensitive. You can set
a password with the -pd option or the environment
variable INFA_DEFAULT_DOMAIN_PASSWORD. If you set
a password with both methods, the password set with
the -pd option takes precedence.
-Days days The time period for which the command deletes the
-d process data.
To calculate the time period, the command subtracts
the number of days that you specify from the date and
time at which you run the command. The command
deletes all process data that the workflow processes
generated over the time period.
Enter a value from 0 through 24855. If you enter 0, the
command deletes all process data in the workflow
database.
recoverWorkflow
Recovers a workflow instance. You can recover a workflow instance that you canceled or that was
interrupted by a recoverable error. When you recover a workflow instance, the Data Integration Service
restarts the workflow instance at the task that was interrupted and reruns the interrupted task.
<-DomainName|-dn> domain_name
<-ServiceName|-sn> service_name
<-UserName|-un> user_name
<-Password|-pd> password
<-InstanceID|-iid> instance_ID
recoverWorkflow 1109
[<-Wait|-w> true|false]
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
The following table describes infacmd wfs recoverWorkflow options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set
-dn the domain name with the -dn option or the environment
variable INFA_DEFAULT_DOMAIN. If you set a domain
name with both methods, the -dn option takes
precedence.
-ServiceName service_name Required. Name of the Data Integration Service that ran
-sn the original workflow instance.
-Password password Required if you specify the user name. Password for the
-pd user name. The password is case sensitive. You can set
a password with the -pd option or the environment
variable INFA_DEFAULT_DOMAIN_PASSWORD. If you set
a password with both methods, the password set with
the -pd option takes precedence.
releaseTask
Releases a Human task instance from the current owner. You can release a task instance if you are the owner
or the business administrator on the task instance.
When you release a task instance, the task instance has no owner. If you release a task instance that you
own, the task instance remains available to you in the Analyst tool. If the Human task identifies multiple
users as potential owners of the task instance that you release, the task instance is available to all of the
potential owners.
<-DomainName|-dn> domain_name
<-ServiceName|-sn> service_name
<-UserName|-un> user_name
<-Password|-pd> password
<-TaskId|-tid> task_id
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
releaseTask 1111
The following table describes infacmd wfs releaseTask options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set
-dn the domain name with the -dn option or the environment
variable INFA_DEFAULT_DOMAIN. If you set a domain
name with both methods, the -dn option takes
precedence.
-ServiceName service_name Required. Name of the Data Integration Service that runs
-sn the workflow instance.
-Password password Required if you specify the user name. Password for the
-pd user name. The password is case sensitive. You can set
a password with the -pd option or the environment
variable INFA_DEFAULT_DOMAIN_PASSWORD. If you set
a password with both methods, the password set with
the -pd option takes precedence.
To update a value, enter a name-value pair that contains the mapping output name and the value to change it
to. To reset a persisted value to null values, use the reset option. You can reset some of the mapping outputs
or you can reset all of the mapping outputs for a Mapping task instance. To view persisted mapping outputs,
use the infacmd listMappingPersistedOutputs command.
<-DomainName|-dn> domain_name
[<-ServiceName|-sn> service_name]
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-Application|-a> application_name
<-Workflow|-wf> workflow_name
<-MappingTaskInstance|-mti> mapping_task_instance_name]
<-outputValues|-onvp> space_separated_output_value_pairs
The following table describes infacmd wfs setMappingPersistedOutputs options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set
-dn the domain name with the -dn option or the environment
variable INFA_DEFAULT_DOMAIN. If you set a domain
name with both methods, the -dn option takes
precedence.
-ServiceName service_name Required. Name of the Data Integration Service to run the
-sn workflow. The application that contains the workflow
must be deployed to a Data Integration Service.
setMappingPersistedOutputs 1113
Option Argument Description
-Password password Required if you specify the user name. Password for the
-pd user name. The password is case sensitive. You can set
a password with the -pd option or the environment
variable INFA_DEFAULT_DOMAIN_PASSWORD. If you set
a password with both methods, the password set with
the -pd option takes precedence.
-MappingTaskInstance mappingTaskInstancenam Required. The name of a mapping task that created the
-mti e mapping outputs.
-ResetOutputs reset_outputs Optional. Removes the mapping output value from the
-reset repository. To reset specific mapping outputs, enter the
reset option with mapping output names separated by
spaces in the following syntax:
-reset mapping_output_name mapping_output2_name
mapping_output3_name
<-DomainName|-dn> domain_name
<-ServiceName|-sn> service_name
<-UserName|-un> user_name
<-Password|-pd> password
<-TaskId|-tid> task_id
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
The following table describes infacmd wfs startTask options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set
-dn the domain name with the -dn option or the environment
variable INFA_DEFAULT_DOMAIN. If you set a domain
name with both methods, the -dn option takes
precedence.
-ServiceName service_name Required. Name of the Data Integration Service that runs
-sn the workflow instance.
-Password password Required if you specify the user name. Password for the
-pd user name. The password is case sensitive. You can set
a password with the -pd option or the environment
variable INFA_DEFAULT_DOMAIN_PASSWORD. If you set
a password with both methods, the password set with
the -pd option takes precedence.
startTask 1115
Option Argument Description
startWorkflow
Starts an instance of a workflow. You can run multiple instances of a workflow at the same time. You can use
a parameter file for the workflow or a parameter set.
<-DomainName|-dn> domain_name
<-ServiceName|-sn> service_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-Application|-a> application_name
<-Workflow|-wf> workflow_name
[<-Wait|-w> true|false]
[<-ParameterFile|-pf> parameter_file_path]
[<-ParameterSet|-ps> parameter_set_name]
[<-OperatingSystemProfile|-osp> operating_system_profile_name]
The command returns the workflow instance ID.
-DomainName domain_name Required. Name of the Informatica domain. You can set
-dn the domain name with the -dn option or the environment
variable INFA_DEFAULT_DOMAIN. If you set a domain
name with both methods, the -dn option takes
precedence.
-Password password Required if you specify the user name. Password for the
-pd user name. The password is case sensitive. You can set
a password with the -pd option or the environment
variable INFA_DEFAULT_DOMAIN_PASSWORD. If you set
a password with both methods, the password set with
the -pd option takes precedence.
startWorkflow 1117
Option Argument Description
-ParameterSet parameter_set_name Optional. Name of parameter set to use at run time. The
-ps parameter set option overrides any parameter set
deployed with the application.
Do not enter a parameter file name and a parameter set
name in the same command.
upgradeWorkflowParameterFile
Upgrades a workflow parameter file so that the file format is compatible with the current release. Run the
command on workflow parameter files that users created in an Informatica 9.x release. When you run the
command, you identify a workflow parameter file to upgrade and you specify a target file.
<-DomainName|-dn> domain_name
<-ServiceName|-sn> service_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-Application|-a> application_name
<-Workflow|-wf> workflow_name
-DomainName domain_name Required. Name of the Informatica domain. You can set
-dn the domain name with the -dn option or the environment
variable INFA_DEFAULT_DOMAIN. If you set a domain
name with both methods, the -dn option takes
precedence.
-Password password Required if you specify the user name. Password for the
-pd user name. The password is case sensitive. You can set
a password with the -pd option or the environment
variable INFA_DEFAULT_DOMAIN_PASSWORD. If you set
a password with both methods, the password set with
the -pd option takes precedence.
upgradeWorkflowParameterFile 1119
Option Argument Description
-Workflow workflow_name Required. Name of the workflow that reads the values
-wf parameter file.
-ParameterFile parameter file path Required. Name and location of the parameter file that
-pf contains the values to upgrade.
-TargetOutputFile parameter file path Required. Name and location of the output file from the
-of command. The output file contains the valid parameters
for the current release.
• ListOperationOptions, 1121
• ListOperationPermissions, 1123
• ListWebServiceOptions, 1125
• ListWebServicePermissions, 1126
• ListWebServices, 1128
• RenameWebService, 1129
• SetOperationPermissions, 1131
• SetWebServicePermissions, 1133
• StartWebService, 1136
• StopWebService, 1138
• UpdateOperationOptions, 1139
• UpdateWebServiceOptions, 1141
ListOperationOptions
Lists the properties of a web service operation that is deployed to a Data Integration Service.
<-DomainName|-dn> domain_name
<-ServiceName|-sn> service_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-WebService|-ws> web_service
<-Operation|-op> operation
1121
The following table describes infacmd ws ListOperationOptions options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set the
-dn domain name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with both
methods, the -dn option takes precedence.
-ServiceName service_name Required. Name of the Data Integration Service where the web
-sn service is deployed.
-Password password Required if you specify the user name. Password for the user
-pd name. The password is case sensitive. You can set a password
with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password
with both methods, the password set with the -pd option takes
precedence.
Operation operation Required. Name of the web service operation to list properties
-op for.
<-DomainName|-dn> domain_name
<-ServiceName|-sn> service_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-WebService|-ws> web_service
<-Operation|-op> operation
ListOperationPermissions 1123
Option Argument Description
<-DomainName|-dn> domain_name
<-ServiceName|-sn> service_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-WebService|-ws> web_service
The following table describes infacmd ws ListWebServiceOptions options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set the
-dn domain name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with both
methods, the -dn option takes precedence.
-ServiceName service_name Required. Name of the Data Integration Service where the web
-sn service is deployed.
-Password password Required if you specify the user name. Password for the user
-pd name. The password is case sensitive. You can set a password
with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password
with both methods, the password set with the -pd option takes
precedence.
ListWebServiceOptions 1125
Option Argument Description
ListWebServicePermissions
Lists group and user permissions for a web service that is deployed to a Data Integration Service. You must
indicate direct or effective permissions.
<-DomainName|-dn> domain_name
<-ServiceName|-sn> service_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-WebService|-ws> web_service
ListWebServicePermissions 1127
Option Argument Description
ListWebServices
Lists the web services for an application. If you do not enter an application name, infacmd lists all the web
services for a Data Integration Service.
<-DomainName|-dn> domain_name
<-ServiceName|-sn> service_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-WebService|-ws> web_service
[<-Application|-a> application]
The following table describes infacmd ws ListWebServices options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set the
-dn domain name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with both
methods, the -dn option takes precedence.
-ServiceName service_name Required. Name of the Data Integration Service where the web
-sn services are deployed.
-Password password Required if you specify the user name. Password for the user
-pd name. The password is case sensitive. You can set a password
with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password
with both methods, the password set with the -pd option takes
precedence
-application application Optional. Name of the application to list web services for.
-ap
RenameWebService
Rename a web service.
<-DomainName|-dn> domain_name
<-ServiceName|-sn> service_name
<-UserName|-un> user_name
RenameWebService 1129
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-WebService|-ws> web_service
<-NewName|-n> new_name
-DomainName domain_name Required. Name of the Informatica domain. You can set the
-dn domain name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with both
methods, the -dn option takes precedence.
-ServiceName service_name Required. Name of the Data Integration Service where the web
-sn service is deployed.
-Password password Required if you specify the user name. Password for the user
-pd name. The password is case sensitive. You can set a password
with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password
with both methods, the password set with the -pd option takes
precedence
SetOperationPermissions
Sets the user or group permissions for a web service operation. You can set permissions or deny permissions
for a user or group.
<-DomainName|-dn> domain_name
<-ServiceName|-sn> service_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-WebService|-ws> web_service
<-Operation|-op> operation
<-GranteeUserName|-gun> grantee_user_name|
<-GranteeGroupName|-ggn> grantee_group_name>
[<-GranteeSecurityDomain|-gsdn> grantee_security_domain]
[<-AllowedPermissions|-ap> list_of_allowed_permissions_separated_by_space]
[<-DeniedPermissions|-dp> list_of_denied_permissions_separated_by_space]
The following table describes infacmd ws SetOperationPermissions options and arguments:
SetOperationPermissions 1131
Option Argument Description
SetWebServicePermissions
Sets user or group permissions for a web service. You can set permissions or deny the permissions for one
user or group.
<-DomainName|-dn> domain_name
<-ServiceName|-sn> service_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-WebService|-ws> web_service
SetWebServicePermissions 1133
<-GranteeUserName|-gun> grantee_user_name|
<-GranteeGroupName|-ggn> grantee_group_name>
[<-GranteeSecurityDomain|-gsdn> grantee_security_domain]
[<-AllowedPermissions|-ap> list_of_allowed_permissions_separated_by_space]
[<-DeniedPermissions|-dp> list_of_denied_permissions_separated_by_space]
The following table describes infacmd ws SetWebServicePermissions options and arguments:
SetWebServicePermissions 1135
Option Argument Description
StartWebService
Starts a web service that is deployed to a Data Integration Service.
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-ServiceName|-sn> service_name
<-WebService|-ws> web_service
-DomainName domain_name Required. Name of the Informatica domain. You can set the
-dn domain name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with both
methods, the -dn option takes precedence.
-Password password Required if you specify the user name. Password for the user
-pd name. The password is case sensitive. You can set a password
with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password
with both methods, the password set with the -pd option takes
precedence.
-ServiceName service_name Data Integration Service name where the web service is
-sn deployed.
StartWebService 1137
StopWebService
Stops a running web service.
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-ServiceName|-sn> service_name
<-WebService|-ws> web_service
The following table describes infacmd ws StopWebService options and arguments:
-DomainName domain_name Required. Name of the Informatica domain. You can set the
-dn domain name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with both
methods, the -dn option takes precedence.
-Password password Required if you specify the user name. Password for the user
-pd name. The password is case sensitive. You can set a password
with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password
with both methods, the password set with the -pd option takes
precedence.
-ServiceName service_name Data Integration Service name where the web service is
-sn deployed.
UpdateOperationOptions
Updates properties for a web service operation that is deployed to a Data Integration Service.
<-DomainName|-dn> domain_name
<-ServiceName|-sn> service_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-WebService|-ws> web_service
<-Operation|-op> operation
<-Options|-o> options
-DomainName domain_name Required. Name of the Informatica domain. You can set the
-dn domain name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with both
methods, the -dn option takes precedence.
-ServiceName service_name Required. Name of the Data Integration Service where the web
-sn service is deployed.
UpdateOperationOptions 1139
Option Argument Description
-Password password Required if you specify the user name. Password for the user
-pd name. The password is case sensitive. You can set a password
with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password
with both methods, the password set with the -pd option takes
precedence
-Options options Enter the web service option in the following format:
-o> options ... -o option_type.option_name=value
Operation Options
Use operation options to update a web service operation. Use the operation options with infacmd ws
UpdateOperationOptions.
Option Description
UpdateWebServiceOptions
Update the properties for a web service that is deployed to a Data Integration Service. To view the properties
for the web service you can use infacmd ws ListWebServiceOptions.
<-DomainName|-dn> domain_name
<-ServiceName|-sn> service_name
<-UserName|-un> user_name
<-Password|-pd> password
[<-SecurityDomain|-sdn> security_domain]
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-WebService|-ws> web_service
<-Options|-o> options
-DomainName domain_name Required. Name of the Informatica domain. You can set the
-dn domain name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with both
methods, the -dn option takes precedence.
-ServiceName service_name Required. Name of the Data Integration Service where the web
-sn service is deployed.
UpdateWebServiceOptions 1141
Option Argument Description
-Password password Required if you specify the user name. Password for the user
-pd name. The password is case sensitive. You can set a password
with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password
with both methods, the password set with the -pd option takes
precedence
Option Description
WebServiceOptions.startupType Determines whether the web service is enabled to run when the
application starts or when you start the web service. Enter
enabled or disabled.
WebServiceOptions.sortOrder Sort order that the Data Integration Service uses to sort and
compare data when running in Unicode mode. Default is binary.
WebServiceOptions.EnableTransportLayerSecurity Indicates that the web service must use HTTPS. If the Data
Integration Service is not configured to use HTTPS, the web
service will not start. Enter true or false.
UpdateWebServiceOptions 1143
Option Description
WebServiceOptions.optimizeLevel The optimizer level that the Data Integration Service applies to
the object. Enter the numeric value that is associated with the
optimizer level that you want to configure. You can enter one
of the following numeric values:
- 0. The Data Integration Service does not apply optimization.
- 1. The Data Integration Service applies the early projection
optimization method.
- 2. The Data Integration Service applies the early projection,
early selection, push-into, and predicate optimization
methods.
- 3. The Data Integration Service applies the cost-based, early
projection, early selection, push-into, predicate, and semi-
join optimization methods.
WebServiceOptions.DTMKeepAliveTime Number of milliseconds that the DTM instance stays open after
it completes the last request. Web service requests that are
issued against the same operation can reuse the open
instance. Use the keep alive time to increase performance
when the time required to process the request is small
compared to the initialization time for the DTM instance. If the
request fails, the DTM instance terminates.
Must be an integer. A negative integer value means that the
DTM Keep Alive Time for the Data Integration Service is used.
0 means that the Data Integration Service does not keep the
DTM instance in memory. Default is -1.
• generateReadableViewXML, 1145
• updateExportXML, 1146
generateReadableViewXML
Generates a readable XML file from an export XML file. The export XML file can contain exported domain or
Model repository contents.
The command infacmd xrf generateReadableViewXML simplifies the process of editing an export XML file by
exposing the values that you can edit. Use the readable XML file to modify values generated from the export
XML file. For example, if you export a mapping saved in the Model repository, you can change the names of
columns or edit the precision and scale of data types. If you want to make structural changes to values in the
export XML file, use the Administrator tool or the Developer tool depending on whether you exported domain
or Model repository contents.
<-SourceExportFile|-sxf> source_export_file
<-TargetFile|-tf> target_file_Name
The following table describes infacmd xrf generateReadableViewXML options and arguments:
-SourceExportFile source_export_file Required. Path and file name of the export XML file.
-sxf
-TargetFile target_file_Name Required. Path and file name of the readable XML file.
-tf
1145
updateExportXML
Updates an export XML file with the changes made to the corresponding readable XML file. You can update a
readable XML file that contains Model repository contents and regenerate the export XML file with the
changes.
<SourceExportFile|-sxf> source_file
<generatedViewFile|-vf> view_file
<TargetFile|-tf> target_file_Name
The following table describes infacmd xrf updateExportXML options and arguments:
-SourceExportFile source_file Required. Path and file name of the export XML file.
-sxf
-generatedViewFile view_file Required. Path and file name of the readable XML file that
-vf contains the required changes.
-TargetFile target_file_Name Required. Path and file name of the updated export XML file.
-tf
• Export control file. Use an export control file to specify the objects to export from the domain or Model
repository to an export file.
• Import control file. Use an import control file to specify the objects to import from the export file into the
domain or Model repository.
If you do not use an export control file during export, infacmd does not filter the objects exported from the
domain or the specified Model repository project. If you do not use an import control file during import into
the domain, infacmd imports all objects included in the export file. If you do not use an import control file
during import into the Model repository, infacmd imports all objects included in the specified project in the
export file.
1147
You can access the schema files as part of the oie-util.jar in the following installation directory:
<InformaticaInstallationDir>/services/shared/jars/shapp
To access exportControl.xsd and importControl.xsd from the command line, navigate to the oie-util.jar
location and extract the jar file with the following command:
Also, you can extract the oie-util jar with decompression software, such as WinRAR, or view the xsd files from
the oie-util jar with the Java decompiler to access the schema files.
To create an export control file, create an XML file based on the exportControl.xsd schema file. The file must
begin with an XML declaration and the location of the hosted schema file in the exportParams root element.
Include the following lines in the file:
<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
<exportParams xmlns="http://www.informatica.com/oie/exportControl/9">
...
</exportParams>
To create an import control file, create an XML file based on the importControl.xsd schema file. The file must
begin with an XML declaration and the location of the hosted schema file in the importParams root element.
Include the following lines in the file:
<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
<importParams xmlns="http://www.informatica.com/oie/importControl/9">
...
</importParams>
Include the remaining elements and attributes in the XML file based on the objects that you want to export or
import.
Add a prefix to each file name to indicate whether it is an export or import control file. For example, use the
following suggested naming conventions:
You can use an export control file with the following commands:
Exports native users, native groups, roles, connections, and cluster configurations from the domain to an
export file in XML format. When you specify an export control file for the command, you filter the objects
that you want to export. For example, use a control file to export all objects created after a certain date
or to export connections but no other object types.
Exports all Model repository object types from a specified project to an export file in XML format. When
you specify an export control file for the command, you filter the objects that you want to export. For
example, use a control file to export all objects created by a specific user or to export specific object
types in the project.
Infacmd does not export empty folders. When you export Model repository objects, infacmd also exports
the dependent objects. A dependent object is an object that is used by another object. Dependent
objects can be in the same or different projects.
An export control file uses different parameters based on whether you configure the file to export domain
objects or Model repository objects.
An export control file for domain objects can contain the following elements:
objectList type Required. Type of domain object to export. Specify one of the following
values:
- User
- Group
- Role
- Cluster configuration.
- Connection
The value is not case sensitive.
objectList createdBefore Optional. Date and time. Exports objects of the specified type created
before this date and time. Enter the date and time in the following format:
yyyy-MM-dd HH:mm:ssZ
objectList createdAfter Optional. Date and time. Exports objects of the specified type created after
this date and time. Enter the date and time in the following format:
yyyy-MM-dd HH:mm:ssZ
objectList lastUpdatedBefor Optional. Date and time. Exports objects of the specified type updated
e before this date and time. Enter the date and time in the following format:
yyyy-MM-dd HH:mm:ssZ
objectList lastUpdatedAfter Optional. Date and time. Exports objects of the specified type updated after
this date and time. Enter the date and time in the following format:
yyyy-MM-dd HH:mm:ssZ
object name Required. Name of the object to export. If the containing objectList element
includes a time attribute, infacmd exports objects that match both the
specified object name and the time filter. The value is not case sensitive.
<!-- Export groups created before the specified date and time. -->
<objectList type="group" createdBefore="2010-11-12 10:00:00 +0530" />
<!-- Export role1 and role2 if created after the specified date and time. -->
<objectList type="role" createdAfter="2010-12-25 10:00:00 +0530">
<object name="role1" />
<object name="role2" />
</objectList>
An export control file for Model repository objects can contain the following elements:
path Optional. Path of the folder that contains the objects you want to export. Use the following
format:
"/<folder_name>/<folder_name>"
For example, if a project contains a folder named F1, then the folder path of F1 is "/F1." To
export all objects in the project, specify "/." The value is not case sensitive. Default is "/."
recursive Optional. Indicates whether to export objects from subfolders of the specified folder. Set to true
to export from subfolders. Valid values are true and false. The value is case sensitive. Default is
true.
select Optional. Indicates whether infacmd exports all remaining objects in the specified folder when
you define an objectList element for the folder. Set to all to export all remaining objects. For
example, the following lines export mappings that were created by user1. The lines export all
remaining objects in the specified folder:
<folder path="/Testfolder" select="all">
<objectList type="Mapping" createdBy="user1" />
</folder>
If you define an objectList element and do not use the select attribute, then infacmd exports
objects that satisfy the attributes defined in objectList. For example, the following lines export
mappings that were created by user1 in the specified folder:
<folder path="/Testfolder">
<objectList type="Mapping" createdBy="user1" />
</folder>
If you do not define an objectList element for the folder, then the default value of the select
attribute is all. For example, the following line exports all objects in the specified folder:
<folder path="/Testfolder" />
Valid value is all.
createdBy Optional. User name. Exports objects created by this user. The value is not case sensitive.
createdBefore Optional. Date and time. Exports objects created before this date and time. Enter the date and
time in the following format:
yyyy-MM-dd HH:mm:ssZ
createdAfter Optional. Date and time. Exports objects created after this date and time. Enter the date and time
in the following format:
yyyy-MM-dd HH:mm:ssZ
lastUpdatedBefor Optional. Date and time. Exports objects updated before this date and time. Enter the date and
e time in the following format:
yyyy-MM-dd HH:mm:ssZ
lastUpdatedAfter Optional. Date and time. Exports objects updated after this date and time. Enter the date and
time in the following format:
yyyy-MM-dd HH:mm:ssZ
lastUpdatedBy Optional. User name. Exports objects that were last updated by this user. The value is not case
sensitive.
type Required. Type of Model repository object to export from the specified folder path. Valid values
include all object types present in the Model repository. You can view the type of the object in the
Properties view in the Developer tool. For example, you can enter "Relational Data Object" or
"Profile." The value is not case sensitive.
createdBy Optional. User name. Exports objects of the specified type created by this user. The value is not
case sensitive.
createdBefore Optional. Date and time. Exports objects of the specified type created before this date and time.
Enter the date and time in the following format:
yyyy-MM-dd HH:mm:ssZ
createdAfter Optional. Date and time. Exports objects of the specified type created after this date and time.
Enter the date and time in the following format:
yyyy-MM-dd HH:mm:ssZ
lastUpdatedBefor Optional. Date and time. Exports objects of the specified type updated before this date and time.
e Enter the date and time in the following format:
yyyy-MM-dd HH:mm:ssZ
lastUpdatedAfter Optional. Date and time. Exports objects of the specified type updated after this date and time.
Enter the date and time in the following format:
yyyy-MM-dd HH:mm:ssZ
lastUpdatedBy Optional. User name. Exports objects of the specified type that were last updated by this user.
The value is not case sensitive.
The following table describes the configurable attribute for the object element in the export control file:
name Required. Name of the object to export. If the containing objectList element includes a user or
time attribute, infacmd exports objects that match both the specified object name and the user or
time filter. The value is case sensitive.
<!-- Consider exporting all objects in the project. Do not export from subfolders. -->
<folder recursive="false" select="all">
You can use an import control file with the following commands:
Imports native users, native groups, roles, connections, and cluster configurations from an export file
into a domain. When you specify an import control file for the command, you can complete the following
tasks:
• Filter the objects that you want to import. For example, use the control file to import a specific object
type.
• Configure conflict resolution strategies for specific object types or objects.
Imports Model repository objects from an export file into a Model repository. When you specify an
import control file for the command, you can complete the following tasks:
• Filter the objects that you want to import. For example, use the control file to import a specific object
type.
• Configure conflict resolution strategies for specific object types or objects.
• Map connections in the source repository to connections in the target repository.
Dependent Model repository objects may exist in different folders or projects. You must include all
dependent objects using folderMap elements in the import control file. Otherwise, the import might fail
with an error message because a dependent object does not exist in the target repository.
You can define a conflict resolution strategy through the command line or control file when you import the
objects. The control file takes precedence if you define conflict resolution in the command line and control
file. The import fails if there is a conflict and you did not define a conflict resolution strategy.
If you define the rename conflict resolution strategy, you can specify a name in the control file for a specific
object. Or, infacmd can generate a name by appending a sequential number to the end of the name.
An import control file uses different parameters based on whether you configure the file to import domain
objects or Model repository objects.
An import control file for domain objects can contain the following elements:
objectList type Required. Type of domain object that you want to import. Specify one of the
following values:
- User
- Group
- Role
- Cluster configuration
- Connection
The value is not case sensitive.
objectList select Optional. Indicates whether infacmd imports all remaining objects of the
specified type when you define an object element for the objectList. Set to
all to import all remaining objects. For example, the following lines import
Group1 with a Reuse resolution strategy. The lines import all remaining
groups with a Merge resolution strategy:
<objectList type="group" select="all" resolution="merge">
<object name="Group1" resolution="reuse" />
</objectList>
If you define an object element and do not use the select attribute, then
infacmd imports objects that satisfy the attributes defined in the object
element. For example, the following lines import Group1 with a Merge
resolution strategy:
<objectList type="group" resolution="merge">
<object name="Group1" />
</objectList>
If you do not define an object element for the objectList, then the default
value of the select attribute is all. For example, the following line imports all
groups with a Merge resolution strategy:
<objectList type="group" resolution="merge" />
Valid value is all.
objectList resolution Optional. Resolution strategy when a name conflict occurs. Applies to all
objects of the specified type. Specify one of the following values:
- Replace. Replace target object with the source object.
- Rename. Rename source object using a generated name, and then import
it.
You cannot use the Rename option with the cluster configuration type.
- Reuse. Reuse object in the target domain.
- Merge. Merge the objects into one object. This option is applicable for
groups.
The values are not case sensitive.
object name Required. Name of a specific object to import of the specified object type.
The value is not case sensitive.
object resolution Optional. Resolution strategy when a name conflict occurs for this object.
Specify one of the following values:
- Replace. Replace target object with the source object.
- Rename. Rename source object, and then import it.
You cannot use the Rename option with the cluster configuration type.
- Reuse. Reuse object in the target domain.
- Merge. Merge the objects into one object. This option is applicable for
groups.
The values are not case sensitive.
object renameTo Optional. Name to use when the conflict resolution strategy is Rename. If
you do not specify a name, then infacmd generates a name by appending a
number to the end of the name. Infacmd ignores the value if there are no
conflicts or if the conflict resolution strategy is not Rename.
object renameIdTo Optional. ID string to use when you import a connection object and the
conflict resolution strategy is Rename. If you do not specify a connection ID,
then infacmd generates an ID by appending a number to the end of the
connection ID. Infacmd ignores the value if there are no conflicts or if the
conflict resolution strategy is not Rename.
An import control file for Model repository objects can contain the following elements:
• importParams. Can contain a single folderMaps element and a single connectionInfo element.
• folderMaps. Can contain multiple folderMap elements.
• folderMap. Contains attributes to filter objects in a specific folder. Can contain multiple objectList
elements.
• objectList. Contains attributes to filter objects by type. Can contain multiple object elements.
• object. Contains attributes to filter objects by name.
• connectionInfo. Can contain a single rebindMap element.
sourceProject Required. Name of the source project in the export file that contains the objects you want to
import. The value is not case sensitive.
sourceFolderPath Optional. Path of the source folder in the export file that contains the objects you want to
import. Use the following format:
"/<folder_name>/<folder_name>"
For example, if a project contains a folder named F1, then the folder path of F1 is "/F1." To
consider importing all objects in the project, specify "/." The value is not case sensitive. Default
is "/."
targetProject Required. Name of the project in the target repository into which you want to import objects.
The project must exist in the repository before you import the objects. The value is not case
sensitive.
targetFolderPath Optional. Path of the folder in the target repository into which you want to import objects. Use
the following format:
"/<folder_name>/<folder_name>"
For example, if a project contains a folder named F1, then the folder path of F1 is "/F1." To
import all objects into the target project, specify "/." The folder must exist in the repository
before you import the objects. The value is not case sensitive. Default is "/."
recursive Optional. Indicates whether to import objects from subfolders of the specified folder. Set to true
to import from subfolders. Valid values are true and false. The value is case sensitive. Default is
true.
select Optional. Indicates whether infacmd imports all remaining objects in the specified project when
you define an objectList element for the folderMap. Set to all to import all remaining objects.
For example, the following lines import mappings with a Reuse resolution strategy. The lines
import all remaining objects with a Replace resolution strategy:
<folderMap sourceProject="p1" targetProject="p2" select="all"
resolution="replace">
<objectList type="Mapping" resolution="reuse" />
</folderMap>
If you define an objectList element and do not use the select attribute, then infacmd imports
objects that satisfy the attributes defined in objectList. For example, the following lines import
mappings with a Replace resolution strategy:
<folderMap sourceProject="p1" targetProject="p2" resolution="replace">
<objectList type="Mapping" />
</folderMap>
If you do not define an objectList element for the folderMap, then the default value is all. For
example, the following line imports all objects with a Replace resolution strategy:
<folderMap sourceProject="p1" targetProject="p2" resolution="replace" />
Valid value is all.
resolution Optional. Resolution strategy when a name conflict occurs. Applies to all objects in this folder.
Specify one of the following values:
- Rename. Rename source object using a generated name, and then import it.
- Replace. Replace target object with the source object.
- Reuse. Reuse object in the target Model repository.
- None.
The values are not case sensitive. Default is none.
type Required. Type of Model repository object to import to the specified folder path. Valid values
include all object types present in the Model repository. You can view the type of the object in
the Properties view in the Developer tool. For example, you can enter "Relational Data Object" or
"Profile." The value is not case sensitive.
select Optional. Indicates whether infacmd imports all remaining objects of the specified type when
you define an object element for the objectList. Set to all to import all remaining objects. For
example, the following lines import MyMapping with a Reuse resolution strategy. The lines
import all remaining mappings with a Replace resolution strategy:
<folderMap sourceProject="p1" targetProject="p2">
<objectList type="Mapping" select="all" resolution="replace">
<object name="MyMapping" resolution="reuse" />
</objectList>
</folderMap>
If you define an object element and do not use the select attribute, then infacmd imports objects
that satisfy the attributes defined in the object element. For example, the following lines import
the mapping named MyMapping with a Replace resolution strategy:
<folderMap sourceProject="p1" targetProject="p2">
<objectList type="Mapping" resolution="replace">
<object name="MyMapping"/>
</objectList>
</folderMap>
If you do not define an object element for the objectList, then the default value is all. For
example, the following lines import all mappings with a Replace resolution strategy:
<folderMap sourceProject="p1" targetProject="p2">
<objectList type="Mapping" resolution="replace" />
</folderMap>
Valid value is all.
resolution Optional. Resolution strategy when a name conflict occurs. Applies to all objects of the
specified type. Specify one of the following values:
- Rename. Rename source object using a generated name, and then import it.
- Replace. Replace target object with the source object.
- Reuse. Reuse object in the target Model repository.
- None.
The values are not case sensitive. Default is none.
The following table describes the configurable attributes for the object element in the import control file:
name Required. Name of a specific object to import of the specified object type. The value is not
case sensitive.
resolution Optional. Resolution strategy when a name conflict occurs for this object. Specify one of the
following values:
- Rename. Rename source object, and then import it.
- Replace. Replace target object with the source object.
- Reuse. Reuse object in the target Model repository.
- None.
The values are not case sensitive. Default is none.
renameTo Optional. Name to use when the conflict resolution strategy is Rename. If you do not specify a
name, then infacmd generates a name by appending a number to the end of the name. Infacmd
ignores the value if there are no conflicts or if the conflict resolution strategy is not Rename.
renameIdTo Optional. ID string to use when you import a connection object and the conflict resolution
strategy is Rename. If you do not specify a connection ID, then infacmd generates an ID by
appending a number to the end of the connection ID. Infacmd ignores the value if there are no
conflicts or if the conflict resolution strategy is not Rename.
The following table describes the configurable attributes for the rebind element in the import control file:
source Required. Name of a source connection in the file that you are importing. The value is not case
sensitive.
target Required. Name of a connection in the target Model repository to map to the source
connection. By default, the connection must exist in the target repository before you import
the objects. If the connection does not exist, the import fails. When you run infacmd, you can
choose to skip target connection validation during the import. When you skip target
connection validation, the import succeeds if a connection does not exist in the target
repository. The value is not case sensitive.
<! -- Import all remaining mappings with the Replace resolution strategy. -->
</objectList>
<! -- Import all Aggregator transformations with the Replace resolution strategy. -->
<objectList type="Aggregator" resolution="replace"/>
<! -- Map connections in the source repository to connections in the target repository.
-->
<connectionInfo>
<rebindMap>
<rebind source="src_Conn1" target="tgt_Conn1"/>
<rebind source="src_Conn2" target="tgt_Conn2"/>
</rebindMap>
</connectionInfo>
</importParams>
To export users created after 2010-12-25 10:00:00 +0530, you might create the following control file:
<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
<exportParams xmlns="http://www.informatica.com/oie/exportControl/9">
<objectList type="user" createdAfter="2010-12-25 10:00:00 +0530" />
</exportParams>
Export and Import Domain Objects by Type
To export all users, groups, and roles but not connections from a domain, you might create the following
control file:
<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
<exportParams xmlns="http://www.informatica.com/oie/exportControl/9">
<objectList type="group"/>
<objectList type="role" />
<objectList type="user" />
</exportParams>
To import the users and groups but not roles into the target domain, you might create the following
control file:
<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
<importParams xmlns="http://www.informatica.com/oie/importControl/9">
<objectList type="group" resolution="merge"/>
You want to export all users and groups and the Developer and Analyst roles from the source domain.
You want to export specific connections if they were created after 2011-02-01 16:00:00-0800. You might
create the following control file:
<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
<exportParams xmlns="http://www.informatica.com/oie/exportControl/9">
<objectList type="group"/>
<objectList type="user" />
<objectList type="role">
<object name="Developer" />
<object name="Analyst" />
</objectList>
<objectList type="connection" createdAfter="2011-02-01 16:00:00-0800">
<object name="Connection1" />
<object name="Connection2" />
<object name="Connection3" />
</objectList>
</exportParams>
To import all users and groups and specific roles and connections into the target domain, you might
create the following control file:
<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
<importParams xmlns="http://www.informatica.com/oie/importControl/9">
<objectList type="group" resolution="reuse" />
<objectList type="user" resolution="reuse" />
<objectList type="role">
<object name="Developer" resolution="replace" />
<object name="Analyst" resolution="replace" />
</objectList>
<objectList type="connection">
<object name="Connection1" resolution="rename" renameTo="ProdConnection1" />
<object name="Connection2" resolution="rename" renameTo="ProdConnection2" />
<object name="Connection3" resolution="rename" renameTo="ProdConnection3" />
</objectList>
</importParams>
To export all objects in a folder named Folder1 that were created before 2011-02-01 16:00:00-0800, you
might create the following control file:
<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
<exportParams xmlns="http://www.informatica.com/oie/exportControl/9">
<folders>
<folder path="/Folder1" createdBefore="2011-02-01 16:00:00-0800" />
</folders>
</exportParams>
To export all objects in the project last updated by Administrator, you might create the following control
file:
<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
<exportParams xmlns="http://www.informatica.com/oie/exportControl/9">
<folders>
<folder lastUpdatedBy="Administrator" />
</folders>
</exportParams>
Export and Import Model Repository Objects by Type
To export all mappings from a folder named Folder1, you might create the following control file:
<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
<exportParams xmlns="http://www.informatica.com/oie/exportControl/9">
<folders>
<folder path="/Folder1" />
<objectList type="Mapping" />
</folder>
</folders>
</exportParams>
You want to export all mappings created by user2 and export all remaining objects created by user1. The
createdBy attribute defined for the child objectList element overrides the same attribute defined for the
parent folder element. You might create the following control file:
<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
<exportParams xmlns="http://www.informatica.com/oie/exportControl/9">
<folders>
<folder path="/Folder1" select="all" createdBy="user1" />
<objectList type="Mapping" createdBy="user2" />
</folder>
</folders>
</exportParams>
You want to import all mappings from the export file. Some of the mappings exported from Folder1
contain dependent objects that existed in Folder2 in the source repository. To import dependent objects,
you must include all dependent objects using folderMap elements in the import control file. You also
want to map the connections in the source repository to connections in the target repository. You might
create the following control file:
<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
<importParams xmlns="http://www.informatica.com/oie/importControl/9">
<folderMaps>
<folderMap sourceProject="DevProject" sourceFolderpath="/Folder1"
targetProject="TestProject" targetFolderPath="/TestFolder1" resolution="reuse">
<objectList type="Mapping" />
</folderMap>
<folderMap sourceProject="DevProject" sourceFolderpath="/Folder2"
targetProject="TestProject" targetFolderPath="/TestFolder2" resolution="reuse" />
</folderMaps>
<connectionInfo>
<rebindMap>
<rebind source="src_connection1" target="tgt_connection1" />
<rebind source="src_connection2" target="tgt_connection2" />
</rebindMap>
</connectionInfo>
</importParams>
Export and Import Model Repository Objects by Name
You want to export a mapping named TestMapping that was created after 2010-11-11 23:59:59-0800.
You want to export all remaining objects in the same folder. You might create the following control file:
<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
<exportParams xmlns="http://www.informatica.com/oie/exportControl/9">
<folders>
Using infasetup
infasetup is a command line program that you use to administer Informatica domains and nodes.
1164
Use infasetup to modify domain and node properties after you install Informatica services with the
Informatica installation program. For example, you can use infasetup to change the port number for a node
after you install Informatica services on the node.
You can use infasetup to back up, restore, define, and delete domains, and to define and update nodes.
Running Commands
You invoke infasetup from the command line. You can issue commands directly or from a script, batch file, or
other program. On Windows, infasetup is a batch file with a .bat extension. On UNIX, infasetup is a script file
with a .sh extension.
Command Options
When you run infasetup, you enter options for each command, followed by the required arguments. Command
options are preceded by a hyphen and are not case sensitive. Arguments follow the option.
For example, the following command updates a worker node with the name “Node1” and the address
“Host1:9090”:
infasetup UpdateWorkerNode -nn Node1 -na Host1:9090
If you omit or incorrectly enter one of the required options, the command fails, and infasetup returns an error
message.
Use the DOS or UNIX echo command immediately after running an infasetup command to see the return code
for the command:
• BackupDomain
• DefineDomain
• DefineGatewayNode
• DeleteDomain
• RestoreDomain
• UpdateGatewayNode
The following table lists the connection string syntax for each supported database:
Oracle Oracle:
jdbc:informatica:oracle://host_name:port;SID=sid
Oracle RAC:
jdbc:informatica:oracle://host_name:port; ServiceName=[Service
Name];AlternateServers=(server2:port);LoadBalancing=true
BackupDomain
Backs up the configuration metadata for the domain. infasetup stores the backup domain metadata in a
backup file with an extension of .mrep.
You must shut down the domain before you run this command.
When you run this command, infasetup backs up the domain configuration database tables to restore the
domain to another database. You must back up the ISP_RUN_LOG table contents manually to get the
previous workflow and session logs.
If the command fails with a Java memory error, increase the system memory available for infasetup. To
increase the system memory, set the -Xmx value in the INFA_JAVA_CMD_OPTS environment variable.
<<-DatabaseAddress|-da> database_hostname:database_port|
<-DatabaseConnectionString|-cs> database_connection_string>
[<-DatabaseUserName|-du> database_user_name]
[<-DatabasePassword|-dp> database_password]
<-DatabaseType|-dt> database_type
[<-DatabaseServiceName|-ds> database_service_name]
<-BackupFile|-bf> backup_file_name
[<-Tablespace|-ts> tablespace_name]
<-DomainName|-dn> domain_name
[<-DatabaseTlsEnabled|-dbtls> database_tls_enabled]
[<-DatabaseTruststorePassword|-dbtp> database_truststore_password]
[<-EncryptionKeyLocation|-kl> encryption_key_location]
[<-DatabaseTruststoreLocation|-dbtl> database_truststore_location]
The following table describes infasetup BackupDomain options and arguments:
-BackupFile backup_file_name Required. Name and path for the backup file. If you do
-bf not specify a file path, infasetup creates the backup file
in the current directory.
BackupDomain 1167
Option Argument Description
-DatabaseTruststorePassword database_truststore_pa Optional. Password for the database truststore file for
-dbtp ssword the secure database.
-DatabaseTruststoreLocation database_truststore_loc Path and file name of the truststore file for the secure
-dbtl ation domain repository database. Required if you configure a
secure domain repository database for the domain.
DefineDomain
Creates a domain on the current machine. If you define a domain on a machine that hosts a domain, you
must first stop the Informatica services on the machine. infasetup removes the existing domain and node
settings. After you define the new domain, restart Informatica services.
To create a domain on a Windows machine, you must first open the host port or disable the firewall.
Do not include any characters after the option (-f) in the DefineDomain command. If you include extra
characters, the command might fail with an unexpected error.
[<-DatabaseUserName|-du> database_user_name]
[<-DatabasePassword|-dp> database_password]
[<-DatabaseServiceName|-ds> database_service_name]
[<-Tablespace|-ts> tablespace_name]
[<-DatabaseTlsEnabled|-dbtls> database_tls_enabled]
[<-DatabaseTruststorePassword|-dbtp> database_truststore_password]
<-DomainName|-dn> domain_name
[<-DomainDescription|-de> domain_description]
<-AdministratorName|-ad> administrator_name
[<-Password|-pd> password]
[<-LicenseName|-ln> license_name]
[<-LicenseKeyFile|-lf> license_key_file]
<-LogServiceDirectory|-ld> log_service_directory
[<-SystemLogDirectory|-sld> system_log_directory]
<-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]
DefineDomain 1169
[<-EnableSaml|-saml> true|false]
[<-IdpUrl|-iu> identity_provider_url]
[<-ServiceProviderId|-spid> service_provider_id]
[<-ClockSkewTolerance|-cst> clock_skew_tolerance_in_seconds]
[<-AssertionSigningCertificateAlias|-asca> idp_assertion_signing_certificate_alias]
[<-SamlTrustStoreDir|-std> saml_truststore_directory]
[<-SamlTrustStorePassword|-stp> saml_truststore_password]
[<-EnablePasswordComplexity|-pc> enable_password_complexity]
[<-AdminconsolePort|-ap> admin_tool_port]
[<-HttpsPort|-hs> admin_tool_https_port]
[<-KeystoreFile|-kf> admin_tool_file_location]
[<-KeystorePass|-kp> admin_tool_keystore_password]
<-MinProcessPort|-mi> minimum_port
<-MaxProcessPort|-ma> maximum_port
[<-ServerPort|-sv> server_shutdown_port]
[<-AdminconsoleShutdownPort|-asp> admin_tool_shutdown_port]
[<-BackupDirectory|-bd> backup_directory]
[<-ServiceResilienceTimeout|-sr> timeout_period_in_seconds]
[<-ErrorLogLevel|-el> FATAL_ERROR_WARNING_INFO_TRACE_DEBUG]
<-ResourceFile|-rf> resource_file
[<-Timezone|-tz> log_service_timezone_GMT+00:00]
[<-Force|-f>]
[<-DatabaseTruststoreLocation|-dbtl> database_truststore_location]
The following table describes the infasetup DefineDomain options and arguments:
DefineDomain 1171
Option Argument Description
-LicenseName license_name Optional. Name of the license. The name is not case
-ln sensitive and must be unique within the domain. The
name cannot exceed 79 characters, have leading or
trailing spaces, or contain carriage returns, tabs, or the
following characters:
/*?<>"|
-NodeAddress node_host:port Required. Host name and port number for the machine
-na hosting the node. Choose an available port number.
-NodeKeystore- node_keystore_directory Optional if you use the default SSL certificates from
-nk 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 node_keystore_password Optional if you use the default SSL certificates from
-nkp Informatica. Required if you use your SSL certificates.
Password for the keystore infa_keystore.jks file.
-CipherWhiteListFile absolute_filename_containing_com Optional. Absolute file name of the plain text file that
-cwlf ma_separated_white_list_jsse_ciph contains a comma-separated list of cipher suites that
er_names you want to add to the effective list.
Note: The list must contain at least one valid JRE or
OpenSSL cipher suite.
DefineDomain 1173
Option Argument Description
-CipherBlackListFile absolute_filename_containing_com Optional. Absolute file name of the plain text file that
-cblf ma_separated_black_list_jsse_ciphe contains a comma-separated list of cipher suites that
r_names you want to remove from the effective list.
Note: The effective list must contain at least one valid
JRE or OpenSSL cipher suite.
-NodeTruststore node_truststore_directory Optional if you use the default SSL certificates from
-nt Informatica. 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.
-ServiceRealmName realm_name_of_node_spn Optional. Name of the Kerberos realm that the domain
-srn 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.COMPAN
Y.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 realm_name_of_user_spn Optional. Name of the Kerberos realm that the domain
-urn 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.COMPAN
Y.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 Infa_keys_directory_location Optional. Directory where all keytab files and the
-kd encryption key for the Informatica domain are stored.
Default is <Informatica installation
directory>/isp/config/keys.
-SPNShareLevel SPNShareLevel Optional. Indicates the service principal level for the
-spnSL PROCESS|NODE domain. Set the property to one of the following levels:
- Process. The domain requires a unique service
principal name (SPN) and keytab file for each node
and each service on a node. The number of SPNs and
keytab files required for each node depends on the
number of service processes that run on the node.
Use the node level option if the domain does not
require a high level of security.
- Node. The domain uses one SPN and keytab file for
the node and all services that run on the node. It also
requires a separate SPN and keytab file for all HTTP
processes on the node.
Default is process.
-idpUrl identity_provider_url Required if the -saml option is true. Specify the SAML
-iu identity provider URL.
-ServiceProviderId service_provider_id Optional. The relying party trust name or the service
-spid provider identifier for the domain as defined in the
identity provider.
If you specified "Informatica" as the relying party trust
name in AD FS, you do not need to specify a value.
DefineDomain 1175
Option Argument Description
-KeystoreFile admin_tool_file_location Optional. Keystore file that contains the keys and
-kf certificates required if you use the SSL security
protocol.
-ErrorLogLevel fatal Optional. Severity level for log events in the domain
-el error log. Default is info.
warning
info
trace
debug
DefineDomain 1177
Option Argument Description
-TimeZone log_service_timezone_GMT+00:00 Optional. Time zone used by the Log Manager when it
-tz generates log event files. Default is GMT+00:00.
Configure the time zone in the following format:
GMT(+/-)hh:mm
- database_truststore_location Path and file name of the truststore file for the secure
DatabaseTruststore domain repository database. Required if you configure
Location a secure domain repository database for the domain.
-dbtl
If you run DefineDomain on a node that currently hosts a domain, reconfigure the following domain
properties:
• Application services. Recreate any application service that ran on the domain.
• Users. Recreate users.
• Gateway nodes. Configure the gateway nodes in the domain.
• General domain properties. Configure resilience timeout and maximum restart attempts for the domain.
• Grids. Recreate any grid in the domain.
• LDAP authentication. Configure LDAP authentication for the domain.
• Log Manager properties. Configure the Log Manager shared directory path, purge properties, and time
zone.
If you change the gateway node host name or port number, you must also add each node to the domain using
the infacmd AddDomainNode command.
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.
<-DatabaseAddress|-da> database_hostname:database_port|<-DatabaseConnectionString|-cs>
database_connection_string
[<-DatabasePassword|-dp> database_password]
[<-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> true|false]
[<-ServiceRealmName|-srn> realm_name_of_node_spn]
[<-UserRealmName|-urn> realm_name_of_user_spn]
[<-KeysDirectory|-kd> Infa_keys_directory_location]
[<-EnableSaml|-saml> true|false]
[<-AssertionSigningCertificateAlias|-asca> idp_assertion_signing_certificate_alias]
[<-SamlTrustStoreDir|-std> saml_truststore_directory]
[<-SamlTrustStorePassword|-stp> saml_truststore_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]
DefineGatewayNode 1179
[<-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]
[<-DatabaseTlsEnabled|-dbtls> database_tls_enabled]
[<-DatabaseTruststorePassword|-dbtp> database_truststore_password]
[<-DatabaseTruststoreLocation|-dbtl> database_truststore_location]
The following table describes infasetup DefineGatewayNode options and arguments:
-NodeAddress node_host:port Optional. Host name and port number for the machine
-na hosting the node. Choose an available port number.
-NodeKeystore node_keystore_directory Optional if you use the default SSL certificates from
-nk 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 node_keystore_password Optional if you use the default SSL certificates from
-nkp Informatica. Required if you use your SSL certificates.
Password for the keystore infa_keystore.jks file.
DefineGatewayNode 1181
Option Argument Description
-NodeTruststore node_truststore_directory Optional if you use the default SSL certificates from
-nt 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 node_truststore_password Optional if you use the default SSL certificates from
-ntp Informatica. Required if you use your SSL certificates.
Password for the infa_truststore.jks file.
-CipherWhiteListFile absolute_filename_contai Optional. Absolute file name of the plain text file that
-cwlf ning contains a comma-separated list of cipher suites that
_comma_ separated_white you want to add to the effective list.
Note: The list must contain at least one valid JRE or
_list_jsse _cipher_names OpenSSL cipher suite.
-CipherBlackListFile absolute_filename_contai Optional. Absolute file name of the plain text file that
-cblf ning contains a comma-separated list of cipher suites that
_comma_ separated_black you want to remove from the effective list.
Note: The effective list must contain at least one valid
_list_jsse_cipher_names JRE or OpenSSL cipher suite.
-ServiceRealmName realm_name_of_node_spn Optional. Name of the Kerberos realm that the domain
-srn 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 realm_name_of_user_spn Optional. Name of the Kerberos realm that the domain
-urn 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 Infa_keys_directory_locati Optional. Directory where all keytab files and the
-kd on encryption key for the Informatica domain are stored.
Default is <InformaticaInstallationDir>/isp/
config/keys.
DefineGatewayNode 1183
Option Argument Description
-HttpsPort admin_tool_https_port Optional. Port number that the node uses for
-hs 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 admin_tool_keystore_file_l Optional. Keystore file that contains the keys and
-kf ocation certificates required if you use the SSL security
protocol.
-KeystorePass admin_tool_keystore_pass Optional. A plain-text password for the keystore file. You
-kp word 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.
-SystemLogDirectory system_log_directory Optional. Directory path to store system log files. Verify
-sld that -ld does not match or contain the specified -sld
value. Default is <INFA_home>/logs.
-ErrorLogLevel fatal Optional. Severity level for log events in the domain log.
-el error Default is info.
warning
info
trace
debug
- database_truststore_locat Path and file name of the truststore file for the secure
DatabaseTruststoreLocation ion domain repository database. Required if you configure a
-dbtl secure domain repository database for the domain.
DefineGatewayNode 1185
Related Topics:
• “AddDomainNode” on page 333
DefineWorkerNode
Defines a worker node on the current machine. infasetup creates the nodemeta.xml file that stores the
configuration metadata for the node. If you run this command on an existing node, it overwrites the node
configuration metadata. After you define the node, run infacmd isp AddDomainNode to add it to the domain.
-DomainName domain_name Required. Name of the domain the worker node links to.
-dn
-NodeName node_name Required. Name of the node. Node names must be between 1
-nn and 79 characters and cannot contain spaces or the following
characters: \ / * ? < > " |
-NodeAddress node_host:port Required. Host name and port number for the machine hosting
-na the node. Choose an available port number.
-ServiceManagerPort service_manager_port Optional. Port number used by the Service Manager to listen for
-sp incoming connection requests.
-NodeKeystore node_keystore_director Optional if you use the default SSL certificates from Informatica.
-nk y 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 node_keystore_passwo Optional if you use the default SSL certificates from Informatica.
-nkp rd Required if you use your SSL certificates. Password for the
keystore infa_keystore.jks file.
-NodeTruststore node_truststore_direct Optional if you use the default SSL certificates from Informatica.
-nt ory 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 node_truststore_passw Optional if you use the default SSL certificates from Informatica.
-ntp ord Required if you use your SSL certificates. Password for the
infa_truststore.jks file.
DefineWorkerNode 1187
Option Argument Description
-ServiceRealmName realm_name_of_node_ Optional. Name of the Kerberos realm that the domain uses to
-srn spn 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 realm_name_of_user_s Optional. Name of the Kerberos realm that the domain uses to
-urn pn 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 Infa_keys_directory_lo Optional. Directory where all keytab files and the encryption key
-kd cation for the Informatica domain are stored. Default is
<InformaticaInstallationDir>/isp/config/keys.
-HttpsPort admin_tool_https_port Optional. Port number that the node uses for communication
-hs 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.
-NodeKeystoreFile admin_tool_keystore_fi Optional. Keystore file that contains the keys and certificates
-kf le_location required if you use the SSL security protocol.
-KeystorePass admin_tool_keystore_p Optional. A plain-text password for the keystore file. You can set
-kp assword 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.
-GatewayAddress domain_gateway_host: Required. Gateway host machine name and port number.
-dg port
-UserName user_name Required if the domain uses Native or LDAP authentication. User
-un name to connect to the domain. You can set the user name with
the -un option or the environment variable
INFA_DEFAULT_DOMAIN_USER. If you set a user name with both
methods, the -un option takes precedence.
Optional if the domain uses Kerberos authentication. To run the
command with single sign-on, do not set the user name. If you
set the user name, the command runs without single sign-on.
-SecurityDomain security domain Name of the security domain that you want to create to which
-sdn the domain user belongs. You can set a security domain with the
-sdn option or the environment variable
INFA_DEFAULT_SECURITY_DOMAIN. If you set a security domain
name with both methods, the -sdn option takes precedence. The
security domain name is case sensitive.
You can specify a value for ‑sdn or use the default based on the
authentication mode:
- Required if the domain uses LDAP authentication. Default is
Native. To work with LDAP authentication, you need to specify
the value for -sdn.
- Optional if the domain uses native authentication or Kerberos
authentication. Default is native for native authentication. If
the domain uses Kerberos authentication, the default is the
LDAP security domain created during installation. The name
of the security domain is the same as the user realm specified
during installation.
-Password password Required if you specify the user name. Password for the user
-pd name. The password is case sensitive. You can set a password
with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password with
both methods, the password set with the -pd option takes
precedence.
-ServerPort server_shutdown_port Optional. TCP/IP port number used by the Service Manager. The
-sv 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.
-ErrorLogLevel fatal Optional. Severity level for log events in the domain log. Default
-el error is info.
warning
info
trace
debug
DefineWorkerNode 1189
Option Argument Description
-ResourceFile resource_file Required. File that contains the list of available resources for
-rf the node. Use the file nodeoptions.xml, located in the following
directory: <INFA_HOME>\isp\bin.
-SystemLogDirectory system_log_directory Optional. Directory path to store system log files. Default is
-sld <INFA_home>/logs.
DeleteDomain
Deletes domain metadata tables. Before you run this command, you must stop the Informatica services on
the machine. To delete a domain on a Windows machine, you must also open the host port or disable the
firewall.
If the command fails with a Java memory error, increase the system memory available for infasetup. To
increase the system memory, set the -Xmx value in the INFA_JAVA_CMD_OPTS environment variable.
<<-DatabaseAddress|-da> database_hostname:database_port|
<-DatabaseConnectionString|-cs> database_connection_string>
[<-DatabaseUserName|-du> database_user_name]
[<-DatabasePassword|-dp> database_password]
[<-DatabaseServiceName|-ds> database_service_name]
[<-Tablespace|-ts> tablespace_name]
[<-SchemaName|-sc> schema_name (used for Microsoft SQL Server and PostgreSQL only)]
[<-DatabaseTlsEnabled|-dbtls> database_tls_enabled]
[<-DatabaseTruststorePassword|-dbtp> database_truststore_password]
[<-EncryptionKeyLocation|-kl> encryption_key_location]
[<-DatabaseTruststoreLocation|-dbtl> database_truststore_location]
DeleteDomain 1191
Option Argument Description
-DatabaseTruststoreLocation database_truststore_location Path and file name of the truststore file for the
-dbtl secure domain repository database. Required if
you configure a secure domain repository
database for the domain.
GenerateEncryptionKey
Generate an encryption key to secure sensitive data, such as passwords, in the Informatica domain.
<-Keyword|-kw> keyword
<-DomainName|-dn> domain_name
[<-EncryptionKeyLocation|-kl> encryption_key_location]
-Keyword keyword Required. The text string used as the base word
-kw from which to generate an encryption key.
The keyword must meet the following criteria:
- From 8 to 20 characters long
- Includes at least one uppercase letter
- Includes at least one lowercase letter
- Includes at least one number
- Does not contain spaces
Help
The Help command displays the options and arguments for a command. If you omit the command name,
infasetup lists all commands.
- command Optional. Name of command. If you omit the command name, infasetup lists all
commands.
Help 1193
ListDomainCiphers
Display one or more of the following cipher suite lists: blacklist, default list, effective list, or whitelist.
Blacklist
List of cipher suites that you want the Informatica domain to block. When you add a cipher suite to the
blacklist, the Informatica domain removes the cipher suite from the effective list. You can add cipher
suites that are on the default list to the blacklist.
Default list
Whitelist
List of cipher suites that you want the Informatica domain to support in addition to the default list. When
you add a cipher suite to the whitelist, the Informatica domain adds the cipher suite to the effective list.
You do not need to add cipher suites that are on the default list to the whitelist.
[<-domainConfig|-dc> true|false]
Note: You cannot run this command on a worker node.
-domainConfig true Optional. Display the cipher suite lists for the Informatica domain or for the gateway
-dc false node where you run the command. By default, the command displays cipher suite lists
for the domain.
Set this option to true to display the cipher suite lists for the domain.
Set this option to false to display the cipher suite list for the gateway node where you
run the command.
Note: You cannot view whitelists or blacklists on gateway nodes.
MigrateEncryptionKey
Change the encryption key used to secure sensitive data, such as passwords, in the Informatica domain.
MigrateEncryptionKey
[<-IsDomainMigrated|-mig> is_domain_migrated]
The following table describes infasetup MigrateEncryptionKey options and arguments:
-LocationOfEncryptionKeys location_of_encryption_ Required. Directory in which the old encryption key file
-loc keys named siteKey_old and the new encryption key file
named siteKey are stored.
The directory must contain the old and new encryption
key files. If the old and new encryption key files are
stored in different directories, copy the encryption key
files to the same directory.
If the domain has multiple nodes, this directory must be
accessible to any node in the domain where you run the
migrateEncryptionKey command.
RestoreDomain
Restores the configuration metadata for the domain from a backup .mrep file. If you have a backup file from
an earlier version of Informatica, you must use the earlier version to restore the domain.
You must shut down the domain before you run this command.
If you restore the domain into a database other than the original backup database, you must restore the
ISP_RUN_LOG table contents to get the previous workflow and session logs.
If the command fails with a Java memory error, increase the system memory available for infasetup. To
increase the system memory, set the -Xmx value in the INFA_JAVA_CMD_OPTS environment variable.
<<-DatabaseAddress|-da> database_hostname:database_port|
<-DatabaseConnectionString|-cs> database_connection_string>
[<-DatabaseUserName|-du> database_user_name]
[<-DatabasePassword|-dp> database_password]
<-DatabaseType|-dt> database_type
RestoreDomain 1195
[<-DatabaseServiceName|-ds> database_service_name]
<-BackupFile|-bf> backup_file_name
[<-Force|-f>]
[<-ClearNodeAssociation|-ca>]
[<-Tablespace|-ts> tablespace_name]
[<-DatabaseTlsEnabled|-dbtls> database_tls_enabled]
[<-DatabaseTruststorePassword|-dbtp> database_truststore_password]
[<-EncryptionKeyLocation|-kl> encryption_key_location]
[<-DatabaseTruststoreLocation|-dbtl> database_truststore_location]
-BackupFile backup_file_name Required. Name and path for the backup file. If you do
-bf not specify a file path, infasetup creates the backup file
in the current directory.
-DatabaseTruststorePassword database_truststore_pa Optional. Password for the database truststore file for
-dbtp ssword the secure database.
-DatabaseTruststoreLocation database_truststore_lo Optional. Path and file name of the truststore file for
-dbtl cation the secure database. Required if you configure a secure
domain repository database for the domain.
RestoreDomain 1197
restoreMitKerberosLinkage
Restores the linkages to the default Kerberos libraries that the Informatica domain uses for Kerberos
authentication. The command also removes linkages to any custom Kerberos libraries that exist within the
Informatica domain.
SwitchToKerberosMode
Configure the Informatica domain to use Kerberos authentication.
<-administratorName|-ad> administrator_name
<-ServiceRealmName|-srn> realm_name_of_node_spn
<-UserRealmName|-urn> realm_name_of_user_spn
-ServiceRealmName realm_name_of_node_sp Required. Name of the Kerberos realm that the domain
-srn n 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
SwitchToKerberosMode 1199
Option Argument Description
-UserRealmName realm_name_of_user_sp Required. Name of the Kerberos realm that the domain
-urn n 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
SPNShareLevel SPNShareLevel Optional. Indicates the service principal level for the
-spnSL PROCESS|NODE] domain. Set the property to one of the following levels:
- Process. The domain requires a unique service
principal name (SPN) and keytab file for each node
and each service on a node. The number of SPNs and
keytab files required for each node depends on the
number of service processes that run on the node.
Recommended for production domains.
- Node. The domain uses one SPN and keytab file for
the node and all services that run on the node. It also
requires a separate SPN and keytab file for all HTTP
processes on the node. Recommended for test and
development domains. Recommended for test and
development domains.
Default is process.
UpdateDomainCiphers
Update the Informatica domain to use a new effective list. Modify the whitelist to add cipher suites to the
effective list. Modify the blacklist to remove cipher suites from the effective list.
Before you run the command verify that the following requirements are met:
• The domain uses secure communication within the domain or secure connections to web clients.
• The domain is shutdown.
• You are able to run the command on a gateway node in the domain.
The effective list of cipher suites contains the cipher suites that the Informatica domain supports. When you
run the UpdateDomainCiphers command, the Informatica domain creates the effective list of cipher suites
based on the following lists:
Blacklist
List of cipher suites that you want the Informatica domain to block. When you add a cipher suite to the
blacklist, the Informatica domain removes the cipher suite from the effective list. You can add cipher
suites that are on the default list to the blacklist.
Whitelist
List of cipher suites that you want the Informatica domain to support in addition to the default list. When
you add a cipher suite to the whitelist, the Informatica domain adds the cipher suite to the effective list.
You do not need to add cipher suites that are on the default list to the whitelist.
Consider the following guidelines when you run the UpdateDomainCiphers command:
• When you run the command, you create a new effective that overrides the previous effective list.
• When you run the command and specify a whitelist or blacklist, the new whitelist or blacklist overwrites
the previous list.
• The effective list includes the cipher suites in the default list and whitelist and excludes the cipher suites
in the blacklist.
• When you run the command and do not specify a white or blacklist, the command creates an effective list
that uses the cipher suites in the default list.
• The effective list must contain at least one cipher suite that TLS v1.1 or 1.2 supports.
• The effective list must be a valid cipher suite for Windows, the Java Runtime Environment, and OpenSSL.
For more information about how to create whitelists and blacklists to update the effective list that the
Informatica domain uses, see the Informatica Security Guide.
[<-cipherWhiteList|-cwl> ciphersuite1,ciphersuite2,...]
[<-cipherWhiteListFile|-cwlf> whitelist_file_name]
[<-cipherBlackList|-cbl> ciphersuite1,ciphersuite2,...]
[<-cipherBlackListFile|-cblf> blacklist_file_name]
The following table describes infasetup UpdateDomainCiphers options and arguments:
UpdateDomainCiphers 1201
Option Argument Description
updateDomainName
Changes the domain name in the domain configuration database.
Before you update the domain name, you must back up the domain, the site specific key, and keytab files. If
the PowerCenter repository contains a global repository, you must unregister all local repositories from the
global repository.
To update the domain name, run the infasetup updateDomainName command from any gateway node.
1. Run the updateGatewayNode and updateWorkerNode commands with the updated domain name for all
the gateway and worker nodes.
2. You can register the local repository with a connected global repository with the updated domain name
with the pmrep Register command.
3. You can create SPN and keytab files with the updated domain name for Kerberos authentication. Copy
the keytab files in the keys directory. You can continue to use the older site key file. If you need to
regenerate the site key when it is missing or corrupted, you must provide the older domain name.
4. You must configure the Informatica clients to use the updated domain name.
-DomainName domain_name Required. Changes the domain name. Domain names must be between 1 and 79
-dn characters and cannot contain spaces or the following characters: / * ? < > " |
UpdateGatewayNode
Updates connectivity information for a gateway node on the current machine. Before you update the gateway
node, run the infacmd isp ShutDownNode command to shut down the node.
UpdateGatewayNode 1203
The following table describes infasetup UpdateGatewayNode options and arguments:
-NodeName node_name Optional. Name of the node. Node names must be between
-nn 1 and 79 characters and cannot contain spaces or the
following characters: \ / * ? < > " |
-NodeAddress node_host:port Optional. Host name and port number for the machine
-na hosting the node. Choose an available port number.
-NodeKeystore node_keystore_direc Optional if you use the default SSL certificates from
-nk tory 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 node_keystore_pass Optional if you use the default SSL certificates from
-nkp word Informatica. Required if you use your SSL certificates.
Password for the keystore infa_keystore.jks file.
-NodeTruststore node_truststore_dire Optional if you use the default SSL certificates from
-nt ctory 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 node_truststore_pas Optional if you use the default SSL certificates from
-ntp sword Informatica. Required if you use your SSL certificates.
Password for the infa_truststore.jks file.
UpdateGatewayNode 1205
Option Argument Description
-CipherWhiteListFile cipher_whitelist_file Optional. Absolute file name of the plain text file that
-cwlf _ contains a comma-separated list of cipher suites that you
absolute_filename_c want to add to the effective list.
ontaining_comma_s This list overwrites the previous whitelist.
eparated_white_list_
jsse_cipher_namesp Note: The list must contain at least one valid JRE or
o OpenSSL cipher suite.
-CipherBlackListFile cipher_blacklist_file Optional. Absolute file name of the plain text file that
-cblf _ contains a comma-separated list of cipher suites that you
absolute_filename_c want to remove from the effective list.
ontaining_comma_s This list overwrites the previous blacklist.
eparated_black_list_
jsse_cipher_names Note: The effective list must contain at least one valid JRE
or OpenSSL cipher suite.
-ServiceRealmName realm_name_of_nod Optional. Name of the Kerberos realm that the domain
-srn e_spn 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.C
OM
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 realm_name_of_user Optional. Name of the Kerberos realm that the domain
-urn _spn 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.C
OM
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 Infa_keys_directory_ Optional. Directory where all keytab files and the
-kd location encryption key for the Informatica domain are stored.
Default is <InformaticaInstallationDir>/isp/
config/keys.
-KeystoreFile admin_tool_keystore Optional. Keystore file that contains the keys and
-kf _file_location certificates required if you use the SSL security protocol.
UpdateGatewayNode 1207
Option Argument Description
-KeystorePass admin_tool_keystore Optional. A plain-text password for the keystore file. You
-kp _password 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.
-LogServiceDirectory log_service_director Optional. Shared directory path used by the Log Manager
-ld y to store log event files. Verify that -ld does not match or
contain the specified -sld value.
-SystemLogDirectory system_log_director Optional. Directory path to store system log files. Verify
-sld y that -ld does not match or contain the specified -sld value.
Default is <INFA_home>/logs.
-Tablespace tablespace_name Required for an IBM DB2 database. Name of the tablespace
-ts where the domain configuration database tables reside.
-SchemaName schema_name Optional. Name of the Microsoft SQL Server schema. Enter
-sc <used for a schema name if you are not using the default schema.
MSSQLServer only>
-DatabaseTruststorePassword database_truststore Optional. Password for the database truststore file for the
-dbtp _password secure database.
-DatabaseTruststoreLocation database_truststore Optional. Path and file name of the truststore file for the
-dbtl _location gateway node.
<-KerberosAdminName|-kan> kerberos_admin_name
The following table describes infasetup UpdateKerberosAdminUser options and arguments:
UpdateKerberosConfig
Use the UpdateKerberosConfig command to correct the realm name or service realm name in the Informatica
configuration. You can change the user realm that the Informatica domain users belong to. You can change
the service realm that the Informatica domain services belong to.
Note: This command does not change the Kerberos configuration. You cannot use this command to migrate
users from one user realm or service realm to another user realm or service realm.
[<-ServiceRealmName|-srn> realm_name_of_node_spn]
[<-UserRealmName|-urn> realm_name_of_user_spn]
UpdateKerberosAdminUser 1209
The following table describes infasetup UpdateKerberosConfig options and arguments:
-ServiceRealmName realm_name_of_node_sp Optional. Name of the Kerberos realm that the domain
-srn n 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 realm_name_of_user_sp Optional. Name of the Kerberos realm that the domain
-urn n 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
updateMitKerberosLinkage
Configures custom database clients and the Informatica domain to use the specified custom Kerberos
libraries instead of the default libraries that Informatica uses.
1. Copy the custom Kerberos libraries you want to use to each node, or to a location that is accessible to
all nodes in the Informatica domain.
2. Shut down the domain.
3. Run the infasetup updateMitKerberosLinkage command on each node in the domain.
4. Start the domain after running the command on all nodes in the domain.
The updateMitKerberosLinkage command uses the following syntax:
updateMitKerberosLinkage
<-useKeberos|-krb> true|false
[<-mitKerberosDirectory|-mkd> kerberos_library_directory]
-useKeberos true|false Required. Boolean value. Set this value to true if the
-krb Informatica domain uses Kerberos authentication. If
true, Informatica processes make Kerberos calls with
the default Kerberos libraries or the libraries in the
directory specified with the -mkd option.
Set this value to false if the Informatica domain does
not use Kerberos. If false, Informatica does not load
Kerberos libraries. Third-party clients, such as database
clients, perform Kerberos calls with the libraries
specified in the directory specified with the -mkd
option.
-mitKerberosDirectory kerberos_library_directo Optional. The directory that contains the custom MIT
-mkd ry_node_spn Kerberos libraries. The directory must contain the
library files. You cannot use symbolic links.
If the -krb option is true, ensure that the custom
Kerberos libraries that you want to use are the same
version number as the Kerberos libraries that
Informatica uses by default.
If there are multiple versions of the same library, all
versions must be the same size and have the same
checksum. For instance, if the directory contains two
versions of libkrb5, such as libkr5.so.3 and libkrb5.so,
then both libraries should have the same file size and
checksum value.
If the specified directory is empty, the command
removes all custom Kerberos libraries from the
Informatica domain.
UpdatePasswordComplexityConfig
Updates the password complexity configuration for the domain.
UpdatePasswordComplexityConfig 1211
The following table describes infasetup UpdatePasswordComplexityConfig options and arguments:
updateDomainSamlConfig
Enables or disables Secure Assertion Markup Language (SAML) authentication for Informatica web
applications in an Informatica domain. You can also use the command to update the identity provider URL
and specify allowed time difference between the identity provider host system clock and the system clock on
the master gateway node.
Run the command on each gateway node within the Informatica domain. Shut down the domain before you
run the command.
<-DomainName|-dn> domain_name
<-UserName|-un> user_name
[<-SecurityDomain|-sdn> security_domain]
<-Password|-pd> password
[<-ResilienceTimeout|-re> timeout_period_in_seconds]
<-EnableSaml|-saml> true|false
[<-idpUrl|-iu> identity_provider_url]
[<-ServiceProviderId|-spid> service_provider_id]
[<-ClockSkewTolerance|-cst> clock_skew_tolerance_in_seconds]
-DomainName domain_name Required. Name of the Informatica domain. You can set the
-dn domain name with the -dn option or the environment variable
INFA_DEFAULT_DOMAIN. If you set a domain name with
both methods, the -dn option takes precedence.
-Password password Required if you specify the user name. Password for the user
-pd name. The password is case sensitive. You can set a
password with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password
with both methods, the password set with the -pd option
takes precedence.
-idpUrl identity_provider_url Required if the -saml option is true. Specify the identity
-iu provider URL for the domain. You must specify the complete
URL string.
updateDomainSamlConfig 1213
Option Argument Description
-ServiceProviderId service_provider_id Optional. The relying party trust name or the service provider
-spid identifier for the domain as defined in the identity provider.
If you specified "Informatica" as the relying party trust name
in AD FS, you do not need to specify a value.
-ClockSkewTolerance clock_skew_tolerance Optional. The allowed time difference between the identity
-cst _in_seconds provider host system clock and the system clock on the
master gateway node.
The lifetime of SAML tokens issued by the identity provider
by is set according to the identity provider host system
clock. The lifetime of a SAML token issued by the identity
provider is valid if the start time or end time set in the token
is within the specified number seconds of the system clock
on the master gateway node.
Values must be from 0 to 600 seconds. Default is 120
seconds.
UpdateWorkerNode
Updates connectivity information for a worker node on the current machine. Before you update the worker
node, run the infacmd isp ShutDownNode command to shut down the node.
-NodeName node_name Optional. Name of the node. Node names must be between 1
-nn and 79 characters and cannot contain spaces or the following
characters: \ / * ? < > " |
-NodeAddress node_host:port Optional. Host name and port number for the machine hosting
-na the node. Choose an available port number.
-ServiceManagerPort service_manager_port Optional. Port number used by the Service Manager to listen for
-sp incoming connection requests.
-ServiceRealmName realm_name_of_node_s Optional. Name of the Kerberos realm that the domain uses to
-srn pn 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
UpdateWorkerNode 1215
Option Argument Description
-UserRealmName realm_name_of_user_sp Optional. Name of the Kerberos realm that the domain uses to
-urn n 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 Infa_keys_directory_loc Optional. Directory where all keytab files and the encryption key
-kd ation for the Informatica domain are stored. Default is
<InformaticaInstallationDir>/isp/config/keys.
-NodeKeystoreFile admin_tool_keystore_fil Optional. Keystore file that contains the keys and certificates
-kf e_location required if you use the SSL security protocol.
-KeystorePass admin_tool_keystore_pa Optional. A plain-text password for the keystore file. You can
-kp ssword 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.
-GatewayAddress domain_gateway_host:p Required. Gateway host machine name and port number.
-dg ort
-SecurityDomain security domain Name of the security domain that you want to create to which
-sdn the domain user belongs. You can set a security domain with
the -sdn option or the environment variable
INFA_DEFAULT_SECURITY_DOMAIN. If you set a security
domain name with both methods, the -sdn option takes
precedence. The security domain name is case sensitive.
You can specify a value for ‑sdn or use the default based on the
authentication mode:
- Required if the domain uses LDAP authentication. Default is
Native. To work with LDAP authentication, you need to
specify the value for -sdn.
- Optional if the domain uses native authentication or Kerberos
authentication. Default is native for native authentication. If
the domain uses Kerberos authentication, the default is the
LDAP security domain created during installation. The name
of the security domain is the same as the user realm
specified during installation.
-Password password Required if you specify the user name. Password for the user
-pd name. The password is case sensitive. You can set a password
with the -pd option or the environment variable
INFA_DEFAULT_DOMAIN_PASSWORD. If you set a password
with both methods, the password set with the -pd option takes
precedence.
-ServerPort server_shutdown_port Optional. TCP/IP port number used by the Service Manager. The
-sv 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.
-SystemLogDirectory system_log_directory Optional. Directory path to store system log files. Default is
-sld <INFA_home>/logs.
UnlockUser
Unlocks a native or an LDAP user account. When you unlock a native user account, you can also provide a
new password for the account.
You can unlock a user account after you shut down the domain from the gateway node.
<-UserName|-un> user_name
[<-NewPassword|-np] new_password]
UnlockUser 1217
The following table describes the infasetup UnlockUser options and arguments:
-UserName user_name Required. User name of the locked account. The value is case sensitive.
-un
-SecurityDomain security Required if the domain uses LDAP authentication. Optional if the domain uses
-sdn domain native authentication or Kerberos authentication. Name of the security domain
to which the domain user belongs. You can set a security domain with the -sdn
option or the environment variable INFA_DEFAULT_SECURITY_DOMAIN. If you
set a security domain name with both methods, the -sdn option takes
precedence. The security domain name is case sensitive.
If the domain uses native or LDAP authentication, the default is Native. If the
domain uses Kerberos authentication, the default is the LDAP security domain
created during installation. The name of the security domain is the same as the
user realm specified during installation.
-NewPassword new_password Optional. New password for the locked native account.
-np For a native user account, if you enable password complexity, use the following
guidelines when you create or change a password:
- The length of the password must be at least eight characters.
- It must be a combination of an alphabet character, a numeric character and a
non-alphanumeric character, such as:
! \ " # $ % & ' ( ) * + , - . / : ; < = > ? @ [ ] ^ _ `
{ | } ~
When you use special characters in a password, the shell sometimes interprets
them differently. For example, $ is interpreted as a variable. In this case, use an
escape character to escape the special character.
ValidateandRegisterFeature
Validates and registers the feature in the domain.
<-FeatureFilename|-ff> feature_filename
<-IsUpgrade|-up> is_upgrade
The following table describes infasetup ValidateandRegisterFeature options and arguments:
-FeatureFilename feature_filename Required. Location of the xml file for the plugin.
-ff
1219
Using pmcmd
pmcmd is a program you use to communicate with the Integration Service. With pmcmd, you can perform
some of the tasks that you can also perform in the Workflow Manager, such as starting and stopping
workflows and sessions.
• Command line mode. You invoke and exit pmcmd each time you issue a command. You can write scripts
to schedule workflows with the command line syntax. Each command you write in command line mode
must include connection information to the Integration Service.
• Interactive mode. You establish and maintain an active connection to the Integration Service. This lets
you issue a series of commands.
You can use environment variables for user names and passwords with pmcmd. You can also use
environment variables to customize the way pmcmd displays the date and time on the machine running the
Integration Service process. Before you use pmcmd, configure these variables on the machine running the
Integration Service process. The environment variables apply to pmcmd commands that run on the node.
Note: If the domain is a mixed-version domain, run pmcmd from the installation directory of the Integration
Service version.
Use pmcmd commands with operating system scheduling tools like cron, or you can embed pmcmd
commands into shell or Perl scripts.
When you run pmcmd in command line mode, you enter connection information such as domain name,
Integration Service name, user name and password in each command. For example, to start the workflow
“wf_SalesAvg” in folder “SalesEast,” use the following syntax:
pmcmd startworkflow -sv MyIntService -d MyDomain -u seller3 -p jackson ‑f SalesEast
wf_SalesAvg
The user, seller3, with the password “jackson” sends the request to start the workflow.
If you omit or incorrectly enter one of the required options, the command fails, and pmcmd returns a non-zero
return code. For more information about all the return codes, see “pmcmd Return Codes” on page 1220.
1. At the command prompt, switch to the directory where the pmcmd executable is located.
By default, the PowerCenter installer installs pmcmd in the \server\bin directory.
2. Enter pmcmd followed by the command name and its required options and arguments:
pmcmd command_name [-option1] argument_1 [-option2] argument_2...
Use the DOS or UNIX echo command immediately after running a pmcmd command to see the return code for
the command:
Code Description
0 For all commands, a return value of zero indicates that the command ran successfully. You can issue the
following commands in the wait or nowait mode: starttask, startworkflow, aborttask, and abortworkflow.
If you issue a command in the wait mode, a return value of zero indicates the command ran
successfully. If you issue a command in the nowait mode, a return value of zero indicates that the
request was successfully transmitted to the Integration Service, and it acknowledged the request.
1 Integration Service is not available, or pmcmd cannot connect to the Integration Service. There is a
problem with the TCP/IP host name or port number or with the network.
8 You do not have the appropriate permissions or privileges to perform this task.
9 Connection to the Integration Service timed out while sending the request.
12 Integration Service cannot start recovery because the session or workflow is scheduled, waiting for an
event, waiting, initializing, aborting, stopping, disabled, or running.
18 Integration Service found the parameter file, but it did not have the initial values for the session
parameters, such as $input or $output.
19 Integration Service cannot resume the session because the workflow is configured to run continuously.
20 A repository error has occurred. Make sure that the Repository Service and the database are running and
the number of connections to the database is not exceeded.
22 Integration Service cannot find a unique instance of the workflow/session you specified. Enter the
command again with the folder name and workflow name.
24 Out of memory.
25 Command is cancelled.
For example, the following commands invoke the interactive mode, establish a connection to Integration
Service “MyIntService,” and start workflows “wf_SalesAvg” and “wf_SalesTotal” in folder “SalesEast”:
pmcmd
pmcmd> connect -sv MyIntService -d MyDomain -u seller3 -p jackson
pmcmd> setfolder SalesEast
pmcmd> startworkflow wf_SalesAvg
pmcmd> startworkflow wf_SalesTotal
To run pmcmd commands in interactive mode:
1. At the command prompt, switch to the directory where the pmcmd executable is located.
By default, the PowerCenter installer installs pmcmd in the \server\bin directory.
2. At the command prompt, type pmcmd.
This starts pmcmd in interactive mode and displays the pmcmd> prompt. You do not have to type pmcmd
before each command in interactive mode.
3. Enter connection information for the domain and Integration Service. For example:
connect -sv MyIntService -d MyDomain -u seller3 -p jackson
4. Type a command and its options and arguments in the following format:
Setting Defaults
After you connect to an Integration Service using pmcmd, you can designate default folders or conditions to
use each time the Integration Service executes a command. For example, if you want to issue a series of
commands or tasks in the same folder, specify the name of the folder with the setfolder command. All
subsequent commands use that folder as the default.
The following table describes the commands that you use to set defaults for subsequent commands:
Command Description
setfolder Designates a folder as the default folder in which to execute all subsequent commands.
setnowait Executes subsequent commands in the nowait mode. The pmcmd prompt is available after the
Integration Service receives the previous command. The nowait mode is the default mode.
setwait Executes subsequent commands in the wait mode. The pmcmd prompt is available after the
Integration Service completes the previous command.
You can use pmcmd ShowSettings command to display the default settings.
For example, if you enter the following command, pmcmd starts the workflow “wf_SalesAvg” and does not
return to the prompt until the workflow completes:
pmcmd startworkflow -sv MyIntService -d MyDomain -u seller3 -p jackson ‑f SalesEast -
wait wf_SalesAvg
In nowait mode, pmcmd returns to the shell or command prompt immediately. You do not have to wait for
one command to complete before running the next command.
For example, if you enter the following commands, pmcmd starts workflow “wf_SalesTotal” even if workflow
“wf_SalesAvg” is still running:
pmcmd startworkflow -sv MyIntService -d MyDomain -u seller3 -p jackson ‑f SalesEast
wf_SalesAvg
pmcmd startworkflow -sv MyIntService -d MyDomain -u seller3 -p jackson ‑f SalesEast
wf_SalesTotal
By default, pmcmd executes commands in nowait mode.
You can configure the wait mode when you run in command line or interactive mode. In command line mode,
use the -wait option to run a command in wait mode. In interactive mode, use the setwait or setnowait
command before entering subsequent commands.
You can run scripts in command line mode. You cannot run pmcmd scripts in interactive mode.
For example, the following UNIX shell script checks the status of Integration Service “testService,” and if it is
running, gets details for session “s_testSessionTask”:
#!/usr/bin/bash
# Sample pmcmd script
# Check if the service is alive
# handle error
exit
# handle error
exit
fi
# Get task details for session task "s_testSessionTask" of workflow
# handle error
exit
fi
aborttask
Aborts a task. Issue this command only if the Integration Service fails to stop the task when you issue the
stoptask command.
[<<-usersecuritydomain|-usd> usersecuritydomain|<-usersecuritydomainvar|-usdv>
userSecuritydomainEnvVar>]
[<-folder|-f> folder]
<-workflow|-w> workflow
[<-runinsname|-rin> runInsName]
[-wfrunid workflowRunId]
[-wait|-nowait]
taskInstancePath
The pmcmd aborttask command uses the following syntax in the interactive mode:
aborttask
[<-folder|-f> folder]
<-workflow|-w> workflow
[<-runinsname|-rin> runInsName]
[-wfrunid workflowRunId]
[-wait|-nowait]
taskInstancePath
The following table describes pmcmd aborttask options and arguments:
-domain domain Optional in command line mode. Domain name. Not used in
-d interactive mode.
-user username Required in command line mode if you do not specify the user
-u name environment variable. User name. Not used in
interactive mode.
aborttask 1225
Option Argument Description
-uservar userEnvVar Required in command line mode if you do not specify the user
-uv name. Specifies the user name environment variable. Not
used in interactive mode.
-password password Required in command line mode if you do not specify the
-p password environment variable. Password. Not used in
interactive mode.
-passwordvar passwordEnvVar Required in command line mode if you do not specify the
-pv password. Password environment variable. Not used in
interactive mode.
-usersecuritydomain usersecuritydomain Optional in command line mode. Required if you use LDAP
-usd authentication. Name of the security domain that the user
belongs to. Not used in interactive mode. Default is Native.
-folder folder Required if the task name is not unique in the repository.
-f Name of the folder containing the task.
-runinsname runInsName Name of the workflow run instance that contains the task you
-rn want to abort. Use this option if you are running concurrent
workflows.
-wfrunid workflowRunId Run identifier number (Run ID) of the workflow run instance
that contains the task you want to abort. Use this option if
you are running concurrent workflows.
Note: Use this option if the workflow does not have a unique
run instance name.
abortworkflow
Aborts a workflow. Issue this command only if the Integration Service fails to stop the workflow when you
issue the stopworkflow command.
[<<-usersecuritydomain|-usd> usersecuritydomain|<-usersecuritydomainvar|-usdv>
userSecuritydomainEnvVar>]
[<-folder|-f> folder]
[-wait|-nowait]
[<-runinsname|-rin> runInsName]
[-wfrunid workflowRunId]
workflow
The abortworkflow command uses the following syntax in the interactive mode:
abortworkflow
[<-folder|-f> folder]
[-wait|-nowait]
[<-runinsname|-rin> runInsName]
[-wfrunid workflowRunId]
workflow
The following table describes pmcmd abortworkflow options and arguments:
-domain domain Optional in command line mode. Domain name. Not used in
-d interactive mode.
-user username Required in command line mode if you do not specify the user
-u name environment variable. User name. Not used in
interactive mode.
abortworkflow 1227
Option Argument Description
-password password Required in command line mode if you do not specify the
-p password environment variable. Password. Not used in
interactive mode.
-passwordvar passwordEnvVar Required in command line mode if you do not specify the
-pv password. Password environment variable. Not used in
interactive mode.
-usersecuritydomain usersecuritydomain Optional in command line mode. Required if you use LDAP
-usd authentication. Name of the security domain that the user
belongs to. Not used in interactive mode. Default is Native.
-folder folder Required if the workflow name is not unique in the repository.
-f Name of the folder containing the workflow.
-runinsname runInsName Name of the workflow run instance you want to abort. Use
-rin this option if you are running concurrent workflows.
-wfrunid workflowRunId Run identifier number (Run ID) of the workflow run instance
you want to abort. Use this option if you are running
concurrent workflows.
Note: Use this option if the workflow does not have a unique
run instance name.
Connect
Connects the pmcmd program to the Integration Service in the interactive mode. If you omit connection
information, pmcmd prompts you to enter the correct information. Once pmcmd successfully connects, you
can issue commands without reentering the connection information.
Connect
[<<-usersecuritydomain|-usd> usersecuritydomain|<-usersecuritydomainvar|-usdv>
userSecuritydomainEnvVar>]
-user username Required in command line mode if you do not specify the user
-u name environment variable. User name. Not used in
interactive mode.
-password password Required in command line mode if you do not specify the
-p password environment variable. Password. Not used in
interactive mode.
-passwordvar passwordEnvVar Required in command line mode if you do not specify the
-pv password. Password environment variable. Not used in
interactive mode.
-usersecuritydomain usersecuritydomain Optional in command line mode. Required if you use LDAP
-usd authentication. Name of the security domain that the user
belongs to. Not used in interactive mode. Default is Native.
Disconnect
Disconnects pmcmd from the Integration Service. It does not close the pmcmd program. Use this command
when you want to disconnect from an Integration Service and connect to another in the interactive mode.
The Disconnect command uses the following syntax in the interactive mode:
Disconnect
Note: Use this command in the pmcmd interactive mode only.
Disconnect 1229
Exit
Disconnects pmcmd from the Integration Service and closes the pmcmd program.
The Exit command uses the following syntax in the interactive mode:
Exit
Note: Use this command in the pmcmd interactive mode only.
getrunningsessionsdetails
Returns the following details for all sessions currently running on an Integration Service:
[<<-usersecuritydomain|-usd> usersecuritydomain|<-usersecuritydomainvar|-usdv>
userSecuritydomainEnvVar>]
The pmcmd getrunningsessionsdetails command uses the following syntax in the interactive mode:
getrunningsessionsdetails
The following table describes pmcmd getrunningsessionsdetails options and arguments:
-user username Required in command line mode if you do not specify the user
-u name environment variable. User name. Not used in
interactive mode.
-password password Required in command line mode if you do not specify the
-p password environment variable. Password. Not used in
interactive mode.
-passwordvar passwordEnvVar Required in command line mode if you do not specify the
-pv password. Password environment variable. Not used in
interactive mode.
-usersecuritydomain usersecuritydomain Optional in command line mode. Required if you use LDAP
-usd authentication. Name of the security domain that the user
belongs to. Not used in interactive mode. Default is Native.
GetServiceDetails
Returns the following details about an Integration Service:
GetServiceDetails 1231
[<<-usersecuritydomain|-usd> usersecuritydomain|<-usersecuritydomainvar|-usdv>
userSecuritydomainEnvVar>]
[-all|-running|-scheduled]
The GetServiceDetails command uses the following syntax in the interactive mode:
GetServiceDetails
[-all|-running|-scheduled]
The following table describes pmcmd GetServiceDetails options and arguments:
-user username Required in command line mode if you do not specify the user
-u name environment variable. User name. Not used in
interactive mode.
-password password Required in command line mode if you do not specify the
-p password environment variable. Password. Not used in
interactive mode.
-passwordvar passwordEnvVar Required in command line mode if you do not specify the
-pv password. Password environment variable. Not used in
interactive mode.
-usersecuritydomain usersecuritydomain Optional in command line mode. Required if you use LDAP
-usd authentication. Name of the security domain that the user
belongs to. Not used in interactive mode. Default is Native.
getserviceproperties
Returns the following information about the PowerCenter Integration Service:
getserviceproperties 1233
The following table describes pmcmd getserviceproperties options and arguments:
getsessionstatistics
Returns session details and statistics. The command returns the following information:
• Folder name, workflow name, worklet or session instance, and mapping name
• Session log file name and location
• Number of source and target success and failure rows
• Number of transformation errors
• First error code and error message
• Task run status
• Name of associated Integration Service
• Grid and node names where the session runs
The command also returns the following information for each partition:
• Partition name
• For each transformation within a partition: transformation instance, transformation name, number of
applied, affected, and rejected rows, throughput, last error code, start and end time
The getsessionstatistics command uses the following syntax in the command line mode:
pmcmd getsessionstatistics
[<<-usersecuritydomain|-usd> usersecuritydomain|<-usersecuritydomainvar|-usdv>
userSecuritydomainEnvVar>]
[<-folder|-f> folder]
[<-runinsname|-rin> runInsName]
[-wfrunid workflowRunId]
taskInstancePath
The getsessionstatistics command uses the following syntax in the interactive mode:
getsessionstatistics
[<-folder|-f> folder]
[<-runinsname|-rin> runInsName]
[-wfrunid workflowRunId]
<-workflow|-w> workflow
taskInstancePath
The following table describes pmcmd getsessionstatistics options and arguments:
-user username Required in command line mode if you do not specify the user
-u name environment variable. User name. Not used in
interactive mode.
-password password Required in command line mode if you do not specify the
-p password environment variable. Password. Not used in
interactive mode.
-passwordvar passwordEnvVar Required in command line mode if you do not specify the
-pv password. Password environment variable. Not used in
interactive mode.
getsessionstatistics 1235
Option Argument Description
-folder folder Required if the task name is not unique in the repository.
-f Name of the folder containing the task.
-runinsname runInsName Name of the workflow run instance that contains the task.
-rn Use this option if you are running concurrent workflows.
-wfrunid workflowRunId Run identifier number (Run ID) of the workflow run instance
that contains the task. Use this option if you are running
concurrent workflows.
Note: Use this option if the workflow does not have a unique
run instance name.
gettaskdetails
Returns the following information about a task:
• Folder name, workflow name, task instance name, and task type
• Last execution start and complete time
• Task run status, first error code, and error message
• Grid and node names where the task runs
• Name of associated Integration Service
• Task run mode
If the task is a session, the command also returns the following details:
[<<-usersecuritydomain|-usd> usersecuritydomain|<-usersecuritydomainvar|-usdv>
userSecuritydomainEnvVar>]
<-workflow|-w> workflow
[<-runinsname|-rin> runInsName]
taskInstancePath
The pmcmd gettaskdetails command uses the following syntax in the interactive mode:
gettaskdetails
[<-folder|-f> folder]
<-workflow|-w> workflow
[<-runinsname|-rin> runInsName]
taskInstancePath
The following table describes pmcmd gettaskdetails options and arguments:
-user username Required in command line mode if you do not specify the user
-u name environment variable. User name. Not used in
interactive mode.
-password password Required in command line mode if you do not specify the
-p password environment variable. Password. Not used in
interactive mode.
-passwordvar passwordEnvVar Required in command line mode if you do not specify the
-pv password. Password environment variable. Not used in
interactive mode.
-usersecuritydomain usersecuritydomain Optional in command line mode. Required if you use LDAP
-usd authentication. Name of the security domain that the user
belongs to. Not used in interactive mode. Default is Native.
gettaskdetails 1237
Option Argument Description
-folder folder Required if the task name is not unique in the repository.
-f Name of the folder containing the task.
-workflow workflow Required if the task name is not unique in the repository.
-w Name of the folder containing the task.
-runinsname runInsName Name of the workflow run instance that contains the task.
-rn Use this option if you are running concurrent workflows.
getworkflowdetails
Returns the following information about a workflow:
[<<-usersecuritydomain|-usd> usersecuritydomain|<-usersecuritydomainvar|-usdv>
userSecuritydomainEnvVar>]
[<-folder|-f> folder]
[<-runinsname|-rin> runInsName]
[-wfrunid workflowRunId]
workflow
The getworkflowdetails command uses the following syntax in the interactive mode:
getworkflowdetails
[<-runinsname|-rin> runInsName]
[-wfrunid workflowRunId]
workflow
The following table describes pmcmd getworkflowdetails options and arguments:
-user username Required in command line mode if you do not specify the user
-u name environment variable. User name. Not used in
interactive mode.
-password password Required in command line mode if you do not specify the
-p password environment variable. Password. Not used in
interactive mode.
-passwordvar passwordEnvVar Required in command line mode if you do not specify the
-pv password. Password environment variable. Not used in
interactive mode.
-usersecuritydomain usersecuritydomain Optional in command line mode. Required if you use LDAP
-usd authentication. Name of the security domain that the user
belongs to. Not used in interactive mode. Default is Native.
-folder folder Required if the workflow name is not unique in the repository.
-f Name of the folder containing the workflow.
-runinsname runInsName Name of the workflow run instance. Use this option if you are
-rin running concurrent workflows.
getworkflowdetails 1239
Option Argument Description
-wfrunid workflowRunId Run identifier number (Run ID) of the workflow run instance.
Use this option if you are running concurrent workflows.
Note: Use this option if the workflow does not have a unique
run instance name.
Aborted You choose to abort the workflow or task in the Workflow Monitor or through pmcmd. The
Integration Service kills the DTM process and aborts the task. You can recover an aborted
workflow if you enable the workflow for recovery.
Disabled You select the Disabled option in the workflow properties. The Integration Service does not run the
disabled workflow until you clear the Disabled option.
Failed The Integration Service fails the workflow because it encountered errors. You cannot recover a
failed workflow.
Preparing to The Integration Service is waiting for an execution lock for the workflow.
Run
Scheduled You schedule the workflow to run at a future date. The Integration Service runs the workflow for
the duration of the schedule.
Stopped You choose to stop the workflow or task in the Workflow Monitor or through pmcmd. The
Integration Service stops processing the task and all other tasks in its path. The Integration
Service continues running concurrent tasks. You can recover a stopped workflow if you enable the
workflow for recovery.
Suspended The Integration Service suspends the workflow because a task failed and no other tasks are
running in the workflow. This status is available when you select the Suspend on Error option. You
can recover a suspended workflow.
Suspending A task fails in the workflow when other tasks are still running. The Integration Service stops
running the failed task and continues running tasks in other paths. This status is available when
you select the Suspend on Error option.
Terminated The Integration Service shuts down unexpectedly when running this workflow or task. You can
recover a terminated workflow if you enable the workflow for recovery.
Terminating The Integration Service is in the process of terminating the workflow or task.
Waiting The Integration Service is waiting for available resources so it can run the workflow or task. For
example, you may set the maximum number of running Session and Command tasks allowed for
each Integration Service process on the node to 10. If the Integration Service is already running 10
concurrent sessions, all other workflows and tasks have the Waiting status until the Integration
Service is free to run more tasks.
The getworkflowdetails command displays the last workflow run type details. Workflow run types refers to
the method used to start the workflow.
The following table describes the different workflow run types with the getworkflowdetails command:
help
Returns the syntax for the command you specify. If you omit the command name, pmcmd lists all commands
and their syntax.
The pmcmd help command uses the following syntax in the command line mode:
pmcmd help [command]
The pmcmd help command uses the following syntax in the interactive mode:
help [command]
The following table describes the pmcmd help option and argument:
help 1241
pingservice
Verifies that the Integration Service is running.
The pmcmd pingservice command uses the following syntax in the command line mode:
pmcmd pingservice
recoverworkflow
Recovers suspended workflows. To recover a workflow, specify the folder and workflow name. The
Integration Service recovers the workflow from all suspended and failed worklets and all suspended and
failed Command, Email, and Session tasks.
The pmcmd recoverworkflow command uses the following syntax in the command line mode:
pmcmd recoverworkflow
[<<-usersecuritydomain|-usd> usersecuritydomain|<-usersecuritydomainvar|-usdv>
userSecuritydomainEnvVar>]
[<-folder|-f> folder]
[<-paramfile> paramfile]
[<-localparamfile|-lpf> localparamfile]
[-wait|-nowait]
[-wfrunid workflowRunId]
workflow
The pmcmd recoverworkflow command uses the following syntax in the interactive mode:
recoverworkflow
[<-folder|-f> folder]
[<-paramfile> paramfile]
[<-localparamfile|-lpf> localparamfile]
[-wait|-nowait]
[<-runinsname|-rin> runInsName]
[-wfrunid workflowRunId]
workflow
The following table describes pmcmd recoverworkflow options and arguments:
-user username Required in command line mode if you do not specify the user
-u name environment variable. User name. Not used in
interactive mode.
-password password Required in command line mode if you do not specify the
-p password environment variable. Password. Not used in
interactive mode.
-passwordvar passwordEnvVar Required in command line mode if you do not specify the
-pv password. Password environment variable. Not used in
interactive mode.
-usersecuritydomain usersecuritydomain Optional in command line mode. Required if you use LDAP
-usd authentication. Name of the security domain that the user
belongs to. Not used in interactive mode. Default is Native.
recoverworkflow 1243
Option Argument Description
-folder folder Required if the workflow name is not unique in the repository.
-f Name of the folder containing the workflow.
-paramfile paramfile Optional. Determines which parameter file to use when a task
or workflow runs. It overrides the configured parameter file
for the workflow or task.
-localparamfile localparamfile Optional. Specifies the parameter file on a local machine that
-lpf pmcmd uses when you start a workflow.
-runinsname runInsName Name of the workflow run instance you want to recover. Use
-rin this option if you are running concurrent workflows.
-wfrunid workflowRunId Run identifier number (Run ID) of the workflow run instance
you want to recover. Use this option if you are running
concurrent workflows.
Note: Use this option if the workflow does not have a unique
run instance name.
scheduleworkflow
Instructs the Integration Service to schedule a workflow. Use this command to reschedule a workflow that
has been removed from the schedule.
The pmcmd scheduleworkflow command uses the following syntax in the command line mode:
pmcmd scheduleworkflow
[<<-usersecuritydomain|-usd> usersecuritydomain|<-usersecuritydomainvar|-usdv>
userSecuritydomainEnvVar>]
[<-folder|-f> folder]
workflow
[<-folder|-f> folder]
workflow
The following table describes pmcmd scheduleworkflow options and arguments:
-user username Required in command line mode if you do not specify the user
-u name environment variable. User name. Not used in
interactive mode.
-password password Required in command line mode if you do not specify the
-p password environment variable. Password. Not used in
interactive mode.
-passwordvar passwordEnvVar Required in command line mode if you do not specify the
-pv password. Password environment variable. Not used in
interactive mode.
-usersecuritydomain usersecuritydomain Optional in command line mode. Required if you use LDAP
-usd authentication. Name of the security domain that the user
belongs to. Not used in interactive mode. Default is Native.
-folder folder Required if the workflow name is not unique in the repository.
-f Name of the folder containing the workflow.
scheduleworkflow 1245
SetFolder
Designates a folder as the default folder in which to execute all subsequent commands. After issuing this
command, you do not need to enter a folder name for workflow, task, and session commands. If you enter a
folder name in a command after the SetFolder command, that folder name overrides the default folder name
for that command only.
The SetFolder command uses the following syntax in the interactive mode:
SetFolder folder
Note: Use this command in the pmcmd interactive mode only.
SetNoWait
You can run pmcmd in wait or nowait mode. In wait mode, pmcmd returns to the shell or command prompt
after the command completes. You cannot run subsequent commands until the previous command
completes. In nowait mode, pmcmd returns to the shell or command prompt immediately. You do not have to
wait for one command to complete before running the next command.
The SetNoWait command runs pmcmd in nowait mode. The nowait mode is the default mode.
The SetNoWait command uses the following syntax in the interactive mode:
SetNoWait
When you set nowait mode, use the pmcmd prompt after the Integration Service executes the previous
command.
SetWait
You can run pmcmd in wait or nowait mode. In wait mode, pmcmd returns to the shell or command prompt
after the command completes. You cannot run subsequent commands until the previous command
completes. In nowait mode, pmcmd returns to the shell or command prompt immediately. You do not have to
wait for one command to complete before running the next command.
The SetWait command runs pmcmd in wait mode. The pmcmd prompt is available after the Integration
Service completes the previous command.
The SetWait command uses the following syntax in the interactive mode:
SetWait
Note: Use this command in the pmcmd interactive mode only.
The ShowSettings command uses the following syntax in the interactive mode:
ShowSettings
Note: Use this command in the pmcmd interactive mode only.
StartTask
Starts a task.
The StartTask command uses the following syntax in the command line mode:
pmcmd StartTask
[<<-usersecuritydomain|-usd> usersecuritydomain|<-usersecuritydomainvar|-usdv>
userSecuritydomainEnvVar>]
[<-folder|-f> folder]
<-workflow|-w> workflow
[<-paramfile> paramfile]
[-wait|-nowait]
[<-recovery|-norecovery>]
[<-runinsname|-rin> runInsName]
taskInstancePath
The StartTask command uses the following syntax in the interactive mode:
pmcmd StartTask
[<-folder|-f> folder]
<-workflow|-w> workflow
<-paramfile> paramfile]
[-wait|-nowait]
[<-recovery|-norecovery>]
[<-runinsname|-rin> runInsName]
taskInstancePath
ShowSettings 1247
The following table describes pmcmd StartTask options and arguments:
-user username Required in command line mode if you do not specify the user
-u name environment variable. User name. Not used in
interactive mode.
-password password Required in command line mode if you do not specify the
-p password environment variable. Password. Not used in
interactive mode.
-passwordvar passwordEnvVar Required in command line mode if you do not specify the
-pv password. Password environment variable. Not used in
interactive mode.
-usersecuritydomain usersecuritydomain Optional in command line mode. Required if you use LDAP
-usd authentication. Name of the security domain that the user
belongs to. Not used in interactive mode. Default is Native.
-folder folder Required if the workflow name is not unique in the repository.
-f Name of the folder containing the workflow.
-paramfile paramfile Optional. Determines which parameter file to use when a task
or workflow runs. It overrides the configured parameter file
for the workflow or task.
-runinsname runInsName Name of the workflow run instance that contains the task you
-rn want to start. Use this option if you are running concurrent
workflows.
For UNIX shell users, enclose the parameter file name in single quotes:
-paramfile '$PMRootDir/myfile.txt'
For Windows command prompt users, the parameter file name cannot have beginning or trailing spaces. If
the name includes spaces, enclose the file name in double quotes:
-paramfile "$PMRootDir\my file.txt"
When you write a pmcmd command that includes a parameter file located on another machine, use the
backslash (\) with the dollar sign ($). This ensures that the machine where the variable is defined expands
the process variable.
pmcmd starttask -sv MyIntService -d MyDomain -uv USERNAME -pv PASSWORD ‑f east -w
wSalesAvg -paramfile '\$PMRootDir/myfile.txt' taskA
StartTask 1249
StartWorkflow
Starts a workflow.
The StartWorkflow command uses the following syntax in the command line mode:
pmcmd StartWorkflow
[<<-usersecuritydomain|-usd> usersecuritydomain|<-usersecuritydomainvar|-usdv>
userSecuritydomainEnvVar>]
[<-folder|-f> folder]
[<-startfrom> taskInstancePath]
[<-recovery|-norecovery>]
[<-paramfile> paramfile]
[<-localparamfile|-lpf> localparamfile]
[<-osprofile|-o> OSUser]
[-wait|-nowait]
[<-runinsname|-rin> runInsName]
workflow
The StartWorkflow command uses the following syntax in the interactive mode:
pmcmd StartWorkflow
[<-folder|-f> folder]
[<-paramfile> paramfile]
[<-localparamfile|-lpf> localparamfile]
[<-osprofile|-o> osProfile]
[-wait|-nowait]
[<-runinsname|-rin> runInsName]
workflow
The following table describes pmcmd StartWorkflow options and arguments:
-user username Required in command line mode if you do not specify the
-u user name environment variable. User name. Not used in
interactive mode.
-password password Required in command line mode if you do not specify the
-p password environment variable. Password. Not used in
interactive mode.
-passwordvar passwordEnvVar Required in command line mode if you do not specify the
-pv password. Password environment variable. Not used in
interactive mode.
-usersecuritydomain usersecuritydomain Optional in command line mode. Required if you use LDAP
-usd authentication. Name of the security domain that the user
belongs to. Not used in interactive mode. Default is Native.
StartWorkflow 1251
Option Argument Description
-runinsname runInsName Name of the workflow run instance you want to start. Use
-rin this option if you are running concurrent workflows.
• Node running the Integration Service. When you use a parameter file located on the Integration Service
machine, use the -paramfile option to indicate the location and name of the parameter file.
On UNIX, use the following syntax:
-paramfile '$PMRootDir/myfile.txt'
On Windows, use the following syntax:
-paramfile "$PMRootDir\my file.txt"
• Local machine. When you use a parameter file located on the machine where pmcmd is invoked, pmcmd
passes variables and values in the file to the Integration Service. When you list a local parameter file,
specify the absolute path or relative path to the file. Use the -localparamfile or -lpf option to indicate the
location and name of the local parameter file.
On UNIX, use the following syntax:
-lpf 'param_file.txt'
-localparamfile param_file.txt
• Shared network drives. When you use a parameter file located on another machine, use the backslash (\)
with the dollar sign ($). This ensures that the machine where the variable is defined expands the process
variable.
-paramfile '\$PMRootDir/myfile.txt'
StopTask
Stops a task.
The StopTask command uses the following syntax in the command line mode:
pmcmd StopTask
[<<-usersecuritydomain|-usd> usersecuritydomain|<-usersecuritydomainvar|-usdv>
userSecuritydomainEnvVar>]
[<-folder|-f> folder]
[<-runinsname|-rin> runInsName]
[-wfrunid workflowRunId]
[-wait|-nowait]
taskInstancePath
StopTask 1253
The StopTask command uses the following syntax in the interactive mode:
pmcmd StopTask
[<-folder|-f> folder]
<-workflow|-w> workflow
[<-runinsname|-rin> runInsName]
[-wfrunid workflowRunId]
[-wait|-nowait]
taskInstancePath
The following table describes pmcmd StopTask options and arguments:
-user username Required in command line mode if you do not specify the user
-u name environment variable. User name. Not used in
interactive mode.
-password password Required in command line mode if you do not specify the
-p password environment variable. Password. Not used in
interactive mode.
-passwordvar passwordEnvVar Required in command line mode if you do not specify the
-pv password. Password environment variable. Not used in
interactive mode.
-usersecuritydomain usersecuritydomain Optional in command line mode. Required if you use LDAP
-usd authentication. Name of the security domain that the user
belongs to. Not used in interactive mode. Default is Native.
-folder folder Required if the workflow name is not unique in the repository.
-f Name of the folder containing the workflow.
-runinsname runInsName Name of the workflow run instance that contains the task you
-rn want to stop. Use this option if you are running concurrent
workflows.
-wfrunid workflowRunId Run identifier number (Run ID) of the workflow run instance
that contains the task you want to stop. Use this option if you
are running concurrent workflows.
Note: Use this option if the workflow does not have a unique
run instance name.
StopWorkflow
Stops a workflow.
The StopWorkflow command uses the following syntax in the command line mode:
pmcmd StopWorkflow
[<<-usersecuritydomain|-usd> usersecuritydomain|<-usersecuritydomainvar|-usdv>
userSecuritydomainEnvVar>]
[<-folder|-f> folder]
[<-runinsname|-rin> runInsName]
[-wfrunid workflowRunId]
[-wait|-nowait]
workflow
The StopWorkflow command uses the following syntax in the interactive mode:
pmcmd StopWorkflow
StopWorkflow 1255
[<-folder|-f> folder]
[<-runinsname|-rin> runInsName]
[-wfrunid workflowRunId]
[-wait|-nowait]
workflow
The following table describes pmcmd StopWorkflow options and arguments:
-user username Required in command line mode if you do not specify the user
-u name environment variable. User name. Not used in
interactive mode.
-password password Required in command line mode if you do not specify the
-p password environment variable. Password. Not used in
interactive mode.
-passwordvar passwordEnvVar Required in command line mode if you do not specify the
-pv password. Password environment variable. Not used in
interactive mode.
-usersecuritydomain usersecuritydomain Optional in command line mode. Required if you use LDAP
-usd authentication. Name of the security domain that the user
belongs to. Not used in interactive mode. Default is Native.
-folder folder Required if the workflow name is not unique in the repository.
-f Name of the folder containing the workflow.
-runinsname runInsName Name of the workflow run instance you want to stop. Use this
-rin option if you are running concurrent workflows.
-wfrunid workflowRunId Run identifier number (Run ID) of the workflow run instance
you want to stop. Use this option if you are running
concurrent workflows.
Note: Use this option if the workflow does not have a unique
run instance name.
UnscheduleWorkflow
Removes a workflow from a schedule.
The UnscheduleWorkflow command uses the following syntax in the command line mode:
pmcmd UnscheduleWorkflow
[<<-usersecuritydomain|-usd> usersecuritydomain|<-usersecuritydomainvar|-usdv>
userSecuritydomainEnvVar>]
[<-folder|-f> folder]
workflow
The UnscheduleWorkflow command uses the following syntax in the interactive mode:
UnscheduleWorkflow
[<-folder|-f> folder]
workflow
The following table describes pmcmd UnscheduleWorkflow options and arguments:
UnscheduleWorkflow 1257
Option Argument Description
-user username Required in command line mode if you do not specify the user
-u name environment variable. User name. Not used in
interactive mode.
-password password Required in command line mode if you do not specify the
-p password environment variable. Password. Not used in
interactive mode.
-passwordvar passwordEnvVar Required in command line mode if you do not specify the
-pv password. Password environment variable. Not used in
interactive mode.
-usersecuritydomain usersecuritydomain Optional in command line mode. Required if you use LDAP
-usd authentication. Name of the security domain that the user
belongs to. Not used in interactive mode. Default is Native.
-folder folder Required if the workflow name is not unique in the repository.
-f Name of the folder containing the workflow.
UnsetFolder
Removes the designation of a default folder. After you issue this command, you must specify a folder name
each time you enter a command for a session, workflow, or task.
The UnsetFolder command uses the following syntax in the interactive mode:
UnsetFolder
Note: Use this command in the pmcmd interactive mode only.
The Version command uses the following syntax in the command line mode:
pmcmd Version
The Version command uses the following syntax in the interactive mode:
Version
WaitTask
Instructs the Integration Service to complete the task before returning the pmcmd prompt to the command
prompt or shell.
The WaitTask command uses the following syntax in the command line mode:
pmcmd WaitTask
[<<-usersecuritydomain|-usd> usersecuritydomain|<-usersecuritydomainvar|-usdv>
userSecuritydomainEnvVar>]
[<-folder|-f> folder]
<-workflow|-w> workflow
[<-runinsname|-rin> runInsName]
[-wfrunid workflowRunId]
taskInstancePath
The WaitTask command uses the following syntax in the interactive mode:
WaitTask
[<-folder|-f> folder]
<-workflow|-w> workflow
[<-runinsname|-rin> runInsName]
[-wfrunid workflowRunId]
taskInstancePath
Version 1259
The following table describes pmcmd WaitTask options and arguments:
-user username Required in command line mode if you do not specify the user
-u name environment variable. User name. Not used in
interactive mode.
-password password Required in command line mode if you do not specify the
-p password environment variable. Password. Not used in
interactive mode.
-passwordvar passwordEnvVar Required in command line mode if you do not specify the
-pv password. Password environment variable. Not used in
interactive mode.
-usersecuritydomain usersecuritydomain Optional in command line mode. Required if you use LDAP
-usd authentication. Name of the security domain that the user
belongs to. Not used in interactive mode. Default is Native.
-folder folder Required if the task name is not unique in the repository.
-f Name of the folder containing the task.
-runinsname runInsName Name of the workflow run instance that contains the task.
-rn Use this option if you are running concurrent workflows.
-wfrunid workflowRunId Run identifier number (Run ID) of the workflow run instance
that contains the task. Use this option if you are running
concurrent workflows.
Note: Use this option if the workflow does not have a unique
run instance name.
WaitWorkflow
Causes pmcmd to wait for a workflow to complete before it executes subsequent commands. Use this
command in conjunction with the return code when you run pmcmd from a script. For example, you may want
to check the status of a critical workflow before starting another workflow. Use the WaitWorkflow command
to wait for the critical workflow to complete, and then check the pmcmd return code. If the return code is 0
(successful), start the next workflow.
The WaitWorkflow command uses the following syntax in the command line mode:
pmcmd WaitWorkflow
[<<-usersecuritydomain|-usd> usersecuritydomain|<-usersecuritydomainvar|-usdv>
userSecuritydomainEnvVar>]
[<-folder|-f> folder]
[<-runinsname|-rin> runInsName]
[-wfrunid workflowRunId]
workflow
The WaitWorkflow command uses the following syntax in the interactive mode:
WaitWorkflow
[<-folder|-f> folder]
[<-runinsname|-rin> runInsName]
[-wfrunid workflowRunId]
workflow
WaitWorkflow 1261
The following table describes pmcmd WaitWorkflow options and arguments:
-user username Required in command line mode if you do not specify the user
-u name environment variable. User name. Not used in
interactive mode.
-password password Required in command line mode if you do not specify the
-p password environment variable. Password. Not used in
interactive mode.
-passwordvar passwordEnvVar Required in command line mode if you do not specify the
-pv password. Password environment variable. Not used in
interactive mode.
-usersecuritydomain usersecuritydomain Optional in command line mode. Required if you use LDAP
-usd authentication. Name of the security domain that the user
belongs to. Not used in interactive mode. Default is Native.
-folder folder Required if the workflow name is not unique in the repository.
-f Name of the folder containing the workflow.
-runinsname runInsName Name of the workflow run instance. Use this option if you are
-rin running concurrent workflows.
-wfrunid workflowRunId Run identifier number (Run ID) of the workflow run instance.
Use this option if you are running concurrent workflows.
Note: Use this option if the workflow does not have a unique
run instance name.
1263
• GenerateAbapProgramToFile, 1304
• Help, 1306
• InstallAbapProgram, 1306
• KillUserConnection, 1308
• ListConnections, 1309
• ListObjectDependencies , 1309
• ListObjects, 1312
• ListTablesBySess, 1317
• ListUserConnections, 1318
• MassUpdate, 1318
• ModifyFolder, 1324
• Notify, 1326
• ObjectExport, 1326
• ObjectImport , 1328
• PurgeVersion, 1329
• Register, 1331
• RegisterPlugin, 1333
• Restore, 1335
• RollbackDeployment , 1336
• Run, 1337
• ShowConnectionInfo, 1338
• SwitchConnection, 1338
• TruncateLog, 1339
• UndoCheckout, 1340
• Unregister, 1341
• UnregisterPlugin, 1342
• UpdateConnection, 1344
• UpdateEmailAddr, 1346
• UpdateSeqGenVals, 1347
• UpdateSrcPrefix, 1348
• UpdateStatistics , 1349
• UpdateTargPrefix, 1349
• Upgrade, 1350
• UninstallAbapProgram, 1351
• Validate, 1352
• Version, 1355
Use pmrep to perform repository administration tasks such as listing repository objects, creating and editing
groups, restoring and deleting repositories, and updating session-related parameters and security
information in the PowerCenter repository.
When you use pmrep, you can enter commands in the following modes:
• Command line mode. You can issue pmrep commands directly from the system command line. Use
command line mode to script pmrep commands.
• Interactive mode. You can issue pmrep commands from an interactive prompt. pmrep does not exit after
it completes a command.
You can use environment variables to set user names and passwords for pmrep. Before you use pmrep,
configure these variables. The environment variables apply to pmrep commands that run on the node.
All pmrep commands require a connection to the repository except for the following commands:
• Help
• ListAllPrivileges
Use the pmrep Connect command to connect to the repository before using other pmrep commands.
Note: If the domain is a mixed-version domain, run pmrep from the installation directory of the Repository
Service version.
1. At the command prompt, change to the directory where the pmrep executable is located.
2. Enter pmrep followed by the command name and its options and arguments:
pmrep command_name [-option1] argument_1 [-option2] argument_2...
Run the Repository Service in exclusive mode to use the following pmrep commands:
• Create
• Delete
• Register
• RegisterPlugin
• Unregister
• UnregisterPlugin
You can use the Administrator tool or infacmd to run the Repository Service in exclusive mode.
Enter one of the following DOS or UNIX echo commands immediately after running the pmrep command:
The following table describes the native connect string syntax for each supported repository database:
• Include a Connect command as the first command called by the script file. This helps ensure that you
perform tasks on the correct repository.
• To run pmrep scripts that connect to different repositories simultaneously, set the INFA_REPCNX_INFO
environment variable in each environment to store the name and file path for the repository connection
file. This prevents a script from overwriting the connection information used by another script.
Connection Subtypes
When you list or update a connection, you can specify the connection subtypes based on the associated
connection type. Based on the repository plugins, the pmrep command lists the connection subtypes in the
repository, by default.
The following table shows the list of connection subtypes for the associated type of connection:
Relational Sybase
Relational DB2
Relational ODBC
Relational Teradata
Relational Netezza
Relational Vertica
Application SAP BW
Application SAP R3
Application SAP_ALE_IDoc_Reader
Application SAP_BWOHS_READER
Application SAP_ALE_IDoc_Writer
Application LMAPITarget
FTP FTP
Queue MSMQ
AddToDeploymentGroup
Adds objects to a deployment group. Use AddToDeploymentGroup to add source, target, transformation,
mapping, session, worklet, workflow, scheduler, session configuration, and task objects.
You cannot add checked out objects to a deployment group. You can specify objects using command options
or you can use a persistent input file. If you use a persistent input file, you can enter the deployment group
name option.
Use AddToDeploymentGroup to add reusable input objects. If you want to add non-reusable input objects,
you must use a persistent input file that contains encoded object IDs.
If AddToDeploymentGroup runs successfully, it either sends back no status information, or it returns a list of
objects that are already in the deployment group. If the command fails, it displays the reason for failure.
-p <deployment_group_name>
{{-n <object_name>
-o <object_type>
-t <object_subtype>]
[-v <version_number>]
[-f <folder_name>]} |
[-i <persistent_input_file>]}
[-s dbd_separator]
The following table describes pmrep AddToDeploymentGroup options and arguments:
-n object_name Required when you add a specific object. Name of the object you are
adding to the deployment group. You cannot enter the name of a
checked out object. You cannot use the -n option if you use the -i option.
-o object_type Required when adding a specific object. Type of object you are adding.
You can specify source, target, transformation, mapping, session,
worklet, workflow, scheduler, session configuration, task, cube, and
dimension.
-t object_subtype Required when using valid subtypes. Type of task or transformation you
are adding. For more information about valid subtypes, see “Listing
Object Types” on page 1314 .
-v version_number Optional. Version of the object to add. Default is the latest version of
the object. The command fails if you specify a version number for a non-
versioned repository.
-f folder_name Required when you enter an object name. Folder that contains the object
you are adding.
-d dependency_types Optional. Dependent objects to add to the deployment group with the
object. Enter one of the following:
- all. pmrep adds the objects and all dependent objects, reusable and
non-reusable, to the deployment group.
- “non-reusable”. pmrep adds the objects and the corresponding non-
reusable dependent objects to the deployment group.
- none. pmrep does not add dependent objects to the deployment
group.
If you omit this parameter, pmrep adds the objects and all dependent
objects to the deployment group.
Note: Use double quotes around arguments that contain spaces or non-
alphanumeric characters.
-s dbd_separator Optional. If an ODBC source has a period (.) in the name, define a
different separator character when you define the source object. For
example, instead of database_name.source_name, define the source
object as database_name\source_name, and define the dbd_separator
as backslash (\).
ApplyLabel
Applies a label to an object or a set of objects in a folder. If you enter a folder name, all the objects in the
folder receive the label. You can apply the label to dependent objects. If you use the
dependency_object_types option, pmrep labels all dependent objects. To apply a label to selected
dependent objects, separate each object type name by a comma with no spaces between them on the
command line.
Use ApplyLabel to label reusable input objects. If you want to label non-reusable input objects, you must use
a persistent input file that contains encoded object IDs.
ApplyLabel 1271
If ApplyLabel succeeds, pmrep displays either no status information or a list of objects that already have the
label. If the command fails, pmrep displays the reason for the failure.
-a <label_name>
{{-n <object_name>
-o <object_type>
[-t <object_subtype>]
[-v <version_number>]
[-f <folder_name>] } |
-i <persistent_input_file>}
[-d <dependency_object_types>]
[-c <comments>]
[-e dbd_separator]
The following table describes pmrep ApplyLabel options and arguments:
-n object_name Required if you are updating a specific object. Name of the object to
receive the label. You cannot enter object names if you use the -i option.
-o object_type Type of object to apply the label to. You can specify source, target,
transformation, mapping, session, worklet, workflow, scheduler, session
config, task, cube, or dimension. Required when applying a label to a
specific object.
-v version_number Optional. Version of the object to apply the label to. The command fails
if the version is checked out. Applies the label to the latest version of
the object by default.
-f folder_name Optional. Folder that contains the objects. If you enter a folder name but
no object name, pmrep applies the label to all objects in the folder. If
you enter a folder name with an object name, pmrep searches the folder
for the object. You cannot use the -f option if you use the -i option.
-d dependency_object_types Optional. Dependent object types to label. Valid dependent object types
include shortcuts, mappings, mapplets, sessions, workflows, worklets,
target definitions, source definitions, and foreign key dependencies.
Use this option with option -p. If you enter an object type, the label
applies to dependent objects of that object type.
-p dependency_direction Optional. Dependent parents or children to apply the label to. You can
specify parents, children, or both. If you do not enter option -d, all
dependent objects receive the label.
If you do not enter this option, the label applies to the specified object.
-m - Optional. Move a label from the current version to the latest version of
an object. Use this argument when the label type is one_per_object.
-e dbd_separator Optional. If an ODBC source has a period (.) in the name, define a
different separator character when you define the source object. For
example, instead of database_name.source_name, define the source
object as database_name\source_name, and define the dbd_separator
as backslash (\).
AssignIntegrationService
Assigns the PowerCenter Integration Service to the specified workflow.
If you run the workflow from the Workflow Manager and you associated a PowerCenter Integration Service
with the workflow in the pmrep AssignIntegrationService command, the workflow runs on the PowerCenter
Integration Service specified with the -i option.
If you run the workflow from the command line, the workflow runs on the PowerCenter Integration Service
specified in the pmcmd StartWorkflow command. The workflow does not run on the PowerCenter Integration
Service that you specified in the pmrep AssignIntegrationService command.
AssignIntegrationService 1273
The following table describes pmrep AssignIntegrationService options and arguments:
-f folder_name Required. Name of the folder that contains the workflow. To enter a
name that contains a space or other non-alphanumeric character,
enclose the name in quotation marks.
AssignPermission
Allows you to add, remove, or update permissions on a global object for a user, group, or the Others default
group.
Note: Only the administrator or the current owner of the object can manage permissions on the object.
-o <object_type>
[-t <object_subtype>]
-n <object_name>
[-s <security_domain>]
-p <permission>
The following table describes pmrep AssignPermission options and arguments:
-o object_type Required. Type of the object for which you want to manage permissions.
You can specify folder, label, deploymentgroup, query, or connection.
-t object_subtype Optional. Type of connection object or query. Not required for other
object types. For more information about valid subtypes, see
“AssignPermission” on page 1274.
-n object_name Required. Name of the object for which you want to manage
permissions. You can use special characters for the object name.
-u user_name Required if you do not use the -g option. Name of the user for whom you
want to add, remove, or update permissions. Use the -u or -g option, not
both.
-g group_name Name of the group for which you want to add, remove, or update
permissions. Specify “Others” as the group name to change permissions
for the Others default group.
Use the -u or -g option, but not both.
You can use special characters for the group name.
-s security_domain Required if you use LDAP authentication. Name of the security domain
that the user or group belongs to. Default is Native.
-p permission Required. Permissions you want to add, remove, or update. You assign
read, write and execute permission on a global object. Use the
characters r, w, and x to assign read, write, and execute permissions.
The following table describes the object types and values to use with pmrep commands:
Query Shared
Query Personal
Connection Application
Connection FTP
Connection Loader
Connection Queue
Connection Relational
Example
You can add, remove, or update permissions with the -p option.
For example, to add read and write permissions on a folder, enter the following text at the prompt:
pmrep AssignPermission -o folder -n Sales -u Admin -p rw
You can also update permissions on an object. For example, you assigned permission to read on a folder and
need to include permission to write. To update permissions, enter the following text at the prompt:
pmrep AssignPermission -o folder -n Sales -u Admin -p rw
To remove all permissions, enter the following text at the prompt:
pmrep AssignPermission -o folder -n Sales -u Admin -p ""
AssignPermission 1275
BackUp
Backs up the repository to the file specified with the -o option. You must provide the backup file name. Use
this command when the repository is running. You must be connected to a repository to use this command.
-o <output_file_name>
[-d <description>]
-o output_file_name Required. Name and path of the file for the repository backup. When you view the
list of repository backup files in the Administrator tool, you can see only files
with an extension of .rep.
-d description Optional. Creates a description of the backup file based on the string that
follows the option. The backup process truncates any character beyond 2,000.
-b - Optional. Skips tables related to workflow and session logs during backup.
To restore the backup file, use the Administrator tool, or use the pmrep Restore command.
ChangeOwner
Changes the owner name for a global object.
Note: Only the administrator or current owner of the object have the permission to change ownership for an
object.
-o <object_type>
-n <object_name>
-u <new_owner_name>
[-s <security_domain>]
The following table describes pmrep ChangeOwner options and arguments:
-o object_type Required. Type of the object. You can specify folder, label, deploymentgroup,
query, or connection.
-t object_subtype Optional. Type of object query or connection object. Not required for other
object types. For more information about valid subtypes, see
“AssignPermission” on page 1274.
-n object_name Required. Name of the object. You can use special characters for the object
name.
-u new_owner_name Required. Name of the changed owner. The changed owner name must be a
valid user account in the domain.
-s security_domain Required if you use LDAP authentication. Name of the security domain that the
new owner belongs to. Default is Native.
CheckIn
Checks in an object that you have checked out. When you check in an object, the repository creates a new
version of the object and assigns it a version number. The version number is one number greater than the
version number of the last checked-in version.
-o <object_type>
[-t <object_subtype>]
-n <object_name>
-f <folder_name>
[-c <comments>]
[-s dbd_separator]
CheckIn 1277
The following table describes pmrep CheckIn options and arguments:
-o object_type Required. Type of object you are checking in: source, target, transformation,
mapping, session, worklet, workflow, scheduler, session config, task, cube, or
dimension.
-t object_subtype Optional. Type of task or transformation to check in. Not required for other
object types. For more information about valid subtypes, see “Listing Object
Types” on page 1314 .
-n object_name Required. Name of the object that you are checking in.
-s dbd_separator Optional. If an ODBC source has a period (.) in the name, define a different
separator character when you define the source object. For example, instead of
database_name.source_name, define the source object as database_name
\source_name, and define the dbd_separator as backslash (\).
CleanUp
Cleans up any persistent resource created by pmrep. This command also cleans up any connection
information from previous sessions of pmrep. Calling CleanUp as the first command in a session always
returns an error.
If you call CleanUp in the interactive mode, pmrep disconnects any repository you are connected to.
ClearDeploymentGroup
Clears all objects from a deployment group. Use this command to retain the deployment group but remove
the objects.
-p <deployment_group_name>
-p deployment_group_name Required. Name of the deployment group that you want to clear.
Connect
Connects to a repository. The first time you use pmrep in either command line or interactive mode, you must
use the Connect command. All commands require a connection to the repository except for the following
commands:
• Exit
• Help
• ListAllPrivileges
In the command line mode, pmrep uses the information specified by the last call to connect to the repository.
If pmrep is called without a successful connection, it returns an error. In command line mode, pmrep
connects to and disconnects from the repository with every command.
To use pmrep to perform tasks in multiple repositories in a single session, you must issue the Connect
command each time you want to switch to a different repository. In the interactive mode, pmrep retains the
connection until you exit pmrep or connect again. If you call Connect again, pmrep disconnects from the first
repository and then connects to the second repository. If the second connection fails, the previous
connection remains disconnected and you will not be connected to any repository. If you issue a command
that requires a connection to the repository, and you are not connected to that repository, pmrep uses the
connection information specified in the last successful connection made to the repository from any previous
session of pmrep. pmrep retains information from the last successful connection until you use the Cleanup
command.
-r <repository_name>
{-d <domain_name> |
{-h <portal_host_name>
-o <portal_port_number>}}
[{ <user_name>
[-s <user_security_domain>]
[-x <password> |
-X <password_environment_variable>]} |
-u <connect_without_user_in_kerberos_mode>]
[-t <client_resilience>]
Connect 1279
The following table describes pmrep Connect options and arguments:
-d domain_name Required if you do not use -h and -o. Name of the domain for the repository.
If you use the -d option, do not use the -h and -o options.
-h portal_host_name Required if you do not use -d. If you use the -h option, then you must also
use the -o option. Gateway host name.
-o portal_port_number Required if you do not use -d. If you use the -o option, then you must also
use the -h option. Gateway port number.
-s user_security_domain Required if you use LDAP authentication. Name of the security domain that
the user belongs to. Default is Native.
-x password Required if you use the -n option and you do not use the -X option.
Password for the user name. The password is case sensitive. Use the -x or -
X option, but not both.
-X password_ Required if you use the -n option and you do not use the -x option. Password
environment_variable environment variable. Use the -x or -X option, but not both.
-u connect_without _user_ Required. Connects to a Repository Service without a user name and
in_kerberos_mode password when the Informatica domain uses Kerberos authentication. Use
the -u option to connect to the Repository Service if the repository has no
content.
Create
Creates the repository tables in the database. Before you can create the repository tables, you must complete
these tasks:
To use the Create command, you must have permission on the Repository Service in the domain.
-u <domain_user_name>
[-s <domain_user_security_domain>]
[-p <domain_password> |
-P <domain_password_environment_variable>]
-p domain_password Optional. Password. Use either the -p or -P option, but not both. If
you do not use either the -p or -P option, pmrep prompts you to
enter the password.
CreateConnection
Creates a source or target connection in the repository. The connection can be a relational, application, or an
FTP connection. Relational database connections for each relational subtype require a subset of all
CreateConnection options and arguments. For example, Oracle connections do not accept the -z, -d, or -t
options. Use the -k option to specify attributes for application connections.
-s <connection_subtype>
-n <connection_name>
[{-u <user_name>
[{-p <password> |
-P <password_environment_variable>
CreateConnection 1281
-K <connection_to_the_Kerberos_server>]
[-c <connect_string> (required for Oracle, Informix, DB2, Microsoft SQL Server, ODBC,
and NetezzaRelational)]
[-l <code_page>]
[-e <connection_environment_SQL>]
[-f <transaction_environment_SQL>]
[-z <packet_size> (valid for Sybase ASE and MS SQL Server connection)]
[-b <database_name> (valid for Sybase ASE, Teradata and MS SQL Server connection)]
[-v <server_name> (valid for Sybase ASE and MS SQL Server connection)]
[-t (enable trusted connection, valid for MS SQL Server connection only)]
[-x (enable advanced security, lets users give Read, Write and Execute permissions only
for themselves.)]
[-y (Provider Type (1 for ODBC and 2 for OLEDB), valid for MS SQL Server connection
only)]
-u user_name Required for some connection types. User name used for
authentication.
-K connection_to_the_Kerberos_server Optional. Indicates that the database that you are connecting to runs
on a network that uses Kerberos authentication.
-l code_page Required for some connection types. Code page associated with the
connection.
-r rollback_segment Optional. Valid for Oracle connections. The name of the rollback
segment. A rollback segment records database transactions that
allow you to undo the transaction.
-z packet_size Optional. Valid for Sybase ASE and Microsoft SQL Server
connections. Optimizes the ODBC connection to Sybase ASE and
Microsoft SQL Server.
-b database_name Optional. Name of the database. Valid for Sybase ASE and Microsoft
SQL Server connections.
-v server_name Optional Name of the database server. Valid for Sybase ASE and
Microsoft SQL Server connections.
-d domain_name Optional Valid for Microsoft SQL Server connections. The name of the
domain. Used for Microsoft SQL Server.
-a data_source_name Optional Teradata ODBC data source name. Valid for Teradata
connections.
CreateConnection 1283
Option Argument Description
-y - Enables the provider type value. You can specify the following
provider types:
- 1 for ODBC
- 2 for Oledb(Deprecated)
For more information about connection subtypes, see “Connection Subtypes” on page 1267.
Changing the database connection code page can cause data inconsistencies if the new code page is not
compatible with the source or target database connection code pages. Also, if you configure the Integration
Service for data code page validation, changing the database connection code page can cause sessions to
fail if the source database connection code page is not a subset of the target database connection code
page.
CreateDeploymentGroup
Creates a deployment group. You can create a dynamic or static deployment group. To create a dynamic
deployment group, you must supply a query name, and indicate whether the query is private or public.
-p <deployment_group_name>
[-q <query_name>]
[-c <comments>]
The following table describes pmrep CreateDeploymentGroup options and arguments:
-t deployment_group_type Optional. Create a static group or use a query to dynamically create the
group. You can specify static or dynamic. Default is static.
-q query_name Required if the deployment group is dynamic, but ignored if the group is
static. Name of the query associated with the deployment group.
-u query_type Required if the deployment group is dynamic, but ignored if the group is
static. Type of query to create a deployment group. You can specify
shared or personal.
CreateFolder
Creates a folder in the repository.
-n <folder_name>
[-d <folder_description>]
[-o <owner_name>]
[-a <owner_security_domain>]
[-s (shared_folder)]
[-p <permissions>]
CreateFolder 1285
The following table describes pmrepCreateFolder options and arguments:
-o owner_name Optional. Owner of the folder. Any user in the repository can be the folder
owner. Default owner is the user creating the folder.
-a owner_security_domain Required if you use LDAP authentication. Name of the security domain
that the owner belongs to. Default is Native.
-p permissions Optional. Access rights for the folder. If omitted, the Repository Service
assigns default permissions.
-f active Optional. Changes the folder status to one of the following statuses:
frozendeploy - active. This status allows users to check out versioned objects in the
frozennodeploy folder.
- frozendeploy (Frozen, Allow Deploy to Replace). This status prevents
users from checking out objects in the folder. Deployment into the
folder creates new versions of the objects.
- frozennodeploy (Frozen, Do Not Allow Deploy to Replace). This status
prevents users from checking out objects in the folder. You cannot
deploy objects into this folder.
Note: You can add, remove, or update permissions on a folder by using the AssignPermission command.
Assigning Permissions
You can assign owner, group, and repository permissions by entering three digits when you use the -p option.
The first digit corresponds to owner permissions, the second corresponds to the permissions of the group
that the user belongs to, and the third corresponds to all other permissions.
Enter one number for each set of permissions. Each permission is associated with a number. Designate 4 for
read permission, 2 for write permission, and 1 for execute permission. To assign permissions, you enter 4, 2,
1, or the sum of any of those numbers.
For example, if you want to assign default permissions, use the following command syntax:
-p 764
This gives the folder owner read, write, and execute permissions (7 = 4+2+1). The owner’s group has read
and write permissions (6 = 4+2). All others have read permission.
The command returns “createfolder successfully completed” or returns “createfolder failed” message. The
creation might fail for the following reasons:
-a <label_name>
[-c <comments>]
The following table describes pmrep CreateLabel options and arguments:
CreateQuery
Creates an object query in the repository. You must configure the query conditions to create an object query.
A query condition consists of a parameter, an operator, and a value. You can enter the expression in a file or
at the command prompt.
-n <query_name>
{-e <expression> |
-f <file_name>}
[-c <comments>]
The following table describes pmrep CreateQuery options and arguments:
-t query_type Required. The type of query. You can specify shared or personal.
-e expression Required if you do not use the -f option. Expression of the query.
-f file_name Required if you do not use the -e option. Name and path of the file that contains the
expression of a query. You must use the -e or -f option, but not both.
CreateLabel 1287
Option Argument Description
The following table describes the query parameters and the valid operators and values for each parameter:
IncludeChildren Displays child dependent Where (Value 1) For value 1 and value
objects. depends on (Value 2), 2, use:
(Value 3) Any,
Source Definition,
Target Definition,
Transformation,
Mapplet,
Mapping,
Cube,
Dimension,
Task,
Session,
Worklet,
Workflow,
Scheduler,
SessionConfig
For value 3 use:
Non-reusable
dependency,
Reusable
dependency.
CreateQuery 1289
Parameter Description Valid Operator Accepted Values
IncludeChildrenAndParents Displays child and parent Where (Value 1) For value 1 and value
dependent objects. depends on (Value 2), 2, use:
(Value 3) Any,
Source Definition,
Target Definition,
Transformation,
Mapplet,
Mapping,
Cube,
Dimension,
Task,
Session,
Worklet,
Workflow,
Scheduler,
SessionConfig
For value 3 use:
Non-reusable
dependency,
Reusable
dependency.
IncludeParents Displays parent dependent Where (Value 1) For value 1 and value
objects. depends on (Value 2), 2, use:
(Value 3) Any,
Source Definition,
Target Definition,
Transformation,
Mapplet,
Mapping,
Cube,
Dimension,
Task,
Session,
Worklet,
Workflow,
Scheduler,
SessionConfig
For value 3 use:
Non-reusable
dependency,
Reusable
dependency.
CreateQuery 1291
Parameter Description Valid Operator Accepted Values
Delete
Deletes the repository tables from the repository database.
Before you use the Delete command, you must connect to the repository and provide a user name and
password or password environment variable.
When you use the Delete command, the Repository Service must be running in exclusive mode. You can
configure the Repository Service to run in exclusive mode in the Administrator tool or you can use the
infacmd UpdateRepositoryService command.
[-x <repository_password_for_confirmation> |
-X <repository_password_environment_variable_for_confirmation>]
Delete 1293
The following table describes pmrep Delete options and arguments:
-x repository_password_for_ Optional. Password. You can use the -x or -X option, but not both. If
confirmation you do not use the -x or -X option, pmrep prompts you to enter the
password for confirmation.
DeleteConnection
Deletes a relational connection from the repository.
-n <connection_name>
-s connection type application, Optional. Type of connection. A connection can be one of the following
relational, ftp, loader or types:
queue - Application
- FTP
- Loader
- Queue
- Relational
Default is relational.
-p <deployment_group_name>
DeleteFolder
Deletes a folder from the repository.
-n <folder_name>
The following table describes pmrep DeleteFolder option and argument:
DeleteLabel
Deletes a label and removes the label from all objects that use it. If the label is locked, the delete fails.
-a <label_name>
DeleteDeploymentGroup 1295
The following table describes pmrep DeleteLabel options and arguments:
DeleteObject
Deletes an object. Use DeleteObject to delete a source, target, user-defined function, mapplet, mapping,
session, worklet or workflow.
-o <object_type>
-f <folder_name>
-n <object_name>
[-s dbd_separator]
The following table describes pmrep DeleteObject options and arguments:
-o object_type Required Type of the object you are deleting: source, target, mapplet, mapping,
session, “user defined function”, worklet, workflow.
-n object_name Required. Name of the object you are deleting. If you delete a source definition
you must prepend the database name. For example, DBD.sourcename.
-s dbd_separator Optional. If an ODBC source has a period (.) in the name, define a different
separator character when you define the source object. For example, instead
of database_name.source_name, define the source object as database_name
\source_name, and define the dbd_separator as backslash (\).
Note: You can run the DeleteObject command against a non-versioned repository. If you run the DeleteObject
command against a versioned repository, pmrep returns the following error:
This command is not supported because the versioning is on for the repository
<Repository name>.
Failed to execute DeleteObject
-n <query_name>
-t query_type Required. The type of query. You can specify shared or personal.
-f - Optional. Delete the query without confirmation. If you omit this argument, the command
prompts for a confirmation before it deletes the query.
DeployDeploymentGroup
Deploys a deployment group. You can use this command to copy a deployment group within a repository or
to a different repository.
To use this command, you must create a control file with all the specifications that the Copy Wizard requires.
The control file is an XML file defined by the depcntl.dtd file.
If pmrep cannot immediately acquire object locks in the target repository, by default it waits indefinitely to
acquire the locks.
You can use the deployment control file parameters to specify a deployment timeout. The deployment
timeout is the period of time (in seconds) that pmrep waits to acquire locks. A value of 0 fails the deployment
if pmrep cannot immediately acquire locks. The default value is -1, which instructs pmrep to wait indefinitely
to acquire the locks.
Press Ctrl+C to cancel the deployment during the deployment operation or while pmrep is waiting to acquire
object locks.
-p <deployment_group_name>
-c <control_file_name>
-r <target_repository_name>
[-n <target_repository_user_name>
[-s <target_repository_user_security_domain>]
DeleteQuery 1297
[-x <target_repository_password> |
-X <target_repository_password_environment_variable>]
[-d <target_domain_name> |
{-h <target_portal_host_name>
[-l <log_file_name>]
The following table describes pmrep DeployDeploymentGroup options and arguments:
-c control_file_name Required. Name of the XML file containing the Copy Wizard
specifications. The deployment control file is required.
-r target_repository_name Required. Name of the target repository where you are copying the
deployment group.
-x target_repository_password Optional. Login password for the target repository. You use the -x or -
X option, but not both. If you copy the deployment group to a
different repository and you do not use the ‑x or -X option, pmrep
prompts you for the password.
-l log_file_name Optional. Log file that records each deployment step. If you omit this
option, pmrep outputs the deployment steps to the command line
window.
To use this command, you must create a control file with all the specifications that the Copy Wizard requires.
The control file is an XML file defined by the depcntl.dtd file.
If pmrep cannot immediately acquire object locks in the target repository, by default it waits indefinitely to
acquire the locks.
You can use the deployment control file parameters to specify a deployment timeout. The deployment
timeout is the period of time (in seconds) that pmrep waits to acquire locks. A value of 0 fails the deployment
if pmrep cannot immediately acquire locks. The default value is -1, which instructs pmrep to wait indefinitely
to acquire the locks.
Press Ctrl+C to cancel the deployment during the deployment operation or while pmrep is waiting to acquire
object locks.
-f <folder_name>
-c <control_file_name>
-r <target_repository_name>
[-n <target_repository_user_name>
[-s <target_repository_user_security_domain>]
[-x <target_repository_password> |
-X <target_repository_password_environment_variable>]
[-d <target_domain_name> |
{-h <target_portal_host_name>
[-l <log_file_name>]
The following table describes pmrep DeployFolder options and arguments:
-c control_file_name Required. Name of the XML file containing the Copy Wizard
specifications.
-r target_repository_name Required. Name of the target repository you are copying the folder
to.
-n target_repository_user_name Required if you copy the folder to another repository. Login user
name for the target repository.
DeployFolder 1299
Option Argument Description
-x target_repository_user_ Optional. Login password for the target repository. Use the -x or -X
password option, but not both. If you copy the folder to a different repository
and you do not use the -x or -X option, pmrep prompt you for the
password.
-d target_domain_name Required if you copy the folder to a different repository and you do
not use the -h and -o options. Name of the domain for the
repository.
-h target_portal_host_name Required if you copy the folder to a different repository and you do
not use the -d option. Machine name for the node that hosts the
domain of the target repository.
-o target_portal_port_number Required if you copy the folder to a different repository and you do
not use the -d option. Port number for the node that hosts the
domain of the target repository.
-l log_file_name Optional. Log file that records each deployment step. If you omit
this option, pmrep outputs the deployment steps to the command
line window.
ExecuteQuery
Runs a query. You can choose to display the result or write the result to a persistent input file. If the query is
successful, it returns the total number of qualifying records.
Use the persistent input file with the ApplyLabel, AddToDeploymentGroup, MassUpdate, and Validate
commands.
-q <query_name>
[-u <output_persistent_file_name>]
[-a (append)]
[-c <column_separator]
[-r <end-of-record_separator>]
[-l <end-of-listing_indicator>]
[-b (verbose)]
-t query_type Optional. Type of query to run. You can specify public or private. If
not specified, pmrep searches all the private queries first to find the
matching query name. Then it searches the public queries.
-u persistent_output_file_name Optional. Send the query result to a text file. If you do not enter a file
name, the query result goes to stdout.
ExecuteQuery 1301
Option Argument Description
-s dbd_separator Optional. If an ODBC source has a period (.) in the name, define a
different separator character when you define the source object. For
example, instead of database_name.source_name, define the source
object as database_name\source_name, and define the
dbd_separator as backslash (\).
Exit
Exits from the pmrep interactive mode.
The command line mode invokes and exits pmrep each time you issue a command.
FindCheckout
Displays a list of checked out objects in the repository. The listing contains the checked-out items unless you
enter “all users.”
If you choose an object type, then you can list checked-out objects in a specific folder or across all folders. If
you do not specify an object type, pmrep returns all the checked-out objects in the repository.
[-o <object_type>]
[-f <folder_name>]
[-u (all_users)]
[-c <column_separator>]
[-r <end-of-record_separator>]
[-l <end-of-listing_indicator>]
[-b (verbose)]
[-s <dbd_separator>]
-o object_type Object type you want to list. You can specify source, target,
transformation, mapping, session, worklet, workflow, scheduler, session
config, task, cube, or dimension. If you do not use this option, pmrep
ignores the -f and -u options and the command returns all checked-out
objects in the repository.
-f folder_name Optional if you specify an object type. Return a list of checked out
objects for the object type in the specified folder. The default is to list
objects for the object type across folders.
-u - Optional. List the checked out objects by all users. The default is to list
checked out objects by the current user.
-r end-of-record_separator Optional. Character or set of characters used to specify the end of the
object metadata. Use a character or set of characters that is not used in
repository object names. Default is newline /n.
-l end-of-listing_indicator Optional. Character or set of characters used to specify the end of the
object list. Use a character or set of characters that is not used in
repository object names. If you omit this option, pmrep uses a period.
-s dbd_separator Optional. If an ODBC source has a period (.) in the name, define a
different separator character when you define the source object. For
example, instead of database_name.source_name, define the source
object as database_name\source_name, and define the dbd_separator
as backslash (\).
GetConnectionDetails
Lists the properties and attributes of a connection object as name-value pairs.
To use the GetConnectionDetails command, you need read permission on the connection object.
GetConnectionDetails 1303
The GetConnectionDetails command uses the following syntax:
getconnectiondetails
-n <connection_name>
-t <connection_type>
The following table describes pmrep GetConnectionDetails options and arguments:
-t connection_type Required. Type of connection. A connection can be one of the following types:
- Application
- FTP
- Loader
- Queue
- Relational
GenerateAbapProgramToFile
Generates the ABAP program for a mapping with SAP table as the source and saves the program as a file.
The GenerateAbapProgramToFile command generates the ABAP program for a mapping in the PowerCenter
repository. The generated program is saved as a file. You can use the GenerateAbapProgramToFile
command for mappings that use SAP tables as the source.
The naming convention for the file is mappingname_<version>_<program_mode>.ab4. You must enclose the
path and the file name in double quotes. After you generate the ABAP program and save it to a file, use the
InstallAbapProgram command to install it on an SAP system.
-s <folder_name>
-m <mapping_name>
[-v <version_number>]
[-l <log_filename>]
-u <user_name>
-x <password>
-c <connect_string>
-t <client>
[-y <language>]
-f <output_file_location>
-s folder_name Required. The name of the folder that contains the mapping for which the ABAP
program needs to be generated.
-v version_number Optional. Version number of the mapping. Default is the latest version.
-l log_filename Optional. Name of the log file where the information or error messages are
written. By default, the log file is created in the directory where you run the
command.
-u user_name Required. SAP source system connection user name. Must be a user for which
you have created a source system connection.
-x password Required. Password for the user name. Use the command line program
pmpasswd to encrypt the user password.
-c connect_string Required. DEST entry defined in the sapnwrfc.ini file for a connection to a
specific SAP application server or for a connection that uses SAP load
balancing.
-y language Optional. SAP Logon language. Must be compatible with the PowerCenter Client
code page. Default is the language of the SAP system.
-p program_mode (file, Required. Mode in which the PowerCenter Integration Service extracts data from
stream) the SAP system. Select file or stream.
-f output_file_location Required. Location in the local machine where you want to save the ABAP
program file.
-n - Optional. Appends a namespace that you registered with SAP to the ABAP
program name.
Example
The following example generates an ABAP program and saves it to a file:
generateabapprogramtofile -s folder_name -m mapping_name -l logfile_name -u user_name -x
password -c connect_string -t 800 -y EN -p stream -e -o program_name -n -a -f "C:
\<informatica_installation_dir>\ABAP_prog"
GenerateAbapProgramToFile 1305
Help
Returns the syntax for the command you specify. If you do not specify a command, then syntax for all of the
pmrep commands is displayed.
For the Help command, use one of the following syntax structures:
help [command]
-help [command]
InstallAbapProgram
Installs an ABAP program in the SAP system. Use the InstallAbapProgram command to generate and install
the ABAP program directly onto the SAP system. You can use this command to install an ABAP program from
a file onto the SAP system. You can use the InstallAbapProgram command for mappings that use SAP tables
as the source.
The InstallAbapProgram command gets the mapping information from the PowerCenter repository for a
mapping and generates the ABAP program. The command installs the generated ABAP program in the SAP
system. The first time you install the ABAP program onto the SAP system, the command generates a
program name. Subsequent installations uses the same program name if you are using the same program
mode.
When you install an ABAP program to the SAP system from a file, you must provide the full path and file
name of the ABAP program you want to install. Enclose the path and the file name in double quotes. You
must provide the folder name and mapping information for which you generated the ABAP program. The
InstallAbapProgram command gets the description of the mapping and appends it to the ABAP program
when it is installed onto the SAP system.
-s <folder_name>
-m <mapping_name>
[-v <version_number>]
[-l <log_filename>]
-u <user_name>
-x <password>
-c <connect_string>
-t <client>
[-y <language>]
{-f <input_file_name> |
-o <override_name> }
[-d <development_class_name>]
-s folder_name Required. The name of the folder that contains the mapping for which the ABAP
program needs to be generated. If you are installing from a file, the name of the
folder that contains the mapping for which you generated the ABAP program.
-m mapping_name Required. Name of the mapping. If you are installing from a file, the name of the
mapping for which you generated the ABAP program.
-v version_number Optional. Version number of the mapping. Default is the latest version. If you are
installing from a file, the version of the mapping for which you generated the
ABAP program.
-l log_filename Optional. Name of the log file where the information or error messages are
written. By default, the log file is stored in the directory where you run the
command.
-u user_name Required. SAP source system connection user name. Must be a user for which
you have created a source system connection.
-x password Required. Password for the user name. Use the command line program
pmpasswd to encrypt the user password.
-c connect_string Required. DEST entry defined in the sapnwrfc.ini file for a connection to a
specific SAP application server or for a connection that uses SAP load
balancing.
-y language Optional. SAP Logon language. Must be compatible with the PowerCenter Client
code page. Default is the language of the SAP system.
-f input_file_name Required if you are installing the ABAP program from a file. Name of the ABAP
program file from where you want to install the ABAP program into the SAP
system.
-p program_mode (file, Required if you are generating and installing the ABAP program directly onto the
stream) SAP system. Optional if you are installing the ABAP program from a file. Mode in
which the PowerCenter Integration Service extracts data from the SAP system.
Select file or stream.
-e - Optional if you are generating and installing the ABAP program directly onto the
SAP system. Overrides the default ABAP program file name.
-a - Optional if you are generating and installing the ABAP program directly onto the
SAP system. Adds authority checks to the ABAP program.
InstallAbapProgram 1307
Option Argument Description
-n - Optional if you are generating and installing the ABAP program directly onto the
SAP system. Appends a namespace that you registered with SAP to the ABAP
program name.
-d development_class_ Optional. Package or the development class name where the PowerCenter
name Repository Service installs the ABAP program. Default development class is
$TMP.
Examples
The following example installs the ABAP program directly onto the SAP system:
installabapprogram -s folder_name -m mapping_name -l logfile_name -u user_name -x
password -c connect_string -t 800 -y EN -p file –e –o zabc -a -n -d development_class
The following example installs the ABAP program from a file onto the SAP system:
installabapprogram -s folder_name -m mapping_name -l logfile_name -u user_name -x
password -c connect_string -t 800 -y EN -p file –v 1 -f "C:
\mapping_name_version_file.ab4"
KillUserConnection
Terminates user connections to the repository. You can terminate user connections based on the user name
or connection ID. You can also terminate all user connections to the repository.
{-i <connection_id> |
-n <user_name> |
-a (kill all)}
The following table describes pmrep KillUserConnection options and arguments:
• Application
• FTP
• Loader
• Queue
• Relational
The ListConnections command uses the following syntax:
listconnections
For more information about connection subtypes, see “Connection Subtypes” on page 1267.
ListObjectDependencies
Lists dependency objects for reusable and non-reusable objects. If you want to list dependencies for non-
reusable objects, you must use a persistent input file containing object IDs. You can create this file by
running a query and choosing to create a text file.
ListObjectDependencies accepts a persistent input file and it can create a persistent output file. These files
are the same format. If you create an output file, use it as input to the ApplyLabel, AddToDeployment Group,
or Validate pmrep commands.
{{-n <object_name>
-o <object_type>
[-t <object_subtype>]
[-v <version_number>]
[-f <folder_name>] } |
-i <persistent_input_file>}
[-d <dependency_object_types>]
ListConnections 1309
[-p <dependency_direction (children, parents, or both)>]
[-u <persistent_output_file_name>
[-a (append)]]
[-c <column_separator>]
[-r <end-of-record_separator>]
[-l <end-of-listing_indicator>]
[-b (verbose)]
[-e <dbd_separator>]
The following table describes pmrep ListObjectDependencies options and arguments:
-o object_type Required. Object type to list dependencies for. You can specify source,
target, transformation, mapping, session, worklet, workflow, scheduler,
session, session config, task, cube, dimension, query and deploymentgroup.
-t object_subtype Type of transformation, task, or query. Ignored for other object types. For
more information about valid subtypes, see “Listing Object Types” on page
1314 .
-v version_number Optional. List dependent objects for an object version other than the latest
version. You must use this option only for versioned repositories. It does
not apply to non-versioned repositories.
-f folder_name Folder containing object name. Folder is required if you do not use the -i
option.
-d dependency_object_types Optional. Type of dependent objects to list. You can enter ALL or one or
more object types. Default is ALL.
If ALL, then pmrep lists all supported dependent objects. If you choose one
or more objects, then pmrep lists dependent objects for these types. To
enter multiple object types, separate them by commas without spaces.
-p dependency_direction Required if you do not use the -s option. Parents or children dependent
objects to list. You can specify parents, children, or both. If you do not use
the -p option, pmrep does not list parent or child dependencies.
-s - Required if you do not use the -p option. Include the primary key-foreign key
dependency object regardless of the direction of the dependency. If you do
not use the -s option, pmrep does not list primary-key/foreign-key
dependencies.
-u persistent_output_file_na Send the dependency result to a text file. Use the text file as input to the
me ApplyLabel, AddToDeployment Group, or Validate pmrep commands. The
default sends the query result to stdout. You cannot use the -b and -c
options with this option.
-a - Append the result to the persistent output file instead of overwriting it.
-r end-of-record_ Character or set of characters used to specify the end of the object
separator metadata. Use a character or set of characters that is not used in repository
object names.
Default is newline /n.
-l end-of-listing_indicator Character or set of characters used to specify the end of the object list.
Enter a character or set of characters that is not used in repository object
names.
If you omit this option, pmrep uses a period.
-b - Verbose. Displays more than the minimum information about the objects. If
you omit this option, pmrep displays a shorter format including the object
type, the word reusable or non-reusable, the object name and path. Verbose
format includes the version number and folder name.
The short format for global objects, such as label, query, deployment group,
and connection, includes the object type and object name. Verbose format
includes the creator name and creation time. You cannot use this option
with the -u option.
-e dbd_separator Optional. If an ODBC source has a period (.) in the name, define a different
separator character when you define the source object. For example,
instead of database_name.source_name, define the source object as
database_name\source_name, and define the dbd_separator as backslash
(\).
ListObjectDependencies 1311
ListObjects
Returns a list of objects in the repository. When you list objects, pmrep returns object metadata. Use the
following list operations:
For example, use ListObjects to list all Sequence Generator transformations in the repository. Create a shell
script that uses ListObjects to return Sequence Generator transformation information, parse the data
ListObjects returns, and use UpdateSeqGenVals to update the sequence values.
pmrep returns each object in a record and returns the metadata of each object in a column. It separates
records by a new line by default. You can enter the characters to use to separate records and columns. You
can also enter the characters to indicate the end of the listing.
Tip: When you enter characters to separate records and columns and to indicate the end of the listing, use
characters that are not used in repository object names. This helps you use a shell script to parse the object
metadata.
-o <object_type>
[-t <object_subtype>]
[-f <folder_name>]
[-c <column_separator>]
[-r <end-of-record_indicator>]
[-l <end-of-listing_indicator>]
[-b (verbose)]
[-s <dbd_separator>]
-f folder_name Required if you list objects other than folders. Folder to search. Use this
option for all object types except deployment group, folder, label, and
query.
-r end-of-record_indicator Optional. Character or set of characters used to specify the end of the
object metadata. Use a character or set of characters that is not used in
repository object names.
Default is newline /n.
-l end_of_listing_indicator Optional. Character or set of characters used to specify the end of the
object list. Enter a character or set of characters that is not used in
repository object names.
If you omit this option, pmrep uses a period.
-b - Optional. Verbose. Display more than the minimum information about the
objects. If you omit this option, you display a shorter format including the
object type, the word reusable or non-reusable, the object name and path.
Verbose format includes the object status, version number, and checked
out information.
The short format for global objects, such as label, query, deployment
group, and connection, includes the object type and object name. Verbose
format includes the label type, query type, deployment group type, creator
name, and creation time.
-s dbd_separator Optional. If an ODBC source has a period (.) in the name, define a different
separator character when you define the source object. For example,
instead of database_name.source_name, define the source object as
database_name\source_name, and define the dbd_separator as backslash
(\).
ListObjects 1313
Listing Object Types
Use the object_type option to define the objects you want to list. The command lists the latest versions or
checked out versions of objects, including shortcuts, but excluding objects according to the rules for object
types.
The following table describes the object types and rules you use with ListObjects:
Mapplet List mapplets with latest or checked out version in a folder, including shortcuts but
excluding instances of reusable mapplets.
Mapping List mappings with latest or checked out version in a folder, including shortcuts but
excluding instances of reusable mapplets.
Scheduler List reusable and non-reusable schedulers with latest or checked out version in a
folder.
Session List reusable and non-reusable sessions with latest or checked out version in a folder,
excluding instances of reusable sessions.
Sessionconfig List the session configurations with latest or checked out version in a folder.
Source List sources with latest or checked out version in a folder, including shortcuts but
excluding source instances.
Target List targets with latest or checked out version in a folder, including shortcuts but
excluding target instances.
Task List reusable and non-reusable tasks with latest or checked out version in a folder.
Transformation List reusable and non-reusable transformations with latest or checked out version in a
folder, including shortcuts and excluding instances of reusable transformations.
Workflow List the workflows with latest version or checked out version in a folder.
Worklet List reusable and non-reusable worklets with latest version or checked out version in a
folder, excluding instances of reusable worklets.
ListObjects 1315
Object Type Subtype Value Description
Listing Folders
Use ListObjects to return each folder in the repository. When you enter folder for the object type, pmrep
ignores the subtype and folder name.
For example, to list all folders in the repository, use the following syntax:
listobjects -o folder
Alternatively, you can enter a different column separator and end of listing indicator:
ListObjects -o folder -c “**” -l #
Listing Objects
Use ListObjects to list reusable and non-reusable objects in the repository or in a folder. pmrep does not
include instances of reusable objects. When you list objects, you must include the folder name for all objects
that are associated with a folder.
pmrep returns the name of the object with the path when applicable. For example, when a transformation is in
a mapping or mapplet, pmrep returns mapping_name.transformation_name or
mapplet_name.transformation_name.
For more information about a list of transformation or task return values, see “Listing Object Types” on page
1314.
For example, to list all transformation types in a folder, enter the following text at the prompt:
listobjects -o transformation -f myfolder
ListTablesBySess
Returns a list of sources or targets used in a session. When you list sources or targets, pmrep returns source
or target instance names to the window. Use ListTablesBySess in a shell script with other pmrep commands.
For example, you can create a shell script that uses ListTablesBySess to return source instance names and
uses Updatesrcprefix to update the source owner name.
When you use ListTablesBySess, pmrep returns source and target instance names as they appear in the
session properties. For example, if the mapping contains a mapplet with a source, pmrep returns the source
instance name in the following format:
mapplet_name.source_name
The ListTablesBySess command uses the following syntax:
listtablesbysess
-f <folder_name>
-s [<qualifying_path>.]<session_name>
ListTablesBySess 1317
The following table describes pmrep ListTablesBySess options and arguments:
-s session_name Required. Name of the session containing the sources or targets. You can enter
a reusable or non-reusable session name. However, you cannot enter an
instance of a reusable session name.
To enter a non-reusable session name in a workflow, enter the workflow name
and the session name as workflow_name.session_name.
-t object_type_listed Required. Enter source to list sources, or enter target to list targets.
For example, to list all sources in a reusable session, enter the following text at the prompt:
listtablesbysess -f myfolder -s s_reus_sess1 -t source
pmrep returns the following information:
ITEMS
mapplet1.ORDERS
Shortcut_To_ITEM_ID
listtablesbysess completed successfully.
When the mapping contains a mapplet with a source, pmrep includes the mapplet name with the source, such
as mapplet1.ORDERS.
For example, you can list all targets in a non-reusable session in a workflow:
listtablesbysess -f myfolder -s wf_workkflow1.s_nrsess1 -t target
pmrep returns the following information:
target1_inst
ORDERS_BY_CUSTID
Shortcut_To_tgt2_inst
listtablesbysess completed successfully.
ListUserConnections
Lists information for each user connected to the repository.
MassUpdate
Updates session properties for a set of sessions that meet specified conditions. You can update all sessions
in a folder or a list of sessions. To update a list of sessions, create a persistent input file. The list can contain
a specific list of sessions, or it can contain conditions such as a name pattern or a property value. Use
ExecuteQuery to generate a persistent input file.
When you run MassUpdate, you can view information such as the folder name, the number of sessions that
are successfully updated or failed, and the names of the sessions that are updated. You can view the status
Use MassUpdate to update a session property across multiple sessions when a PowerCenter version
changes a default value.
Before you update the sessions, you can also run MassUpdate in a test mode to view changes. To view a
sample log file, see “Sample Log File” on page 1324.
-n <session_property_name>
-v <session_property_value>
[-w <transformation_type>]
[-l <condition_value>]
[-g <update_session_instance_flag>]
[-m <test_mode>]
[-u <output_log_file_name>]
The following table describes pmrep MassUpdate options and arguments:
-v session_property_value Required. Value that you want to assign to the property followed by a
semicolon.
For example, to assign a value to the property, use the following
syntax: -v "IgnoreNULLInExpressionComparison=Yes;"
Note: Enclose the session property value in double quotes.
MassUpdate 1319
Option Argument Description
-i persistent_input_file Required if you do not use the -f option. Name of the file that contains
the selected list of sessions to update. You can use the pmrep
ExecuteQuery command to run a query and generate this file.
MassUpdate returns an error if you specify an object that is not a
session. You must use the -i option or the -f option, but not both.
-f folder_name Required if you do not use the -i option. Name of the folder. Use to
update all sessions in a folder. You must use the -i option or the -f
option, but not both.
-o condition_operator Required if you use condition_value. Part of the condition that defines
the session set.
The attribute of a session or session instance is updated when the
condition is met.
You can use the following condition operators to update a string: equal
or unequal.
You can use the following condition operators to update an integer:
equal, unequal, less, or greater.
-l condition_value Required if you use a condition operator. Part of the condition. The
condition appears as follows:
<session_property_value> <condition operator> <condition_value>
-m test_mode Optional. Runs MassUpdate in test mode. View sessions that will be
impacted by the command before you commit changes. You can see
the following details in the command line window:
- Session name
- Type of session: reusable or non-reusable
- Current value of the session property
- Sessions for which the attribute has the same value and are not
affected by the command.
-u output_log_file_name Optional. Name of the log file that stores the status of the update and
basic information about the sessions or session instances. Previous
attribute values are also written to this file. If you do not use this
option, the details appear in the command line window.
The MassUpdate command returns “massupdate successfully completed” or returns “failed to execute
massupdate” message. The update might fail for the following reasons:
• You did not specify a valid attribute value pertaining to the attribute name.
• You specified the correct session property name and the wrong session property type along with it.
• You did not specify the -v option that ends with a semicolon while updating a session property value.
• You did not specify the -w option while updating a transformation instance attribute.
• You did not specify the -g option while updating a session instance run-time option.
• Session properties
• Session configuration attributes
• Transformation instance attributes
• Session instance run time options
The following table lists the session properties that you can update and the session property types:
MassUpdate 1321
Session Property Session Property Type
Is Enabled session_config_property
MassUpdate 1323
Rules and Guidelines for MassUpdate
Use the following rules and guidelines when you run MassUpdate:
• If the node running the Repository Service process has limited memory, disable repository agent caching
before you run MassUpdate or restart the Repository Service after you run MassUpdate.
• You can update reusable and non-reusable sessions.
• You can update the value of any supported session or session config property whether or not it is
overridden.
• You cannot revert property values after you run MassUpdate.
• You cannot update sessions that are checked out.
• You cannot update sessions in frozen folders.
------------------------------------------------------------------------------
11/10/2008 11:12:55 ** Saving... Repository test_ver_MU, Folder cases_auto
------------------------------------------------------------------------------
Session s_test_ff updated.
Checking-in saved objects...done
------------------------------------------------------------------------------
cases_auto,wf_non_reusable_test_ff.s_test_ff_non_reusable,non-reusable,0
wf_non_reusable_test_ff was successfully checked out.
------------------------------------------------------------------------------
11/10/2008 11:12:57 ** Saving... Repository test_ver_MU, Folder cases_auto
------------------------------------------------------------------------------
Validating the flow semantics of Workflow wf_non_reusable_test_ff...
...flow semantics validation completed with no errors.
Massupdate Summary:
Number of reusable sessions that are successfully updated: 1.
Number of non-reusable sessions that are successfully updated: 1.
Number of session instances that are successfully updated: 0.
Number of reusable sessions that fail to be updated: 0.
Number of non-reusable sessions that fail to be updated: 0.
Number of session instances that fail to be updated: 0.
------------------------------------------------------------------------------
ModifyFolder
Modifies folder properties. You modify a folder in a non-versioned repository.
-n <folder_name>
[-d <folder_description>]
[-o <owner_name>]
[-a <owner_security_domain>]
[-p <permissions>]
[-r <new_folder_name>]
[-u <os_profile>]
The following table describes the pmrepModifyFolder options and arguments:
-o owner_name Optional. Current owner of the folder. Any user in the repository can be the
folder owner. Default owner is the current user.
-a owner_security_domain Required if you use LDAP authentication. Name of the security domain that
the owner belongs to. Default is Native.
-p permissions Optional. Access rights for the folder. If omitted, the Repository Service
uses existing permissions.
ModifyFolder 1325
Option Argument Description
-f folder_status Optional. Change the folder status to one of the following status:
- active. This status allows users to check out versioned objects in the
folder.
- frozendeploy (Frozen, Allow Deploy to Replace). This status prevents
users from checking out objects in the folder. Deployment into the
folder creates new versions of the objects.
- frozennodeploy (Frozen, Do Not Allow Deploy to Replace). This status
prevents users from checking out objects in the folder. You cannot
deploy objects into this folder.
Notify
Sends notification messages to users connected to a repository or users connected to all repositories
managed by a Repository Service.
-m <message>
The following table describes pmrep Notify option and argument:
The command returns “notify successfully completed” or returns “failed to execute notify” message. The
notification might fail for the following reasons:
ObjectExport
Exports objects to an XML file defined by the powrmart.dtd file. You export an object by name. If you enter an
object, you must enter the name of the folder that contains it. If you do not enter a version number, you
export the latest version of the object.
Use a persistent input file to specify different objects to export at one time. You can create this file by using
the ExecuteQuery, Validate, or ListObjectDependencies pmrep commands. If you use the persistent input file,
do not use the other parameters to specify objects.
{{-n <object_name>
-o <object_type>
[-t <object_subtype>]
[-v <version_number>]
[-f <folder_name>]} |
-i <persistent_input_file>}
-u <xml_output_file_name>
[-l <log_file_name>]
[-e dbd_separator]
The following table describes pmrep ObjectExport options and arguments:
-n object_name Required if you do not use the -i option. Name of a specific object to export.
If you do not enter this option, pmrep exports all the latest or checked out
objects in the folder. Use the -n option or the -i option, but not both.
-o object_type Object type of the object name. You can specify source, target,
transformation, mapping, mapplet, session, worklet, workflow, scheduler,
session config, or task. If you use this option, you cannot use the -i option.
-t object_subtype Type of transformation or task. This argument is ignored for other object
types. For more information about valid subtypes, see “Listing Object
Types” on page 1314.
-v version_number Optional. Exports the version of the object that you enter.
-f folder_name Name of the folder containing the object to export. If you do not enter an
object name, pmrep exports all the objects in this folder. If you use this
option, you cannot use the -i option.
-i persistent_input_file Required if you do not use the -n option. Text file list of objects generated
from ExecuteQuery, Validate, or ListObjectDependencies. It contains object
records with encoded IDs. If you use this parameter, you cannot use the -n, -
o, or -f options.
ObjectExport 1327
Option Argument Description
-u xml_output_file_name Required. Name of the XML file to contain the object information.
-l log_file_name Optional. Log file that records each export step. If you omit this option,
status messages output to the window.
-e dbd_separator Optional. If an ODBC source has a period (.) in the name, define a different
separator character when you define the source object. For example,
instead of database_name.source_name, define the source object as
database_name\source_name, and define the dbd_separator as backslash
(\).
Examples
The following example exports a mapping named “map,” which is located in folder1, to a file named map.xml:
objectexport -n map -o mapping -f folder1 -u map.xml
The following example exports the objects identified in a persistent input file named persistent_input.xml to a
file named map.xml:
objectexport -i persistent_input.txt -u map.xml
Note: If you use a manually created persistent input file, since you enter “none” for the encoded ID, the
following message appears: Ids are invalid. Trying with names for [none,folder1,map,mapping,none,1].
ObjectImport
Imports objects from an .xml file. This command requires a control file to specify the objects to import and
how to resolve conflicts. The control file is an .xml file defined by the impcntl.dtd file.
-i <input_xml_file_name>
-c <control_file_name>
[-l <log_file_name>]
-c control_file_name Required. Name of the control file that defines import options.
-l log_file_name Optional. Log file that records each export step. If you omit this option,
status messages output to the window.
Note: The ObjectImport command does not create a folder if the folder name you enter does not exist in the
repository.
You can generate audit logs when you import an .xml file into the PowerCenter repository with the pmrep
ObjectImport command. When you import one or more repository objects, you can generate audit logs. To
include security audit trails in the user activity log events, enable the SecurityAuditTrail property for the
PowerCenter Repository Service in the Administrator tool before you import an .xml file. The user activity logs
captures all the audit messages.
The audit logs contain the following information about the .xml file imported:
• Host name and IP address of the client machine from which the .xml file was imported
• Full local path of the .xml import file
• The file name
• The file size in bytes
• Logged in user name
• Number of objects imported
• Time stamp of the import operation
PurgeVersion
Purges object versions from the repository database. You can purge versions of deleted objects and active
objects. An object is a deleted object if the latest version is checked in and it has the version status Deleted.
Other objects are active objects.
When you purge versions of deleted objects, you purge all versions. The deleted objects must be checked in.
You can purge versions for all deleted objects or for objects deleted before a specified end time. You can
specify the end time as a date and time, a date only, or a number of days before the current date.
When you purge versions of active objects, you can specify purge criteria. You can specify the number of
versions to keep and purge the previous versions, and you can purge versions that are older than a specified
purge cutoff time. You cannot purge a checked-out version or the latest checked-in version.
If you purge versions of a composite object, consider which versions of the dependent objects are purged.
You can use the -k option to display the objects that do not purge and the reason object versions do not
purge. For example, you might not have permission to purge an object version. You cannot purge object
versions that are part of a deployment group.
PurgeVersion 1329
The PurgeVersion command uses the following syntax:
purgeversion
{-d <all | time_date | num_day> |
{-n <last_n_versions_to_keep> |
-t <time_date | num_day>}}
[-f <folder_name>]
[-q <query_name>]
[-o <output_file_name>]
[-p (preview purged objects only)]
[-b (verbose)]
[-c (check deployment group reference)]
[-s dbd_separator]
[-k (log objects not purged)]
The following table describes pmrep PurgeVersion options and arguments:
-d all Required if you do not use -n or -t. Purges all versions of checked-in
time_date deleted objects. You can specify all for all deleted objects, or you can
specify an end time to purge all versions of objects that were deleted
num_day
before the end time. You specify the end time in MM/DD/YYYY
HH24:MI:SS format, MM/DD/YYYY format, or as the number of days
before the current date. If you specify a number of days, the value must
be an integer greater than 0.
-n last_n_versions_to_keep Required if you do not use -d or -t. Number of latest checked-in object
versions to keep for an active object. The value must be an integer
greater than 0. For example, enter 6 to purge all versions except the last
six checked-in versions. If the object is checked out, you also retain the
checked-out version.
Note: After you purge object versions, you cannot retrieve them. To
ensure that you can revert to past versions, avoid purging all versions of
an object.
-t purge_cutoff_time Required if you do not use -d or -n. Cutoff time for purging object
versions of active objects. Purges versions that were checked in before
the cutoff time. You can specify the purge cutoff time in MM/DD/YYYY
HH24:MI:SS format, MM/DD/YYYY format, or as a number of days
before the current date. If you specify a number of days, the value must
be an integer greater than 0. When you use the ‑t option, you retain the
latest checked-in version even if it was checked in after the purge cutoff
time.
-f folder_name Optional. Folder from which object versions are purged. If you do not
specify a folder, you purge object versions from all folders in the
repository.
-q query_name Optional. Query used to purge object versions from a particular query
result set.
Note: If you use the -d option, you purge all versions of the deleted
objects. To keep recent versions of deleted objects and purge older
versions, you can define a query that returns the deleted objects and
then use the -q option with -n, -t, or both.
-o outputfile_name Optional. Output file for saving information about purged object
versions.
-s dbd_separator Optional. If an ODBC source has a period (.) in the name, define a
different separator character when you define the source object. For
example, instead of database_name.source_name, define the source
object as database_name\source_name, and define the dbd_separator
as backslash (\).
-k - Optional. Lists all the object names and versions that do not purge
although they match the purge criteria. The -k option also lists the
reason that the object versions do not purge. For example, an object
version does not purge if you do not have sufficient privileges to purge
the object.
Note: An object version does not purge when it belongs to a deployment
group. When an object is a member of more than one deployment group,
the reason lists the first deployment group that causes the object not to
purge.
Examples
The following example purges all versions of all deleted objects in the repository:
pmrep purgeversion -d all
Note: For optimal performance, purge at the folder level or use purge criteria to reduce the number of purged
object versions. Avoid purging all deleted objects or all older versions at the repository level.
The following example purges all but the latest checked-in version of objects in the folder1 folder:
pmrep purgeversion -n 1 -f folder1
The following example previews a purge of all object versions that were checked in before noon on January
5, 2005, and outputs the results to the file named purge_output.txt:
pmrep purgeversion -t '01/05/2005 12:00:00' -o purge_output.txt -p
Register
Registers a local repository with a connected global repository. You must connect to the global repository
before you register the local repository.
Register 1331
Also, you must run the Repository Service for the local repository in exclusive mode. You can configure the
Repository Service to run in exclusive mode in the Administrator tool or you can use the infacmd
UpdateRepositoryService command.
The command returns “register successfully completed” or returns “failed to execute register” message. The
registration might fail for the following reasons:
-r <local_repository_name>
-n <local_repository_user_name>
[-s <local_repository_user_security_domain>]
[-x <local_repository_password> |
-X <local_repository_password_environment_variable>]
[-d <local_repository_domain_name> |
{-h <local_repository_portal_host_name>
-x local_repository_password Optional. Login password for the local target repository. You use
the -x or -X option, but not both. If you do not use the -x or -X
option, pmrep prompts you for the password.
RegisterPlugin
Registers an external plug-in to a repository. Registering a plug-in adds its functionality to the repository. Use
the RegisterPlugin command to update existing plug-ins.
When you use this command, the Repository Service must be running in exclusive mode. You can configure
the Repository Service to run in exclusive mode in the Administrator tool or you can use the infacmd
UpdateRepositoryService command.
-i <input_registration_file_name_or_path>
[-l <NIS_login>
{-w <NIS_password> |
-W <NIS_password_environment_variable>}
-i input_registration_file_name_or_ Required. Name or path of the registration file for the plug-in.
path
RegisterPlugin 1333
Option Argument Description
Example
You administer PowerCenter for an organization that has a centralized LDAP NIS for user authentication.
When you upgrade PowerCenter, you decide to use the LDAP for user authentication. The upgrade installs the
LDAP security module in the repository security folder. After connecting to the repository with the Connect
command, the administrator runs the pmrep command to register the new external module with the
repository:
pmrep registerplugin -i security/ldap_authen.xml -l adminuser -w admnpass
The -l login name and -w login password options contain the valid NIS login information for the user running
the pmrep command. After registration, you must use this login name and password to access the repository.
The -i option contains the XML file name that describes the security module.
Restore
Restores a repository backup file to a database. The target database must be empty.
-u <domain_user_name>
[-s <domain_user_security_domain>]
[-p <domain_password> |
-P <domain_password_environment_variable>]
-i <input_file_name>
[-e (exit if domain name in the binary file is different from current domain name)]
The following table describes pmrep Restore options and arguments:
-p domain_password Optional. Password. You can use the -p or ‑P option, but not both.
If you do not use the -p or -P option, pmrep prompts you for the
password.
-i input_file_name Required. Name of the repository backup file. Use a file name and
path local to the Repository Service.
Restore 1335
Option Argument Description
Example
The following example restores a repository as a versioned repository and specifies the administrator user
name and password to retain the LDAP security module registration:
restore -u administrator -p password -i repository1_backup.rep -y
RollbackDeployment
Rolls back a deployment to purge deployed versions of objects from the target repository. Use this command
to roll back all the objects in a deployment group that you deployed at a specific date and time.
You cannot roll back part of the deployment. To roll back, you must connect to the target repository. You
cannot roll back a deployment from a non-versioned repository.
To initiate a rollback, you must roll back the latest version of each object.
-r repository_name Optional. Name of the source repository from where you deploy
the deployment group.
-v nth_latest_version_of_deployment_ Optional. Version of the deployment group you want to roll back.
group
Example
You have a deployment with five versions and want to rollback the last two versions. To do this, you must
first roll back the latest deployment. Enter the following text at the prompt to roll back once and purge the
last deployment:
rollbackdeployment -p Deploy_sales -t 1
Next, enter the following text to roll back the next to last deployment:
rollbackdeployment -p Deploy_sales -t 2
Run
Opens a script file containing multiple pmrep commands, reads each command, and runs them. If the script
file is UTF-8 encoded, you must use the -u option and the repository code page must be UTF-8. If you run a
UTF-8 encoded script file that includes the Connect command against a repository that does not have a
UTF-8 code page, the Run command will fail.
If the script file is not UTF-8 encoded, omit the -u option. If you use the -o option and the -u option, pmrep
generates the output file in UTF-8. If you use the -o option and omit the -u option, pmrep generates the output
file based on the system locale of the machine where you run pmrep.
The command returns “run successfully completed” or returns “run failed” message. The run might fail if the
Repository Service cannot open the script file or output file.
-f <script_file_name>
[-o <output_file_name>]
Run 1337
The following table describes pmrep Run options and arguments:
-o output file name Optional. Name of the output file. This option writes all messages generated by
the commands in the script file into the output file. If you use the -u option and
the -o option, pmrep generates a UTF-8 encoded output file. If you use the -o
option without the -u option, pmrep encodes the output file based on the system
locale of the machine running pmrep.
-u - Optional. Encodes the output file in UTF-8 format. If you use the -u option and the
-o option, pmrep also encodes the output file in UTF-8 format. Use this option only
if the repository code page is UTF-8.
ShowConnectionInfo
Returns the repository name and user information for the current connection.
Use the ShowConnectionInfo command in interactive mode. When you connect to a repository in interactive
mode, pmrep keeps the connection information in memory until you exit the repository or connect to a
different repository.
When you use the ShowConnectionInfo command in command line mode, a message indicating failure to
execute the command is given. pmrep does not keep connection information in command line mode. The
ShowConnectionInfo command does not connect to the repository.
SwitchConnection
Changes the name of an existing connection. When you use SwitchConnection, the Repository Service
replaces the relational database connections for all sessions using the connection in one of the following
locations:
• Source connection
• Target connection
• Connection Information property in Lookup transformations
• Connection Information property in Stored Procedure transformations
• $Source Connection Value session property
For example, you have a relational and an application source, each called ITEMS. In a session, you specified
the name ITEMS for a relational source connection instead of Relational:ITEMS. When you use
SwitchConnection to replace the relational connection ITEMS with another relational connection, pmrep does
not replace any relational connection in the repository because it cannot determine the connection type for
the source connection entered as ITEMS.
-o <old_connection_name>
-n <new_connection_name>
The following table describes pmrep SwitchConnection options and arguments:
TruncateLog
Deletes details from the repository. You can delete all logs, or delete logs for a folder or workflow. You can
also enter a date and delete all logs older than that date.
The command returns “truncatelog completed successfully” or returns a “Failed to execute truncatelog”
message. The truncate operation might fail for the following reasons:
[-f <folder_name>]
[-w <workflow_name>]
TruncateLog 1339
The following table describes pmrep TruncateLog options and arguments:
-t logs_truncated Required. Use “all” to delete all logs, or enter an end time. pmrep deletes
all logs older than the end time. You can enter the end time with the
format MM/DD/YYYY HH24:MI:SS, or you can specify the number of days
before the current date. If you specify the number of days, the end time
must be an integer greater than 0.
-f folder_name Optional. Deletes logs associated with the folder. If you do not give both
the folder name and the workflow name, then pmrep deletes all logs from
the repository.
-w workflow_name Optional. Deletes logs associated with the workflow. The Repository
Service deletes all logs from the repository if you do not give both the
folder name and the workflow name. If you give both the folder name and
workflow name, the Repository Service deletes logs associated with the
workflow. If you enter the workflow name, you must also provide the folder
name.
UndoCheckout
Reverses the checkout of an object. When you undo a checkout, the repository releases the write-intent lock
on the object and reverts to the most recently checked in version of the object. If you want to modify the
object again, you must check it out.
-o <object_type>
[-t <object_subtype>]
-n <object_name>
-f <folder_name>
[-s dbd_separator]
The following table describes pmrep UndoCheckout options and arguments:
-o object_type Required. Type of object. You can specify source, target, transformation,
mapping, session, worklet, workflow, scheduler, session config, task, cube,
and dimension.
-t object_subtype Optional. Type of transformation or task. Ignored for other object types.
For more information about valid subtypes, see “Listing Object Types” on
page 1314.
-s dbd_separator Optional. If an ODBC source has a period (.) in the name, define a different
separator character when you define the source object. For example,
instead of database_name.source_name, define the source object as
database_name\source_name, and define the dbd_separator as backslash
(\).
Unregister
Unregisters a local repository from a connected global repository.
To use this command, you must run the Repository Service for the local repository in exclusive mode. You
can configure the Repository Service to run in exclusive mode in the Administrator tool or you can use the
infacmd UpdateRepositoryService command.
The command returns “unregister successfully completed” or returns “failed to execute unregister” message.
The registration might fail for the following reasons:
• The Repository Service for the local repository is not running in exclusive mode.
• The Repository Service failed to initialize information about the global repository.
• You failed to connect to the Repository Service.
The Unregister command uses the following syntax:
unregister
-r <local_repository_name>
-n <local_repository_user_name>
[-s <local_repository_user_security_domain>]
[-x <local_repository_password> |
-X <repository_password_environment_variable>]
[-d <local_repository_domain_name> |
{-h <local_repository_portal_host_name>
Unregister 1341
Option Argument Description
-x local_repository_password Required if you do not use the -X option. Login password for the
local target repository. You must use the -x or -X option, but not
both.
UnregisterPlugin
Removes a plug-in from a repository. You can add and remove plug-ins to extend system functionality. A
plug-in is a software module that introduces new repository metadata.
When you use this command, the Repository Service must be running in exclusive mode. You can configure
the Repository Service to run in exclusive mode in the Administrator tool or you can use the infacmd
UpdateRepositoryService command.
-v <vendor_id>
-l <plug-in_id>
{-w <new_password> |
-W <new_password_environment_variable>}]
Note: Although you can save the associations between external logins and user names, the Repository
Manager does not display the external logins while running under user authentication.
You must use the -w or -W option to create a new password when you unregister the security module.
Example
As an administrator, you decide to switch from the LDAP security module back to repository authentication.
You remove the user name-login mapping. Any users that you added to the system under repository
UnregisterPlugin 1343
authentication can log in with their old user names and passwords. Any users you added to the repository
under the LDAP security cannot log in until you enable their user names.
Note: You must provide the LDAP NIS login and password to use the UnregisterPlugin command. You must
also provide a new password to use after you switch back to user authentication.
UpdateConnection
Updates the user name, password, connect string, and attributes for a database connection.
The command returns an “operation successfully completed” or returns “operation failed” message. A failure
might occur for the following reasons:
-t <connection_subtype>
-d <connection_name>
[{[-u <new_user_name>]
[{-p <new_password> |
-P <new_password_environment_variable>
-K <connection_to_the_Kerberos_server>]
[-c <new_connection_string>]
[-a <attribute_name>
-v <new_attribute_value>]
-u new_user_name Optional. User name used for authentication when you connect to the
relational database.
-p new_password Optional. Password used for authentication when you connect to the
relational database. Use the -p or -P option, but not both.
To specify a parameter in the password, add the $Param prefix for the -p
option and ensure that you use the -w option. Do not use a dollar sign ($)
anywhere else in the -p option, and enter the parameter password without
spaces. For example, -p '$Param_abc' -w
-P new_password_ Optional. Password environment variable used for authentication when you
environment_variable connect to the relational database. Use the -p or -P option, but not both.
-x - Optional. Disables the use of password parameters if you use the parameter
in password.
pmrep uses the password specified with the -p or -P option.
-K - Optional. Indicates that the database that you are connecting to runs on a
network that uses Kerberos authentication.
-c new_connection_string Optional. Connect string the Integration Service uses to connect to the
relational database.
-v new_attribute_value Required if you use the -a option. New attribute value of the connection.
Enter “yes” to enable new attributes, and “no” to disable new attributes.
UpdateConnection 1345
Option Argument Description
-s connection type Optional. Type of connection. A connection can be one of the following
application, relational, types:
ftp, loader or queue - Application
- FTP
- Loader
- Queue
- Relational
Default is relational.
Note: The connection subtype in the -t option must be valid for the
associated connection type specified with the -s option.
For more information about connection subtypes, see “Connection Subtypes” on page 1267.
UpdateEmailAddr
Updates the session notification email addresses associated with the Email tasks assigned to the session. If
you did not previously enter a success or failure Email task for the session, the command does not update
the email addresses. You can update the email notification addresses for a non-reusable session with a
unique name in the folder. You can enter different addresses to receive either success or failure notifications.
This command requires you to connect to a repository.
-d <folder_name>
-s <session_name>
-u <success_email_address>
-f <failure_email_address>
UpdateSeqGenVals
Updates one or more of the following properties for the specified Sequence Generator transformation:
• Start Value
• End Value
• Increment By
• Current Value
You might want to update sequence values when you move a mapping from a development environment to a
production environment. Use the UpdateSeqGenVals command to update reusable and non-reusable
Sequence Generator transformations. However, you cannot update values for instances of reusable
Sequence Generator transformations or shortcuts to Sequence Generator transformations.
-f <folder_name>
[-m <mapping_name>]
-t <sequence_generator_name>
[-s <start_value>]
[-e <end_value>]
[-i <increment_by>]
[-c <current_value>]
The following table describes pmrep UpdateSeqGenVals options and arguments:
-m mapping_name Mapping name. When you update values for a non-reusable Sequence
Generator transformation, you must include the mapping name.
UpdateSeqGenVals 1347
Option Argument Description
-s start_value Optional. Start value of the generated sequence you want the
Integration Service to use if the Sequence Generator transformation
uses the Cycle property. If you select Cycle in the transformation
properties, the Integration Service cycles back to this value when it
reaches the end value.
If you designate an invalid value, pmrep gives an error message and
does not update the Sequence Generator transformation.
-c current_value Optional. Current value of the sequence. Enter the value you want the
Integration Service to use as the first value in the sequence. If you
want to cycle through a series of values, the current value must be
greater than or equal to the start value and less than the end value.
If you designate an invalid value, pmrep gives an error message and
does not update the Sequence Generator transformation.
UpdateSrcPrefix
Updates the owner name for session source tables. You can update the owner name for one or all sources in
a session. Updatesrcprefix updates the owner name for source tables at the session level.
pmrep updates source table owner names if you previously edited the source table name in the session
properties.
-f <folder_name>
-s [<qualifying_path>.]<session_name>
[-t <source_name>]
-p <prefix_name>
[-n (use source instance name; not using -n gives old, deprecated behavior)]
-p prefix_name Required. Owner name you want to update in the source table.
UpdateStatistics
Updates statistics for repository tables and indexes.
UpdateTargPrefix
Updates the table name prefix for session target tables. The table name prefix specifies the owner of the
table in the database. You can update the owner name for one or all targets specified in a session.
UpdateTargPrefix updates the target table name prefix at the session level.
UpdateStatistics 1349
pmrep updates table name prefixes if you previously edited the table name prefix at the session level.
-f <folder_name>
-s [<qualifying_path>.]<session_name>
[-t <target_name>]
-p <prefix_name>
[-n (use target instance name; not using -n gives old, deprecated behavior)]
The following table describes the pmrep UpdateTargPrefix options and arguments:
-p prefix_name Required. Table name prefix you want to update in the target table.
Upgrade
Upgrades a repository to the latest version.
[-x <repository_password_for_confirmation> |
-x repository_ password_for_ Optional. Password. You can use the -x or -X option, but not both. If
confirmation you do not use the -x or -X option, pmrep prompts you to enter the
password for confirmation.
UninstallAbapProgram
Uninstalls the ABAP program. Uninstall an ABAP program when you no longer want to associate the program
with a mapping. The command uninstalls the programs from the SAP system and removes the corresponding
program information from the PowerCenter repository.
-s <folder_name>
-m <mapping_name>
[-v <version_number>]
[-l <log_filename>]
-u <user_name>
-x <password>
-c <connect_string>
-t <client>
[-y <language>]
-s folder_name Required. The name of the folder that contains the mapping of the ABAP
program that you want to uninstall.
-v version_number Optional. Version number of the mapping. Default is the latest version.
UninstallAbapProgram 1351
Option Argument Description
-l log_filename Optional. Name of the log file where the command writes the information or error
messages. By default, the log file is stored in the directory where you run the
command.
-u user_name Required. SAP source system connection user name. Must be a user for which
you have created a source system connection.
-x password Required. Password for the user name. Use the command line program
pmpasswd to encrypt the user password.
-c connect_string Required. DEST entry defined in the sapnwrfc.ini file for a connection to a
specific SAP application server or for a connection that uses SAP load
balancing.
-y language Optional. SAP Logon language. Must be compatible with the PowerCenter Client
code page. Default is the language of the SAP system.
-p program_mode (file, Required. Mode in which the PowerCenter Integration Service extracts data from
stream) the SAP system. Select file or stream.
Example
The following example uninstalls the ABAP program:
uninstallabapprogram -s folder_name -m mapping_name -l logfile_name -u user_name -x
password -c connect_string -t 800 -y EN -p stream
Validate
Validates objects. You can output the results to a persistent output file or standard output.
It also displays a validation summary to stdout. The summary includes the number of valid objects, invalid
objects, and skipped objects. The persistent output file contains standard information, encoded IDs, and a
CRC check. You can save and check in the objects that change from invalid to valid.
• Mappings
• Mapplets
• Sessions
• Workflows
• Worklet objects
If you use another type of object in the input parameter, pmrep returns an error. If you use the wrong type of
object in a persistent input file, pmrep reports an error and skips the object.
When you run Validate, you can output information about object status:
-n object_name Required. Name of the object to validate. Do not use this option if you
use the -i argument.
When you validate a non-reusable session, include the workflow
name. Enter the workflow name and the session name in the
following format:
<workflow name>.<session instance name>
When you validate a non-reusable session in a non-reusable worklet,
enter the workflow name, worklet name, and session name in the
following format:
<workflow name>.<worklet name>.<session instance name>
-o object_type Required if you are not using a persistent input file. Type of object to
validate. You can specify mapplet, mapping, session, worklet, and
workflow.
Validate 1353
Option Argument Description
-m check_in_comments Required if you use the -k option, and the current repository requires
checkin comments. Add comments when you check in an object.
-p output_option_types Required if you use the -u argument. Type of object you want to
output to the persistent output file or stdout after validation. You can
specify valid, saved, skipped, save_failed, invalid_before, or
invalid_after. To enter one or more options, separate them by
commas.
-u persistent_output_file_name Required if you use the - p argument. Name of an output text file. If
you enter a file name, the query writes the results to a file.
-a append Optional. Append the results to the persistent output file instead of
overwriting it.
Version 1355
Chapter 44
• Persistent input file. Use a persistent input file to specify repository objects that you want to process.
• Object import control file. Use the object import control file and specify a set of questions to help define
how objects are imported.
• Deployment control file. You can copy the objects in a dynamic or static deployment group to multiple
target folders in the target repository.
1356
• ListObjectDependencies. List dependency objects. This command can use a persistent input file for
processing, and it can create one.
• MassUpdate. Updates session properties for a set of sessions.
• ObjectExport. Export objects to an XML file.
• Validate. Validate objects. This command can use a persistent input file for processing, and it can create
one.
The persistent input file uses the following format:
encoded ID, foldername, object_name, object_type, object_subtype, version_number,
reusable|non-reusable
The pmrep commands that use a persistent input file get object information from the encoded IDs. The
encoded IDs enable pmrep to process the input file quickly.
When you create a persistent input file with pmrep, it creates the file in the pmrep installation directory. You
can specify a different path.
Example
You can use the ExecuteQuery command to create a persistent input file of objects to process in another
pmrep command. For example, you want to export all logically deleted objects from the repository. You might
create a query called find_deleted_objects. When you run the query with pmrep, as shown here, it finds all the
deleted objects in the repository and outputs the results to a persistent input file:
ExecuteQuery -q find_deleted_objects -t private -u deletes_workfile
You can then use deletes_workfile as the persistent input file to ObjectExport:
ObjectExport -i deletes_workfile -u exported_del_file
ObjectExport exports all the referenced objects to an XML file called exported_del_file.
• Enter “none” for the encoded ID. The pmrep commands get the object information from the other
arguments in the records.
• For source objects, enter the object name as <DBD_name>.<source_name>.
• For objects, such as mappings, that do not have a sub_type, enter “none” as object_subtype, or leave it
blank. For more information about valid transformations and task types, see “Listing Object Types” on
page 1314.
• For versioned repositories, enter the version number of the object you want, or enter “LATEST” to use the
latest version of the object.
• For non-versioned repositories, leave the version_number argument blank.
• For object types, such as targets, that are not reusable or non-reusable, drop the argument.
• You cannot include non-reusable objects. You can specify the reusable parent of the non-reusable object.
For example, you want to list the object dependencies for a non-reusable Filter transformation. You can
specify the mapping that is the parent object of the transformation:
none,CAPO,m_seqgen_map,mapping,none,1,reusable
The mapping m_seqgen_map is the reusable parent of the Filter transformation. The command runs
successfully when you specify the reusable parent.
Note: When you use a manually created persistent input file, the Repository Service returns a message
indicating that the ID is not valid. This is an informational message. The Repository Service recognizes that
this is a manually created input file and can process the command with “none” as the ID.
Example
The following example shows a manually created persistent input file:
none,EXPORT,CustTgt,target,none,2
none,EXPORT,S_Orders,session,,2,reusable
none,EXPORT,EXP_CalcTot,transformation,expression,LATEST,reusable
In the first record, CustTgt is a target definition. Targets have no subtype, so you enter “none” for the
object_subtype argument. A target cannot be reusable or non-reusable, so you drop the reusable argument.
Note that the record has six arguments instead of seven.
In the second record, S_Orders is a session. Sessions have no subtype, so you leave the argument blank.
In the third record, you want the latest version of the transformation, so you enter “LATEST” for the
version_number argument.
<!--IMPORTPARAMS This inputs the options and inputs required for import operation -->
<!--CHECKIN_AFTER_IMPORT Check in objects on successful import operation -->
<!--FOLDERMAP matches the folders in the imported file with the folders in the target
repository -->
<!ELEMENT FOLDERMAP EMPTY>
<!ATTLIST FOLDERMAP
SOURCEFOLDERNAME CDATA #REQUIRED
SOURCEREPOSITORYNAME CDATA #REQUIRED
TARGETFOLDERNAME CDATA #REQUIRED
TARGETREPOSITORYNAME CDATA #REQUIRED
>
<!--Import will only import the objects in the selected types in TYPEFILTER node -->
<!--TYPENAME type name to import. This should comforming to the element name in
powermart.dtd, e.g. SOURCE, TARGET and etc.-->
<!ELEMENT TYPEFILTER EMPTY>
<!ATTLIST TYPEFILTER
TYPENAME CDATA #REQUIRED
>
<!--LABELOBJECT allows objects in the target with label name to apply replace/reuse upon
conflict -->
<!ELEMENT LABELOBJECT EMPTY>
<!ATTLIST LABELOBJECT
LABELNAME CDATA #REQUIRED
RESOLUTION (REPLACE | REUSE | RENAME) #REQUIRED
>
<!--QUERYOBJECT allows objects result from a query to apply replace/reuse upon conflict
-->
<!ELEMENT QUERYOBJECT EMPTY>
<!ATTLIST QUERYOBJECT
QUERYNAME CDATA #REQUIRED
RESOLUTION (REPLACE | REUSE | RENAME) #REQUIRED
>
RESOLVECONFLICT LABELOBJECT, QUERYOBJECT, TYPEOBJECT, AND You can specify conflict resolutions
SPECIFICOBJECT elements. for objects.
You can use the following object types with the OBJECTTYPENAME attribute:
• All
• Aggregator
• App Multi-Group Source Qualifier
• Application Source Qualifier
Note: Use the object type “All” to reuse or replace all objects.
The following table provides a description of sample object import control files:
Function Description
Import source objects. Use the TYPEFILTER element to import only source objects.
Import multiple objects into a folder. Use the IMPORTPARAMS and FOLDERMAP elements to import multiple
objects.
Check in and label imported objects. Use the CHECKIN_AFTER_IMPORT and APPLY_LABEL_NAME attributes of
the IMPORTPARAMS element to label imported objects.
Retain Sequence Generator and Use the RETAIN_GENERATED_VALUE attribute of the IMPORTPARAMS
Normalizer transformation values. element to retain Sequence Generator and Normalizer values when you
import objects.
Import objects and local shortcut Use all attributes of the FOLDERMAP element to import objects and local
objects to the same repository. shortcut objects that reference the objects.
Import shortcut objects from another Use all attributes of the FOLDERMAP element to import shortcut objects
repository. from another repository.
Import objects to multiple folders. Use all attributes of the FOLDERMAP element to import objects to multiple
folders.
Import specific objects. Use the TYPEFILTER element to import specific objects.
Reuse and replace dependent objects. Use the OBJECTTYPENAME and RESOLUTION attributes of the
TYPEOBJECT element to reuse and replace dependent objects.
Replace invalid mappings. Use the QUERYOBJECT element to replace invalid mappings.
Rename objects. Use the RESOLUTION attribute of the SPECIFICOBJECT element to rename
objects.
Copy SAP mappings and SAP program Use the COPY_SAP_PROGRAM attribute of the IMPORTPARAMS element to
information. copy SAP mappings and SAP program information.
Apply default connection attributes. Use the APPLY_DEFAULT_CONNECTION attribute of the IMPORTPARAMS
element to apply default connection attributes.
Resolve object conflicts. Use the RESOLVECONFLICT element to resolve object conflicts.
<!-- use the TYPEFILTER element to import only source objects -->
<TYPEFILTER TYPENAME ="SOURCE"/>
<RESOLVECONFLICT>
<LABELOBJECT LABELNAME ="Monthend"
RESOLUTION = "REPLACE"/>
<QUERYOBJECT QUERYNAME ="yr_end_qry"
RESOLUTION ="RENAME"/>
</RESOLVECONFLICT>
</IMPORTPARAMS>
<!-- import objects from SRC_SHARED_F1 to TGT_SHARED_F1, and shortcut objects from
SRC_NONSHARED_F1 to TGT_NONSHARED_F1-->
<FOLDERMAP SOURCEFOLDERNAME="SRC_SHARED_F1" SOURCEREPOSITORYNAME="SRC__REPO1"
TARGETFOLDERNAME="TGT_SHARED_F1" TARGETREPOSITORYNAME="TGT_REPO1"/>
<FOLDERMAP SOURCEFOLDERNAME="SRC_NONSHARED_F1" SOURCEREPOSITORYNAME="SRC_REPO1"
TARGETFOLDERNAME="TGT_NONSHARED_F1" TARGETREPOSITORYNAME="TGT_REPO1"/>
</IMPORTPARAMS>
<!--import the shortcut objects from source folder SRC_SHARED_F1 in source repository
SRC_GDR_REPO1 to source folder SRC_SHARED_F1 in target repository SRC_GDR_REPO2 -->
<!-- import objects from source folders SRC_F1, SRC_F2, and SRC_F3 to target folders
TGT_F1, TGT_F2, and TGT_F3 in repository TGT_REPO1 -->
<FOLDERMAP SOURCEFOLDERNAME="SRC_F1" SOURCEREPOSITORYNAME="SRC_REPO1"
TARGETFOLDERNAME="TGT_F1 TARGETREPOSITORYNAME="TGT_REPO1"/>
<FOLDERMAP SOURCEFOLDERNAME="SRC_F2" SOURCEREPOSITORYNAME="SRC_REPO2"
TARGETFOLDERNAME="TGT_F2" TARGETREPOSITORYNAME="TGT_REPO1"/>
<FOLDERMAP SOURCEFOLDERNAME="SRC_F3" SOURCEREPOSITORYNAME="SRC_REPO3"
TARGETFOLDERNAME="TGT_F3" TARGETREPOSITORYNAME="TGT_REPO1"/>
<RESOLVECONFLICT>
<TYPEOBJECT OBJECTTYPENAME = "SESSIONCONFIG" RESOLUTION="REUSE"/>
</RESOLVECONFLICT>
</IMPORTPARAMS>
</RESOLVECONFLICT>
</IMPORTPARAMS>
Note: When you reuse or replace an object type, the resolution for that object type overrides the resolution for
all object types. The preceding example replaces source definitions and mappings and reuses the remaining
objects. Use the object type “All” to reuse or replace all objects. For more information about object types, see
“Object Import Control File Parameters” on page 1360.
<IMPORTPARAMS CHECKIN_AFTER_IMPORT="YES"
CHECKIN_COMMENTS="PMREP_IMPORT_QUERY_PARENT_REPLACE_CHILD_REUSE"
APPLY_LABEL_NAME="LABEL_QUERY_PARENT_RENAME_CHILD_REUSE">
<FOLDERMAP SOURCEFOLDERNAME="PMREP_CHECKED_OUT" SOURCEREPOSITORYNAME="REPO_EX_1"
TARGETFOLDERNAME="PMREP_CHECKED_OUT" TARGETREPOSITORYNAME="REPO_EX_1"/>
<RESOLVECONFLICT>
Renaming Objects
You can rename specific objects when object conflicts occur. For example, you want to the rename the
objects ADDRESS, ADDRESS1, R_LKP, MAP_MLET, R_S3, WF_RS1. The Repository Service appends the object
names with a number.
<IMPORTPARAMS CHECKIN_AFTER_IMPORT="YES"
CHECKIN_COMMENTS="PMREP_IMPORT_SPECIFICOBJECT_RENAME"
APPLY_LABEL_NAME="LABEL_IMPORT_SPECIFIC_OBJECT_RENAME">
<FOLDERMAP SOURCEFOLDERNAME="SRC_FOLDER1" SOURCEREPOSITORYNAME="REPO_EX_1"
TARGETFOLDERNAME="TGT_FOLDER1" TARGETREPOSITORYNAME="REPO_EX_1"/>
<RESOLVECONFLICT>
<!-- rename the objects ADDRESS, ADDRESS1, R_LKP, MAP_MLET, R_S3, WF_RS1 -->
<!-- enter YES as the value for the COPY_SAP_PROGRAM attribute to copy SAP mappings and
SAP program information -->
<!-- enter YES as the value of the APPLY_DEFAULT_CONNECTION element to apply a default
connection attribute -->
<IMPORTPARAMS CHECKIN_AFTER_IMPORT="NO" APPLY_DEFAULT_CONNECTION="YES">
<FOLDERMAP SOURCEFOLDERNAME="SRC_F1" SOURCEREPOSITORYNAME="REPO_EX_1"
TARGETFOLDERNAME="TGT_F1" TARGETREPOSITORYNAME="REPO_EX_1"/>
<RESOLVECONFLICT>
<SPECIFICOBJECT NAME="R_S3" OBJECTTYPENAME="Session" FOLDERNAME="PMREP_CHECKED_OUT"
REPOSITORYNAME="REPO_EX_1" RESOLUTION="REPLACE"/>
<RESOLVECONFLICT>
</IMPORTPARAMS>
<!-- use the RESOLVECONFLICT element in conjunction with the RESOLUTION attribute of the
OBJECTTYPENAME element to resolve conflicts when you import objects -->
<RESOLVECONFLICT>
<LABELOBJECT LABELNAME="LBL_MPNG_MPLTS_SRCS_TGTS" RESOLUTION="REPLACE"/>
<TYPEOBJECT OBJECTTYPENAME="Lookup Procedure" RESOLUTION="REUSE"/>
<TYPEOBJECT OBJECTTYPENAME="Stored Procedure" RESOLUTION="REUSE"/>
<TYPEOBJECT OBJECTTYPENAME="Expression" RESOLUTION="REUSE"/>
<TYPEOBJECT OBJECTTYPENAME="Filter" RESOLUTION="REUSE"/>
<TYPEOBJECT OBJECTTYPENAME="Aggregator" RESOLUTION="REUSE"/>
<TYPEOBJECT OBJECTTYPENAME="Rank" RESOLUTION="REUSE"/>
<TYPEOBJECT OBJECTTYPENAME="Normalizer" RESOLUTION="REUSE"/>
<TYPEOBJECT OBJECTTYPENAME="Router" RESOLUTION="REUSE"/>
<TYPEOBJECT OBJECTTYPENAME="Sequence" RESOLUTION="REUSE"/>
<TYPEOBJECT OBJECTTYPENAME="Sorter" RESOLUTION="REUSE"/>
<TYPEOBJECT OBJECTTYPENAME="update strategy" RESOLUTION="REUSE"/>
<TYPEOBJECT OBJECTTYPENAME="Custom Transformation" RESOLUTION="REUSE"/>
<TYPEOBJECT OBJECTTYPENAME="Transaction control" RESOLUTION="REUSE"/>
<TYPEOBJECT OBJECTTYPENAME="External Procedure" RESOLUTION="REUSE"/>
<TYPEOBJECT OBJECTTYPENAME="Joiner" RESOLUTION="REUSE"/>
<TYPEOBJECT OBJECTTYPENAME="SessionConfig" RESOLUTION="REUSE"/>
</RESOLVECONFLICT>
</IMPORTPARAMS>
If you create the deployment control file manually, it must conform to the depcntl.dtd file that is installed with
the PowerCenter Client. You include the location of the depcntl.dtd file in the deployment control file.
You can specify a deployment timeout in the deployment control file. The deployment timeout is the period of
time that pmrep waits to acquire object locks in the target repository. By default, pmrep waits indefinitely
until it acquires locks or you cancel the deployment. To cancel a deployment while pmrep is waiting to
acquire locks, press Ctrl+C.
Note: You must create the deployment control file manually to use some deployment parameters such as
DEPLOYTIMEOUT.
<!--folder to replace-->
<!ELEMENT REPLACEFOLDER EMPTY>
<!ATTLIST REPLACEFOLDER
FOLDERNAME CDATA #REQUIRED
RETAINMAPVARPERVALS (YES | NO) "NO"
RETAINWFLOWVARPERVALS (YES | NO) "YES"
RETAINWFLOWSESSLOGS (YES | NO) "NO"
MODIFIEDMANUALLY (YES | NO) "NO"
RETAINORIGFOLDEROWNER (YES | NO) "NO">
Reset the persisted mapping variable values in the target repository. Set COPYMAPVARPERVALS to No.
Copies the mapping variable values from the source repository to the Set the following parameter file options:
target repository. - Set COPYMAPVARPERVALS to Yes.
- Set RETAINMAPVARPERVALS to No.
Retains the existing persisted mapping variable values in the target Set the following parameter file options:
repository. - Set COPYMAPVARPERVALS to Yes.
- Set RETAINMAPVARPERVALS to Yes.
</DEPLOYPARAMS>
For example, if a deployment group contains objects in two folders with shortcuts to a third folder, you can
create a control file with three occurrences of OVERRIDEFOLDER. The following sample control file deploys a
deployment group that contains objects in the folders OBJECTFOLDER1 and OBJECTFOLDER2 that contain
shortcuts pointing to the folder SHAREDSHORTCUT:
<!DOCTYPE DEPLOYPARAMS SYSTEM "depcntl.dtd">
<DEPLOYPARAMS DEFAULTSERVERNAME="dg_sun_71099"
COPYPROGRAMINFO="YES"
COPYMAPVARPERVALS="YES"
COPYWFLOWVARPERVALS="YES"
COPYWFLOWSESSLOGS="NO"
COPYDEPENDENCY="YES"
LATESTVERSIONONLY="YES"
RETAINGENERATEDVAL="YES"
RETAINSERVERNETVALS="YES">
<DEPLOYGROUP CLEARSRCDEPLOYGROUP="NO">
<OVERRIDEFOLDER SOURCEFOLDERNAME="OBJECTFOLDER1"
SOURCEFOLDERTYPE="LOCAL"
TARGETFOLDERNAME="OBJECTFOLDER1"
TARGETFOLDERTYPE="LOCAL"/>
<OVERRIDEFOLDER SOURCEFOLDERNAME="OBJECTFOLDER2"
SOURCEFOLDERTYPE="LOCAL"
TARGETFOLDERNAME="OBJECTFOLDER2"
TARGETFOLDERTYPE="LOCAL"/>
<OVERRIDEFOLDER SOURCEFOLDERNAME="SHAREDSHORTCUTS"
SOURCEFOLDERTYPE="GLOBAL"
TARGETFOLDERNAME="SHAREDSHORTCUTS"
TARGETFOLDERTYPE="GLOBAL"/>
</DEPLOYGROUP>
</DEPLOYPARAMS>
Use the -n option to use the Listtablesbysess command with the Updatesrcprefix or Updatetargprefix
commands in a shell script if the source and target instance names match. Also, use the -n option to update
a source even if the session uses a shortcut to a mapping.
When using the pmrep command ListObjects, enter a character or set of characters that is not
used in repository object names for the column separator, end of record indicator, and end of
listing indicator.
When you enter characters to separate records and columns, and to indicate the end of the listing, use
characters that are not included in repository object names. This helps you use a shell script to parse the
object metadata.
In pmrep, use the -v option when restoring a repository that uses an external directory service for
user management.
When you include the -v option with Restore, you can retain the external directory service registration for the
repository. If you do not enter this option with the valid administrator user name and password, the restored
repository defaults to repository authentication mode and you lose the association between login names and
user names.
1378
Blaze service concurrent workflows
stopping 227 starting from command line 1250
stopping from command line 1255
CondenseLogger (infacmd pwx) 907
C configuring
command line utilities 32
CancelDataObjectCacheRefresh (infacmd dis) 156 Connect (pmcmd)
cancelProfileExecution (infacmd ps) 874 description 1228
cancelWorkflow Connect (pmrep)
infacmd wfs 1088 description 1279
ChangeOwner (pmrep) connect string
description 1276 examples 1266
CheckIn (pmrep) syntax 1266
description 1277 connection
CheckInObject (infacmd mrs) 775 Web Content-Kapow Katalyst 439
CI/CD guidelines connection options
infacmd dis 265 DB2 for infacmd 404
CleanUp (pmrep) SEQ for infacmd 430
description 1278 VSAM for infacmd 437
clearConfigurationProperties (infacmd cluster) 112 connection permissions
ClearDeploymentGroup (pmrep) adding to users or groups 327
description 1278 listing for users or groups 541
CloseForceListener (infacmd pwx) 903 listing using infacmd isp 542
CloseListener (infacmd pwx) 905 connections
cluster creating with infacmd 371
deleting 101 exporting using infacmd isp 495
cluster configuration importing using infacmd isp 525
creating 106, 108 listing options for using infacmd isp 539, 547
deleting 111 listing using infacmd isp 545
editing 126, 128 Oracle 425
exporting 114 removing from domains using infacmd isp 608
group permissions 117 renaming with infacmd 643
listing properties 120 updating using infacmd isp 673
managing properties 112, 130 connectivity
refreshing 124 connect string examples 1266
cluster configurations content
exporting using infacmd isp 495 importing from application files 975
importing using infacmd isp 525 Content Management Service
listing 121 creating in a domain 134
user permissions 122 listing options for 139
clusters listing properties for 138
listing 103 purging orphaned reference data 141
column removing using infacmd cms 142
options for infacmd 1055 synchronizing data with master CMS machine 144
columns updating options for 146
listing properties for 1024 Upgrading 150
command line mode for pmcmd Content Management Service process
connecting 1220 configuring options for 148
command line programs control file
overview 35 deployment 1369
syntax for 37 object import 1358
command line utilities ObjectImport XML example 1363
configuring 32 control files
domains.infa file 33 examples for domain objects 1160
command line utilities (configure Metadata Manager utilities 32 examples for Model repository objects 1161
command line utilities (configure PowerCenter utilities 32 infacmd 1147
commands naming conventions 1148
entering options and arguments for 36 parameters for domain objects 1149, 1153
compareMapping parameters for Model repository objects 1150, 1155
infacmd dis 161 rules and guidelines 1160
comparison operators schema files 1147
folder path 264 ConvertLogFile (infacmd isp) 369
query 263 CPU profile
completeTask calculating using infacmd isp 647
infacmd wfs 1090 Create (pmrep)
compute node description 1280
listing attributes for 967 CreateAuditTables (infacmd cms) 132
setting attributes 970 createConfiguration (infacmd cluster) 106, 108
Index 1379
CreateConnection (infacmd isp) 371 DefineWorkerNode (infasetup)
CreateConnection (pmrep) description 1186
description 1281 delegateTask
CreateContent (infacmd tdm) 1068 infacmd wfs 1094
CreateContents (infacmd mrs) 777 Delete (pmrep)
createdatamaps (infacmd pwx) 909 description 1293
CreateDeploymentGroup (pmrep) DeleteAuditTables (infacmd cms) 136
description 1284 deleteClusters (infacmd ccps) 101
CreateExceptionAuditTables (infacmd as) 62 deleteConfiguration (infacmd cluster) 111
CreateFolder (infacmd isp) 440 DeleteConnection (pmrep)
CreateFolder (pmrep) description 1294
description 1285 DeleteContents (infacmd mrs) 785
CreateGrid (infacmd isp) 441 DeleteDeploymentGroup (pmrep)
CreateGroup (infacmd isp) 443 description 1295
CreateGroup (pmrep) DeleteDomain (infasetup)
description 1287 description 1190
CreateIntegrationService (infacmd isp) 444 DeleteExceptionAuditTables (infacmd as) 68
CreateLabel (pmrep) DeleteFolder (infacmd mrs) 786
description 1287 DeleteFolder (pmrep)
CreateListenerService (infacmd pwx) 912 description 1295
CreateLoggerService (infacmd pwx) 914 DeleteLabel (pmrep)
CreateMMService (infacmd isp) 454 description 1295
CreateOSProfile (infacmd isp) 457 deleteMappignPersistedOutputs
CreateProject (infacmd mrs) 779, 780 infacmd ms 843
CreateRepositoryService (infacmd isp) 462 DeleteNamespace (infacmd isp) 478
CreateRole (infacmd isp) 467 DeleteObject (pmrep)
CreateSAPBWService (infacmd isp) 468 description 1296
CreateSchedule (infacmd sch) 982 DeleteParameterSetEntries (infacmd dis) 164, 190
CreateService (infacmd as) 64 DeleteProject (infacmd mrs) 788
CreateService (infacmd cms) 134 DeleteSchedule (infacmd sch) 990
CreateService (infacmd dis) 158 depcntl.dtd
CreateService (infacmd edp) 285 listing 1369
CreateService (infacmd idp) 275 deploy
CreateService (infacmd mas) 744 patch 1081
CreateService (infacmd mi) 758 DeployApplication (infacmd dis) 170
CreateService (infacmd mrs) 782 DeployDeploymentGroup (pmrep)
CreateService (infacmd search) 1013 description 1297
CreateService (infacmd tdm) 1062 deployed applications
CreateUser (infacmd isp) 472 backing up 155
CreateWH (infacmd ps) 876 listing 183
CreateWSHubService (infacmd isp) 474 DeployFolder (pmrep)
description 1299
DeployImport (infacmd rtm) 975
D deploying objects
depcntl.dtd 1369
Data Integration Service deployment control file
configuring compute properties 241 description 1369
configuring properties for 247 deployment groups
creating 158 listing multiple folders 1376
listing 187 deployObjects
listing compute properties 184 infacmd tools 1072
listing properties for 199 deployObjectsToFile
Data Integration Service options infacmd dis 166
infacmd syntax 249 deploySpec (infacmd mi) 761
Data Integration Service process description 601
configuring properties for 259 detectOrphanResults (infacmd ps) 877
listing properties for 196, 201 DisableNodeResource (infacmd isp) 479
data object cache DisableService (infacmd isp) 481
refreshing 209 DisableService (infacmd tdm) 1070
data objects DisableServiceProcess (infacmd isp) 483
configuring properties for 243 DisableUser (infacmd isp) 484
listing properties for 186 Disconnect (pmcmd)
DB2 description 1229
infacmd connection options 404 DisplayAllLogger (infacmd pwx) 919
DefineDomain (infasetup) DisplayCPULogger (infacmd pwx) 921
description 1168 DisplayEventsLogger (infacmd pwx) 924
DefineGatewayNode (infasetup) DisplayMemoryLogger (infacmd pwx) 926
description 1178 DisplayRecordsLogger (infacmd pwx) 928
1380 Index
displayStatsListener (infacmd pwx) 931 export control files (continued)
DisplayStatusLogger (infacmd pwx) 934 examples for Model repository objects 1161
domain gateway hosts infacmd 1147
pinging 598 naming conventions 1148
domain monitoring parameters for domain objects 1149
list options 568 parameters for Model repository objects 1150
update options 693 rules and guidelines 1160
domains schema files 1147
backing up using infasetup 1166 exportConfiguration (infacmd cluster) 114
creating using infasetup 1168 exportControl.xsd
deleting using infasetup 1190 infacmd control files 1147
listing linked domains using infacmd isp 554 ExportDomainObjects (infacmd isp)
listing properties using infacmd isp 555 description 495
pinging 598 exportGlossary (infacmd bg) 92
removing links using infacmd isp 612 exportObjects
restoring using infasetup 1195 infacmd tools 1073
updating properties using infacmd isp 679 exportResources
updating using infasetup 1202 infacmd tools 1076
dropTables (infacmd wfs) 1096 exportSpec
DropWH (infacmd ps) 879 infacmd mi 762
DTD file ExportToPC (infacmd ipc) 316
plug-in template 1334 ExportUsersAndGroups (infacmd isp) 497
external security modules
registering 1334
E unregistering 1343
Index 1381
GetMappingStatus ICMD_JAVA_OPTS
infacmd ms 847 configuring 43
GetNodeName (infacmd isp) 506 identify provider URL
GetPasswordComplexityConfig (infacmd) 507 getting 508
getPrivilegeAssociation (infacmd aud) 78 setting 1212
getProfileExecutionStatus (infacmd ps) 886 impcntl.dtd
GetRequestLog description 1358
infacmd ms 849 Import (infacmd rtm) 979
getrunningsessionsdetails (pmcmd) import control files
description 1230 examples for domain objects 1160
getSamlConfig (infacmd) examples for Model repository objects 1161
description 508 infacmd 1147
GetServiceDetails (pmcmd) naming conventions 1148
description 1231 parameters for domain objects 1153
GetServiceOption (infacmd isp) 509 parameters for Model repository objects 1155
GetServiceProcessOption (infacmd isp) 511 rules and guidelines 1160
GetServiceProcessStatus (infacmd isp) 513 schema files 1147
getserviceproperties (pmcmd) import from PowerCenter
description 1233 options 319
GetServiceStatus (infacmd isp) 514 importControl.xsd
GetSessionLog (infacmd isp) 516 infacmd control files 1147
GetSessionStatistics (pmcmd) ImportDomainObjects (infacmd isp)
description 1234 description 525
getSpecRunStats importGlossary (infacmd bg) 96
infacmd mi 765 importing objects
GetSystemLogDirectory (infacmd isp) 519 impcntl.dtd 1358
gettaskdetails (pmcmd) ObjectImport XML example 1363
description 1236 importObjects
getUserGroupAssociation (infacmd aud) 80, 82 infacmd tools 1077
getUsersPersonalInfo (infacmd aud) 84 ImportUsersAndGroups (infacmd isp)
getworkflowdetails (pmcmd) description 529
description 1238 INFA_CLIENT_RESILIENCE_TIMEOUT
GetWorkflowLog (infacmd isp) 522 configuring 44
grids INFA_CODEPAGENAME
creating 441 configuring 45
listing nodes using infacmd isp 558 INFA_DEFAULT_DATABASE_PASSWORD
removing using infacmd isp 615 configuring 45
updating assigned nodes using infacmd isp 683 INFA_DEFAULT_DB_TRUSTSTORE_PASSWORD
group permissions configuring 46
assigning to objects 357 INFA_DEFAULT_DOMAIN
listing for domain objects 560 configuring 47
removing on objects 618 INFA_DEFAULT_DOMAIN_PASSWORD
groups configuring 48
creating in domains 443 INFA_DEFAULT_DOMAIN_USER
exporting 497 configuring 49
exporting using infacmd isp 495 INFA_DEFAULT_PWX_OSEPASSWORD
importing using infacmd isp 525, 529 configuring 49
listing for a user 563 INFA_DEFAULT_PWX_OSPASSWORD
listing using infacmd isp 534 configuring 50
removing using infacmd isp 616 INFA_JAVA_CMD_OPTS
configuring 51
INFA_NODE_KEYSTORE_PASSWORD
H configuring 53
INFA_NODE_TRUSTSTORE_PASSWORD
HBase connections for MapR-DB configuring 54
infacmd properties 414 INFA_PASSWORD
Help (infacmd) 525 configuring 52
help (pmcmd) INFA_REPCNX_INFO
description 1241 configuring 54
Help (pmrep) INFA_REPOSITORY_PASSWORD
description 1306 configuring 55
Human task instances 1090 infacmd
checking the status of password complexity 507
control files 1147
1382 Index
infacmd (continued) infacmd dis (continued)
listing plugin identifiers for 60 configuring compute properties 241
lists the users with weak password 592 configuring data object properties 243
nodes, switching from worker to gateway 655 configuring properties for Data Integration Service 247
return codes 61 configuring properties for Data Integration Service process 259
running commands 60 creating Data Integration Service 158
SAP BW Service options 471 data object options 245
SAP BW service process options 471 deleting parameter set entries 164, 190
security domains, listing 579 deploying application archive (iar) files 170
service process options 452 deployObjectsToFile 166
version information, displaying 718 list mappings
Web Services Hub service options 477 on the Data Integration Service 187
infacmd advanced on the DIS 187
validating features 717 list parameter sets in an application 193
infacmd as list the objects in a parameter set 191
configuring properties for Analyst Service process 74 listing application object permissions for users or groups 176
creating Analyst Service in a domain 64 listing application permissions 181
creating exception audit tables 62 listing compute properties 184
deleting exception audit tables 68 listing deployed applications 183
listing configuration for Analyst Service 69 listing objects for applications 178
listing properties for Analyst Service process 71 listing properties for applications 180
updating properties for Analyst Service 72 listing properties for Data Integration Service 199
infacmd autotune listing properties for sequence objects 196
Autotune 87 listing properties of Data Integration Service process 201
infacmd bg listing properties of data objects 186
Exporting business glossaries from the Analyst tool 92 listPatchNames 194
Importing business glossaries from .xlsx or .zip files to the Analyst lists sequence objects 198
tool 96 purging cache for logical data objects 202
list business glossaries in Analyst 91 purging result set cache 204
Upgrading Business Glossary data in the Model repository 90 query 262
infacmd ccps queryDesignTimeObjects 207
delete clusters 101 queryRunTimeObjects 206
listing clusters 103 refreshing data object cache 209
update ADLS Service Principal Certificate 104 removing applications 237
infacmd cluster renaming deployed applications 210
clearing configuration properties 112 replaceAllTag 234
creating a cluster configuration 106, 108 restoring applications from backup files 214
deleting configuration objects 111 setting application object permissions 218
editing cluster configuration permissions 126 setting application permissions 216
editing cluster configuration properties 128 setting mapping permissions 218
exporting a cluster configuration 114 setting workflow permissions 218
group permissions for a cluster configuration 117 starting applications 224
listing cluster configuration properties 120 stopping applications 226
listing cluster configurations 121 stopping Blaze Service 227
listing Hadoop distribution configuration files 115, 118 stopping refresh of logical data object cache 156
refreshing cluster configuration information 124 tag 230
updating configuration properties 130 untag 232
user permissions for a cluster configuration 122 updating applications 238
infacmd cms updating current value for sequence data object 222
configuring options for Content Management Service process 148 updating parameter set entries 245
creating audit trail tables 132 infacmd edp
creating Content Management Service in a domain 134 creating Enterprise Data Preparation Service 285
deleting audit trail tables 136 purging Enterprise Data Preparation audit events 289
listing options for Content Management Service 138 updating Enterprise Data Preparation Service 291
listing options for Content Management Service process 139 upgrading Enterprise Data Preparation Service 295
purging orphaned reference data 141 infacmd idp
removing Content Management Service from a domain 142 creating Interactive Data Preparation Service 275
synchronizing data 144 updating Interactive Data Preparation Service 279
updating options for Content Management Service 146 infacmd ipc
upgrading the service 150 exporting objects from Model repository 316
infacmd commands reporting object reuse 321
getting help for 525 infacmd isp
infacmd dis adding a domain link 332
adding parameter set entries 153 adding licenses to domains 340
backing up deployed application 155 adding nodes to a domain 333
CI/CD guidelines 265 adding resources to nodes 344
compareMapping 161 adding service levels 348
configuring application properties 239 adding users to groups in a domain 351
Index 1383
infacmd isp (continued) infacmd isp (continued)
alerts, configuring SMTP settings 714 getting status of an application service 514
alerts, listing subscribed users 531 getting status of application service process on a node 513
alerts, unsubscribing from 606 getting system log directory path 519
assigning connection permissions to users or groups 327 grids, listing nodes 558
assigning default operating system profile 353 grids, removing 615
assigning group permissions on objects 357 grids, updating assigned nodes 683
assigning Integration Service 358 groups, listing 534
assigning licenses to application service 360 groups, listing privileges for 562
assigning privileges to groups 335 groups, removing 616
assigning privileges to roles in groups 346 groups, removing privileges from 620
assigning privileges to users 349 import control files 1153
assigning role to groups for domains or application services 362 Integration Services, updating 684
assigning roles to users 364 LDAP authentication, setting up 329, 337, 676, 687
assigning user permissions on objects 367 LDAP connection, listing 533, 535, 549, 565, 611, 622
associating a repository with Web Services Hub 365 LDAP server configuration, listing 576
cluster configurations, exporting 495 LDAP server configuration, updating 650
cluster configurations, importing 525 licenses, displaying information 653
connection permissions, listing by group 542 licenses, listing 567
connections, exporting 495 licenses, removing 623
connections, importing 525 licenses, updating 690
connections, listing 545 listing default operating system profiles 550
connections, listing options for 539, 547 listing domain objects for group 560
connections, removing from domains 608 listing domain objects for users 589
connections, updating properties 673 listing folder properties 499
converting binary log files 369 listing groups for a user 563
CPU profile, calculating 647 listing node role 572
creating connection 371 listing permissions for users or groups for a connection 541
creating folders 440 listing services assigned to a license 355
creating grids 441 listing SMTP settings for outgoing mail server 587
creating groups in domains 443 listing users with permissions for a connection 544
creating Integration Service in a domain 444 log events, purging 603
creating Metadata Manager Service in a domain 454 Metadata Manager Service properties, updating 691
creating operating system profiles in a domain 457 migrating users 593
creating Repository Service in a domain 462 nodes, disassociating from domains 671
creating roles in a domain 467 nodes, listing 574, 582
creating SAP BW Service in a domain 468 nodes, listing options 569
creating users in a domain 472 nodes, removing 625
creating Web Services Hub in a domain 474 nodes, shutting down 654
disabling application services 481 nodes, switching from gateway to worker 658
disabling PowerCenter resources 479 nodes, updating 698
disabling services processes on a node 483 operating system profile, listing 575
disabling user accounts 484 operating system profile, removing 628
displaying cipher suite configuration lists 552 operating system profile, updating 702
domains, listing linked domains 554 passwords, resetting user passwords 645
domains, listing properties 555 permissions, removing from user or group connections 609
domains, removing links 612 ping domain 599
domains, updating properties 679 pinging objects 598
editing user account properties 486 removing default operating system profile 661
enabling applications services 490 removing group permissions on objects 618
enabling resources 488 removing permissions for users and groups 648
enabling service processes on a node 492 removing user permissions on objects 639
enabling user accounts 493 rename connection 643
export control files 1148 Repository Services, updating 704
exporting users and groups to a file 497 resources, listing for nodes 571
folders, listing 557 resources, removing from nodes 626
folders, moving 595 roles, exporting 495
folders, moving objects between 597 roles, importing 525
folders, removing 614 roles, listing 537
folders, updating description 680 roles, listing privileges for 578
gateway information, updating 682 roles, removing 629
getting Integration Service process property 511 roles, removing from a group 666
getting log events for sessions 516 roles, removing from user 668
getting log events for workflows 522 roles, removing privileges from 631
getting node names 506 SAP BW Services, updating 708
getting recent error messages 501 service levels, listing 581
getting service properties 509 service levels, removing 634
getting specified log events 503 service levels, updating 710
1384 Index
infacmd isp (continued) infacmd mrs (continued)
service processes, updating 712 Updating statistics for the Model Repository Service 835
services, listing 585 upgrading the contents of the Model Repository Service 837
services, listing privileges for 583 infacmd ms
services, removing 633 aborting Data Integration Service jobs 841
subscribing users to notifications 325 deleting persisted mapping outputs 843
synchronizing users and groups in security domain with LDAP users fetch aggregated cluster logs 845
and groups 659 getting the mapping status 847
updating node role 700 listing mappings in an application 856
users and groups, exporting 495 lists mapping options in an application 851
users and groups, importing 525, 529 purging rows from the database job table 858
users, listing 538 running a mapping deployed to Data Integration Service 860
users, listing privileges for 591 updating default optimization level in an application or mapping 866
users, removing 636 updating mapping options in an application 864
users, removing from a group 637 updating optimization level in an application or mapping 868
users, removing privileges from 641 upgrading mapping parameter file 870
Web Services Hub, disassociating a repository 669 writing the mapping log 849
Web Services Hub, updating 715 infacmd oie
infacmd isp list domain monitoring options 568 export control files 1148
infacmd isp update domain monitoring options 693 import control files 1153
infacmd mas infacmd ps
configuring properties for Metadata Access Service 751 creating data profiling warehouse 876
configuring properties for Metadata Access Service process 753 gcenceling profile model 874
creating Metadata Access Service 744 getting profile model status 886
listing properties for Metadata Access Service 748 getting profile task status 884
listing properties of Metadata Access Service process 749 listing profile and scorecard results 887
infacmd mi migrating keys 899
aborting a mass ingestion specification 757 migrating profile results 890
creating Mass Ingestion Service 758 migrating scorecard results 892
deploying mass ingestion specification 761 purging profile and scorecard results 893
deploying spec 762 removing profiling warehouse contents 879
extendedRunStats 764 running a profile model 882
getting the spec stats 765 running profile and scorecard results 880
listing mi specs 767 infacmd pwx
listSpecRuns 766 creating data maps 909
restarting jobs 768 creating Listener Service 912
running mi spec 769 creating Logger Service 914
infacmd mrs displaying all Logger Service messages 919
backing up the Model repository contents to a file 773 displaying counts of change records processed by Logger Service
checking in objects 775 928
creating a project 779, 780 displaying CPU information for Logger Service 921
creating repository content for a Model Repository Service 777 displaying events for Logger Service 924
creating the Model Repository Service 782 displaying information for active Listener Service tasks 939
deleting a folder 786 displaying memory use for Logger Service 926
deleting a project 788 displaying monitoring statistics for the Listener Service and its
deleting the Model repository contents 785 tasks 931
list mappings for the Model Repository Service 800 displaying status of Writer subtask for Logger Service 934
listing checked out objects 795 forcing Listener Service to stop 903
Listing files in the backup folder 793 starting logging cycle for Logger Service 907
Listing folders in the Model Repository Service repository 796 stopping Listener Service 905
listing locked objects 798 stopping Listener Service tasks 944
Listing options for the Model Repository Service 805 stopping Logger Service 941
Listing permissions on multiple projects 802 switching to new set of Logger Service log files 937
Listing projects in the Model Repository Service repository 804 updating Listener Service properties 948
listing service process options for the Model Repository Service 807 updating Logger Service properties 951
managing group permissions on project 808 upgrading nonrelational data objects 946
managing user permissions on project 810 infacmd rms
populating version control system 812 configuring properties for Resource Manager Service 972
reassigning checked-out object 814 listing compute node attributes 967
reassigning locked object 814 listing properties for Resource Manager Service 969
rebuilding object dependency graph 815 setting compute node attributes 970
renaming a folder 817 infacmd roh
restoring contents of Model repository 820 listProcessProperties 957
reverting checked-out objects 822, 825 listServiceProcessOptions 960
unlocking object 826 infacmd rtm
Updating options for the Model Repository Service 828 exporting reference tables 977
Updating service process options for the Model Repository Service importing content from application files 975
833 importing reference tables to Model repositories 979
Index 1385
infacmd sch infacmd ws (continued)
creating a schedule 982 ListWebServiceOptions 1125
deleting a schedule 990 ListWebServicePermissions 1126
updating a schedule 1002 ListWebServices 1128
infacmd search RenameWebService 1129
configuring properties for Search Service 1018 SetOperationPermissions 1131
configuring properties for Search Service process 1020 SetWebServicePermissions 1133
creating Search Service 1013 StartWebService 1136
listing properties for Search Service 1016 StopWebService 1138
listing properties of Search Service process 1017 update properties for a web service 1141
infacmd sql update properties for a web service operation 1139
column options 1055 UpdateOperationOptions 1139
configuring properties for virtual tables 1059 UpdateWebServiceOptions 1141
listing permissions for SQL data service 1029 infacmd xrf
listing permissions for stored procedures 1032 generating readable XML 1145
listing permissions for virtual columns 1026 updating export XML 1146
listing permissions for virtual tables 1035 infasetup
listing properties for columns in virtual tables 1024 displaying the cipher suite lists 1194
listing properties for SQL data service 1027 domains, backing up 1166
listing properties for virtual tables 1033 domains, defining 1168
listing SQL data services for a Data Integration Service 1030 domains, deleting 1190
purging virtual table cache 1037 domains, restoring 1195
refreshing virtual table cache 1038 domains, updating 1202
renaming SQL data service 1040 enable or disable password complexity 1211
setting group and user permissions on virtual tables 1048 gateway nodes, defining 1178
setting permissions for SQL data service 1043 gateway nodes, updating 1203
setting permissions on virtual table columns 1041 return codes 1165
setting user and group permissions for stored procedures 1045 run 1165
SQL data service options 1057 updating cipher suites 1200
starting SQL data service 1050 worker nodes, defining 1186
stopping SQL data service 1052 worker nodes, updating 1214
updating SQL data service options 1056 INFATOOL_DATEFORMAT
virtual table options 1061 configuring 56
infacmd sqlupdate virtual column options 1053 Informatica utilities (installing 31
infacmd tdm Informatica utilities (security configuration 33
creating Test Data Manager Service Content in a domain 1068 InstallAbapProgram (pmrep)
creating Test Data Manager Service in a domain 1062 description 1306
disabling the Test Data Manager Service 1070 Integration Service
enabling the Test Data Manager Service 1069 assigning to Metadata Manager Service 358
infacmd tools creating 444
deploying objects 1072 removing using infacmd isp 633
exporting objects 1073 updating using infacmd isp 684
exporting resources to Metadata Manager 1076 Integration Service process
importing objects 1077 getting properties for 511
patchApplication 1081 updating options for 712
infacmd wfs Interactive Data Preparation Service
aborting a workflow instance 1084 creating 275
canceling a workflow instance 1088 updating 279
completing a Human task instance 1090 interactive mode for pmcmd
delegating a Human task instance 1094 connecting 1222
delete process data from the workflow database 1107 setting defaults 1222
dropping database tables 1096
listing active workflow instances 1097
listing Human task instances 1100
listing persisted mapping outputs 1099
J
listing workflow parameters 1104 jobs
listing workflows in an application 1106 aborting 841
recovering a workflow instance 1109 purging 858
releasing a Human task instance 1111
starting a Human task in a workflow 1115
starting a workflow instance 1116
updating persisted mapping outputs 1113
K
infacmd ws KillUserConnection (pmrep)
listing permissions for a web service 1126 description 1308
listing permissions for a web service operation 1123
listing properties for a web service operation 1121
ListOperationOptions 1121
ListOperationPermissions 1123
1386 Index
L listCustomLDAPType (infacmd isp)
description 549
labels ListDataObjectOptions (infacmd dis) 186
creating using pmrep 1287 ListDefaultOSProfiles (infacmd isp) 550
deleting 1295 ListDomainLinks (infacmd isp)
LDAP authentication description 554
setting up using infacmd isp 329, 337, 676, 687 ListDomainOptions (infacmd isp)
LDAP connection description 555
listing using infacmd isp 533, 535, 549, 565, 611, 622 ListFolders (infacmd isp)
LDAP server configuration description 557
listing using infacmd isp 576 ListFOlders (infacmd mrs) 796
updating using infacmd isp 650 listGlossary (infacmd bg) 91
licenses ListGridNodes (infacmd isp)
adding to domains 340 description 558
displaying using infacmd isp 653 ListGroupPermissions (infacmd isp) 560
listing services assigned to 355 ListGroupPrivileges (infacmd isp)
listing using infacmd isp 567 description 562
removing using infacmd isp 623 ListGroupsForUser (infacmd isp) 563
unassigning using infacmd 664 ListLicenses (infacmd isp)
updating using infacmd isp 690 description 567
links ListLockedObjects (infacmd mrs) 798
adding to domains 332 listMappingEngines (infacmd dis) 187
List (infacmd ps) 887 listMappingEngines (infacmd mrs) 800
listActiveWorkflowInstances listMappingOptions (infacmd ms) 851
infacmd wfs 1097 listMappingPersistedOutputs
ListAlertUsers (infacmd isp) infacmd wfs 1099
description 531 ListMappings (infacmd ms) 856
listAllCustomLDAPTypes (infacmd isp) listMonitoringOptions (infacmd isp) 568
description 533 ListNodeOptions (infacmd isp)
ListAllGroups (infacmd isp) description 569
description 534 ListNodeResources (infacmd isp)
listAllLDAPConnectivity (infacmd isp) description 571
description 535 ListNodeRoles (infacmd isp) 572
ListAllProfiles (infacmd ps) 889 ListNodes (infacmd isp)
ListAllRoles (infacmd isp) description 574
description 537 ListObjectDependencies (pmrep)
ListAllUsers (infacmd isp) description 1309
description 538 ListObjects (pmrep)
ListAllUsers (pmrep) description 1312
description 1309 listing folders 1316
ListApplicationObjectPermissions (infacmd dis) 176 transformation types 1314
ListApplicationObjects (infacmd dis) 178 ListOperationOptions
ListApplicationOptions (infacmd dis) 180 infacmd ws 1121
ListApplicationPermissions (infacmd dis) 181 ListOSProfiles (infacmd isp)
ListApplications (infacmd dis) 183 description 575
listAssociatedConnections (infacmd cluster) 115 ListParameterSetObjects (infacmd dis) 191
ListBackupFiles (infacmd mrs) 793 ListParameterSets (infacmd dis) 193
ListCheckedOutObjects (infacmd mrs) 795 listPatchNames
listClusters (infacmd ccps) 103 infacmd dis 194
ListColumnOptions (infacmd sql) 1024 listPermissionOnProject (infacmd mrs) 802
ListComputeNodeAttributes (infacmd rms) 967 ListPlugins (infacmd) 60
ListComputeOptions (infacmd dis) 184, 241 listProcessProperties
listConfigurationGroupPermissions (infacmd cluster) 117 infacmd roh 957
listConfigurationProperties (infacmd cluster) 120 ListProjects (infacmd mrs) 804
listConfigurations (infacmd cluster) 121 ListRepositoryLDAPConfiguration (infacmd isp)
listConfigurationSets (infacmd cluster) 118 description 576
listConfigurationUserPermissions (infacmd cluster) 122 ListRolePrivileges (infacmd isp)
ListConnectionOptions (infacmd isp) description 578
description 539, 547 ListSchedule (infacmd sch) 992
ListConnectionPermissionByUser (infacmd isp) 544 ListSecurityDomains (infacmd)
ListConnectionPermissions (infacmd isp) 541 description 579
ListConnectionPermissionsByGroup (infacmd isp) ListSequenceObjectProperties (infacmd dis) 196
description 542 ListSequenceObjects (infacmd dis) 198
ListConnections (infacmd isp) ListServiceLevels (infacmd isp)
description 545 description 581
ListConnections (pmrep) ListServiceNodes (infacmd isp)
description 1309 description 582
ListServiceOptions (infacmd as) 69
Index 1387
ListServiceOptions (infacmd cms) 138 ManageUserPermissionOnProject (infacmd mrs) 810
ListServiceOptions (infacmd dis) 199 mapping
ListServiceOptions (infacmd mas) 748 setting permissions for 218
ListServiceOptions (infacmd mrs) 805 mapping log
ListServiceOptions (infacmd rms) 969 accessing with infacmd ms 849
ListServiceOptions (infacmd sch) 994 mapping options
ListServiceOptions (infacmd search) 1016 updating 864
ListServicePrivileges (infacmd isp) mapping outputs
description 583 updating with infacmd 1113
listServiceProcessOptions mapping status
infacmd roh 960 accessing with infacmd ms 847
ListServiceProcessOptions (infacmd as) 71 mappings
ListServiceProcessOptions (infacmd cms) 139 listing 851, 856
ListServiceProcessOptions (infacmd dis) 201 mappings deployed to Data Integration Service
ListServiceProcessOptions (infacmd mas) 749 running 860
ListServiceProcessOptions (infacmd mrs) 807 mass ingestion
ListServiceProcessOptions (infacmd sch) 995 run statistics 764
ListServiceProcessOptions (infacmd search) 1017 Mass Ingestion Service
ListServices (infacmd isp) creating 758
description 585 mass ingestion specification
ListSMTPOptions (infacmd isp) 587 aborting 757
listSpecs (infacmd mi) 767 MassUpdate (pmrep)
ListSQLDataServiceOptions (infacmd sql) 1027 description 1318
ListSQLDataServicePermissions (infacmd sql) 1029 Metadata Access Service
ListSQLDataServices (infacmd sql) 1030 configuring properties for 751
ListStoredProcedurePermissions (infacmd sql) 1032 creating 744
ListTableOptions (infacmd sql) 1033 listing properties for 748
ListTablePermissions (infacmd sql) 1026, 1035 Metadata Access Service options
ListTablesBySess (pmrep) infacmd syntax 752
description 1317 Metadata Access Service process
ListTaskListener (infacmd pwx) 939 configuring properties for 753
listTasks listing properties for 749
infacmd wfs 1100 Metadata Manager Service
ListtLDAPConnectivity (infacmd isp) creating in a domain 454
description 565 updating properties for 691
ListUserConnections (pmrep) Metadata Manager utilities
description 1318 configuring 32
ListUserPermissions (infacmd isp) 589 installing 31
ListUserPrivileges (infacmd isp) security configuration 33
description 591 Microsoft Azure Blob Storage Connection
ListWeakPasswordUsers (infacmd) 592 infacmd properties 415
ListWebServiceOptions Microsoft Azure Data Lake Storage Gen1 Connection
infacmd ws 1125 infacmd properties 416
ListWebServicePermissions Microsoft Azure Data Lake Storage Gen2 Connection
infacmd ws 1126 infacmd properties 416
ListWebServices Microsoft Azure SQL Data Warehouse Connection
infacmd ws 1128 infacmd properties 417
listWorkflowParameters Microsoft SQL Server
infacmd wfs 1104 connect string syntax 1266
listWorkflows MigrateEncryptionKey (infasetup)
infacmd wfs 1106 description 1194
local parameter files migrateProfileResults (infacmd ps) 890
using with pmcmd StartWorkflow 1252 migrateScorecards (infacmd ps) 892
log events migrateUsers
purging using infacmd isp 603 infacmd isp 593
truncating using pmrep 1339 mixed-version domain
logical data object cache running pmcmd 1220
stopping refresh for 156 running pmrep 1265
logical data objects Model repository
options for infacmd 245 backing up contents to a file 773
purging the cache for 202 checking objects in 775
logical operators deleting contents of 785
query 265 listing checked out objects in 795
Listing files in the backup folder 793
Listing folders in the Model Repository Service repository 796
1388 Index
Model repository (continued) objects (continued)
Lists options for the Model Repository Service 805 importing 1328
reassigning checked-out object in 814 importing from object export file 1077
reassigning locked object in 814 removing user permissions on 639
rebuilding object dependency graph 815 Olson Time Zone
restoring contents of 820 valid values 986
reverting checked-out objects in 822, 825 operating system profile
unlicking object in 826 assigning default profile to a user or group 353
Updates options for the Model Repository Service 828 listing default profiles 550
Updates service process options for the Model Repository Service listing using infacmd isp 575
833 removing default profile from a user or group 661
Updates statistics for the Model Repository Service 835 removing using infacmd isp 628
upgrading the contents of the Model Repository Service 837 updating using infacmd isp 702
Model repository objects operating system profiles
exporting 316 creating in a domain 457
reporting object reuse 321 optimization level
Model Repository Service updating 866, 868
creating 782 Oracle
creating repository content for 777 connect string syntax 1266
listing 800, 807 connection options for 425
ModifyFolder (pmrep) OVERRIDEFOLDER
description 1324 sample control file 1376
MoveFolder (infacmd isp)
description 595
MoveObject (infacmd isp)
description 597
P
parameter files
using with pmcmd StartTask 1249
Index 1389
pmcmd (continued) pmrep (continued)
script files 1223 objects, listing 1312
service settings, getting 1247 objects, validating 1352
session statistics, getting 1234 overview 1265
sessions, getting details about 1230 permission, assigning 1274
tasks, aborting 1224 persistent input files, creating 1357
tasks, completing before returning the prompt 1259 plug-ins, registering 1333
tasks, getting details about 1231, 1236 plug-ins, unregistering 1342
tasks, starting 1247 PowerCenter Integration Service, assigning 1273
tasks, stopping 1253 privileges, removing 1336
version, displaying 1259 queries, executing 1300
wait mode, setting 1246 repositories, backing up 1276
workflows, aborting 1226 repositories, connecting to 1279
workflows, determining if running 1261 repositories, creating 1280
workflows, getting details about 1231, 1238 repositories, deleting 1293
workflows, recovering 1242 repositories, registering 1331
workflows, removing from a schedule 1257 repositories, restoring 1335
workflows, scheduling 1244 repositories, unregistering 1341
workflows, starting 1250 repository connection file, specifying 54
workflows, stopping 1255 repository statistics, updating 1349
pmpasswd resources, cleaning up 1278
encrypting passwords 57 running in a mixed-version domain 1265
syntax 57 script files 1266
pmrep scripts, running 1337
checked-out objects, listing 1302 sequence values, updating 1347
checkouts, undoing 1340 table owner names, updating 1348
command line mode 1265 tables, listing by session 1317
connection details, listing 1303 target table name prefixes, updating 1349
connection information, showing 1338 uninstall ABAP program 1351
connection name, changing 1338 user connections, listing 1318
connections, creating 1281 user connections, terminating 1308
connections, deleting 1294 user properties, editing 1300
connections, listing 1309 users, listing 1309
connections, updating 1344 version information, displaying 1355
deployment control file parameters 1371 PopulateVCS (infacmd mrs) 812
deployment groups, adding objects to 1270 post-session email
deployment groups, clearing objects from 1278 updating addresses with pmrep 1346
deployment groups, creating 1284 PowerCenter IntegrationService
deployment groups, deleting 1295 assigning using pmrep 1273
deployment groups, deploying 1297 PowerCenter resources
deployment, rolling back 1336 disabling 479
email addresses, updating 1346 enabling 488
folder properties, modifying 1324 PowerCenter utilities
folders, creating 1285 configuring 32
folders, deleting 1295 installing 31
folders, deploying 1299 security configuration 33
folders, listing 1316 PowerExchange Listener Service
folders, modifying properties 1324 creating 912
generating ABAP program 1304 displaying monitoring statistics for the Listener Service and its
groups, creating 1287 tasks 931
help 1306 forcing to stop 903
installing ABAP program 1306 listing tasks 939
interactive mode 1265 stopping 905
interactive mode, exiting 1302 stopping tasks 944
interactive mode, exiting from 1302 updating properties 948
labels, applying 1271 PowerExchange Logger Service
labels, creating 1287 creating 914
labels, deleting 1295 displaying all messages 919
logs, deleting 1339 displaying counts of change records processed 928
notification messages, sending 1326 displaying CPU information 921
object dependencies, listing 1309 displaying events 924
object import control parameters 1360 displaying memory use 926
object versions, purging 1329 displaying status of Writer subtask 934
objects, changing ownership 1276 shutting down 941
objects, checking in 1277 starting logging cycle 907
objects, deleting 1296 switching to new set of log files 937
objects, exporting 1326 updating properties 951
objects, importing 1328 PrintSPNAndKeytabNames (infacmd isp) 601
1390 Index
privileges recoverWorkflow
assigning to groups in a domain 335 infacmd wfs 1109
assigning to roles 346 recoverworkflow (pmcmd)
listing for a group using infacmd isp 562 description 1242
listing for a role using infacmd isp 578 reference tables
listing for a user 591 exporting 977
listing for services using infacmd isp 583 importing to Model repositories 979
removing 1336 refreshConfiguration (infacmd cluster) 124
removing from a group using infacmd isp 620 RefreshDataObjectCache (infacmd dis) 209
removing from a role using infacmd isp 631 RefreshTableCache (infacmd sql) 1038
removing from a user using infacmd isp 641 Register (pmrep)
profile model description 1331
canceling 874 registering
executing 882 plug-in using pmrep 1333
getting status 886 security module using pmrep 1334
profile tasks RegisterPlugin (pmrep)
getting status 884, 899 description 1333
profiles releaseTask
detecting results for 877 infacmd wfs 1111
detecting tables for 896 RemoveAlertUser (infacmd isp)
executing 880 description 606
listing results for 887 RemoveConnection (infacmd isp)
purging results for 893 description 608
profiling warehouse contents RemoveConnectionPermissions (infacmd isp)
removing 879 description 609
pruneOldInstances removeCustomLDAPType (infacmd isp)
infacmd wfs 1107 description 611
Purge (infacmd cms) 141 RemoveDomainLink (infacmd isp)
Purge (infacmd ps) 893 description 612
purgeauditevents (infacmd edp) 289 RemoveFolder (infacmd isp)
purgeDatabaseWorkTabless (infacmd dm) 858 description 614
PurgeDataObjectCache (infacmd dis) 202 RemoveGrid (infacmd isp)
PurgeLog (infacmd isp) description 615
description 603 RemoveGroup (infacmd isp)
purgeOrphanResults (infacmd ps) 896 description 616
PurgeResultSetCache (infacmd dis) 204 RemoveGroupPermission (infacmd isp) 618
PurgeTableCache (infacmd sql) 1037 RemoveGroupPrivilege (infacmd isp)
PurgeVersion (pmrep) description 620
description 1329 removeLDAPConnectivity (infacmd isp)
purging Data Integration Service jobs 858 description 622
RemoveLicense (infacmd isp)
description 623
R description 641
RenameApplication (infacmd dis) 210
reassignCheckedOutObject (infacmd mrs) 814 RenameConnection (infacmd isp) 643
rebuildDependencyGraph (infacmd mrs) 815 RenameFolder (infacmd mrs) 817
RenameSQLDataService (infacmd sql) 1040
Index 1391
RenameWebService running a mapping
infacmd ws 1129 with a run-time parameter set 860
replaceAllTag runSpec
infacmd dis 234 infacmd mi 769
repositories
backing up using pmrep 1276
connecting to using pmrep 1279
creating relational 1281
S
deleting details from 1339 SAP BW Service
registering 1331 creating in a domain 468
unregistering 1341 updating using infacmd isp 708
Repository Service Scheduler Service options
creating in a domain 462 infacmd syntax 1007, 1010
removing using infacmd isp 633 scheduleworkflow (pmcmd)
updating using infacmd isp 704 description 1244
ResetPassword (infacmd isp) schema files
description 645 infacmd control files 1147
Resource Manager Service scorecards
configuring properties for 972 executing 880
listing properties for 969 listing results for 887
Resource Manager Service options migrating 892
infacmd syntax 974 purging results for 893
resources script files
exporting to object export file 1076 running 1337
removing using infacmd isp 626 using for pmrep commands 1266
viewing using infacmd isp 571 Search Service
restartMapping (infacmd mi) 768 configuring properties for 1018
Restore (pmrep) creating 1013
description 1335 listing properties for 1016
RestoreApplication (infacmd dis) 214 Search Service process
RestoreContents (infacmd mrs) 820 configuring properties for 1020
RestoreDomain (infasetup) listing properties for 1017
description 1195 security domains
restoreMitKerberosLinkage (infasetup) listing using infacmd 579
description 1198 SEQ
restoring infacmd connection options 430
repositories using pmrep Restore 1335 service levels
ResumeAll (infacmd sch) 999 adding 348
ResumeSchedule (infacmd sch) 1001 listing using infacmd isp 581
resyncData (infacmd cms) 144 removing using infacmd isp 634
return codes updating using infacmd isp 710
infacmd 61 service processes
infasetup 1165 disabling on a node 483
pmcmd 1220 enabling on nodes 492
RevertObject (infacmd mrs) 822, 825 services
revive_Scorecards (infacmd ps) 898 listing using infacmd isp 585
RmPrivilege (pmrep) pinging 598
description 1336 sessions
roles getting log events for 516
assigning to a user using infacmd isp 364 SetApplicationObjectPermissions (infacmd dis) 218
creating in a domain 467 SetApplicationPermissions (infacmd dis) 216
exporting using infacmd isp 495 SetColumnPermissions (infacmd sql) 1041
importing using infacmd isp 525 SetComputeNodeAttributes (infacmd rms) 970
listing using infacmd isp 537 setConfigurationPermissions (infacmd cluster) 126
removing from a group using infacmd isp 666 SetConnectionPermissions (infacmd isp) 648
removing from a user using infacmd isp 668 SetFolder (pmcmd)
removing using infacmd isp 629 description 1246
RollbackDeployment (pmrep) setMappingPersistedOutputs
description 1336 infacmd wfs 1113
Run (pmrep) SetNoWait (pmcmd)
description 1337 description 1246
run summary SetOperationPermissions
deployed mi spec 766 infacmd ws 1131
RunCPUProfile (infacmd isp) SetRepositoryLDAPConfiguration (infacmd isp)
description 647 description 650
RunMapping SetSequenceState (infacmd dis) 222
infacmd ms 860 SetSQLDataServicePermissions (infacmd sql) 1043
SetStoredProcedurePermissions (infacmd sql) 1045
1392 Index
SetTablePermissions (infacmd sql) 1048 SyncSecurityDomains (infacmd isp) 659
SetWait (pmcmd) syntax
description 1246 command line programs 37
SetWebServicePermissions Data Integration Service infacmd options 249
infacmd ws 1133 Metadata Access Service infacmd options 752
ShowConnectionInfo (pmrep) Resource Manager Service infacmd options 974
description 1338 Scheduler Service infacmd options 1007, 1010
ShowLicense (infacmd isp)
description 653
ShowSettings (pmcmd)
description 1247
T
ShutDownLogger (infacmd pwx) 941 table owner name
ShutdownNode (infacmd isp) updating with pmrep 1348
description 654 tag
spec infacmd dis 230
deploying to an archive file 762 TDM service
spec status disabling 1070
accessing with infacmd mi 765 Teradata Parallel Transporter connection
specs deployed to a Data Integration Service infacmd 434
running 769 Test Data Manager Service
SQL data service creating in a domain 1062, 1068
listing for a Data Integration Service 1030 time zones
listing permissions for 1029 valid values for schedule 986
listing properties for 1027 TruncateLog (pmrep)
options for infacmd 1057 description 1339
renaming 1040
setting permissions for 1043
starting 1050
stopping 1052
U
updating options for 1056 UnassignDefaultOSProfile (infacmd isp) 661
StartApplication (infacmd dis) 224 UnassignISMMService (infacmd)
StartSQLDataService (infacmd sql) 1050 description 663
startTask UnassignLicense (infacmd)
infacmd wfs 1115 description 664
StartTask (pmcmd) UnassignRoleFromGroup (infacmd isp)
description 1247 description 666
using a parameter file 1249 UnassignRoleFromUser (infacmd isp)
StartWebService description 668
infacmd ws 1136 UnassignRSWSHubService (infacmd isp)
startWorkflow description 669
infacmd wfs 1116 UnassociateDomainNode (infacmd isp)
StartWorkflow (pmcmd) description 671
description 1250 UndeployApplication (infacmd dis) 237
using a parameter file 1252 UndoCheckout (pmrep)
statistics description 1340
updating repository 1349 UninstallAbapProgram (pmrep)
StopApplication (infacmd dis) 226 description 1351
stopBlazeService (infacmd dis) 227 unlocking
StopSQLDataService (infacmd sql) 1052 locked object 826
StopTask (pmcmd) unlockObject (infacmd mrs) 826
description 1253 Unregister (pmrep)
StopTaskListener (infacmd pwx) 944 description 1341
StopWebService UnregisterPlugin (pmrep)
infacmd ws 1138 description 1342
StopWorkflow (pmcmd) UnscheduleWorkflow (pmcmd)
description 1255 description 1257
stored procedures UnsetFolder (pmcmd)
listing permissions for 1032 description 1258
setting permissions for 1045 untag
SwitchConnection (pmrep) infacmd dis 232
description 1338 updateADLSCertificate (infacmd ccps) 104
SwitchToGatewayNode (infacmd) UpdateApplication (infacmd dis) 238
description 655 UpdateApplicationOptions (infacmd dis) 239
SwitchToKerberosMode (infasetup) UpdateColumnOptions (infacmd sql) 1053
description 1198 updateConfiguration (infacmd cluster) 130
SwitchToWorkerNode (infacmd isp) UpdateConnection (infacmd isp)
description 658 description 673
synchronizeProfile (infacmd ps) 899
Index 1393
UpdateConnection (pmrep) UpdateServiceOptions (infacmd dis) 247
description 1344 UpdateServiceOptions (infacmd mas) 751
updateCustomLDAPType (infacmd isp) UpdateServiceOptions (infacmd mrs) 828
description 676 UpdateServiceOptions (infacmd rms) 972
UpdateDataObjectsOptions (infacmd dis) 243 UpdateServiceOptions (infacmd sch) 1006
updateDomainName (infasetup) UpdateServiceOptions (infacmd search) 1018
description 1202 UpdateServiceProcess (infacmd isp)
UpdateDomainOptions (infacmd isp) description 712
description 679 UpdateServiceProcessOptions (infacmd as) 74
updateDomainSamlConfig (infasetup) UpdateServiceProcessOptions (infacmd cms) 148
description 1212 UpdateServiceProcessOptions (infacmd dis) 259
UpdateEmailAddr (pmrep) UpdateServiceProcessOptions (infacmd mas) 753
description 1346 UpdateServiceProcessOptions (infacmd mrs) 833
updateExportXML UpdateServiceProcessOptions (infacmd sch) 1008
infacmd xrf 1146 UpdateServiceProcessOptions (infacmd search) 1020
UpdateFolder (infacmd isp) UpdateSMTPOptions (infacmd isp)
description 680 description 714
UpdateGatewayInfo (infacmd isp) UpdateSQLDataServiceOptions (infacmd sql) 1056
description 682 UpdateSrcPrefix (pmrep)
UpdateGatewayNode (infasetup) description 1348
description 1203 updating non-reusable sessions 1348
UpdateGrid (infacmd isp) updateStatistics (infacmd mrs) 835
description 683 UpdateStatistics (pmrep)
UpdateIntegrationService (infacmd isp) description 1349
description 684 UpdateTableOptions (infacmd sql) 1059
UpdateKerberosAdminUser (infasetup) UpdateTargPrefix (pmrep)
description 1209 description 1349
UpdateKerberosConfig (infasetup) updating non-reusable sessions 1349
description 1209 UpdateWebServiceOptions
updateLDAPConnectivity (infacmd isp) infacmd ws 1141
description 687 UpdateWorkerNode (infasetup)
UpdateLicense (infacmd isp) description 1214
description 690 UpdateWSHubService (infacmd isp)
UpdateListenerService (infacmd pwx) 948 description 715
UpdateLoggerService (infacmd pwx) 951 Upgrade (infacmd cms) 150
updateMappingOptions (infacmd ms) 864 Upgrade (infacmd sch) 1011
updateMitKerberosLinkage (infasetup) UpgradeContents (infacmd mrs) 837
description 1210 UpgradeModels (infacmd pwx) 946
UpdateMMService (infacmd isp) upgradeRepository (infacmd bg) 90
description 691 upgradeService (infacmd edp) 295
UpdateMonitoringOptions (infacmd isp) 693 user accounts
UpdateNamespace (infacmd isp) 695 disabling in a domain 484
UpdateNodeOptions (infacmd isp) editing properties for 486
description 698 enabling 493
UpdateNodeRole (infacmd isp) 700 user permissions
UpdateOperationOptions listing for domain objects 589
infacmd ws 1139 users
updateOptimizationDefaultLevel (infacmd ms) 866 adding to group in a domain 351
updateOptimizationLevel (infacmd ms) 868 creating in a domain 472
UpdateOSProfile (infacmd isp) exporting 497
description 702 exporting using infacmd isp 495
UpdateParameterSetEntries (infacmd dis) 245 importing using infacmd isp 525, 529
UpdatePasswordComplexityConfig (infasetup) 1211 listing groups for a user 563
UpdateRepositoryService (infacmd isp) listing types of permissions for 544
description 704 listing using infacmd isp 538
updateSamlConfig (infasetup) migrating with infacmd 593
description 1212 removing from a group using infacmd isp 637
UpdateSAPBWService (infacmd isp) removing using infacmd isp 636
description 708 users and groups
UpdateSchedule (infacmd sch) 1002 removing permissions for 648
UpdateSeqGenVals (pmrep) users and groups in security domain
description 1347 synchronizing with LDAP users and groups 659
updateService (infacmd edp) 291
updateService (infacmd idp) 279
UpdateServiceLevel (infacmd isp)
description 710
V
UpdateServiceOptions (infacmd as) 72 Validate (pmrep)
UpdateServiceOptions (infacmd cms) 146 description 1352
1394 Index
ValidateandRegisterFeature (infasetup) web service (continued)
description 1218 renaming with infacmd 1129
validateFeature (infacmd advanced) 717 setting permissions with infacmd 1133
validating objects starting with infacmd 1136
with pmrep 1352 stopping with infacmd 1138
Version (infacmd) updating properties for 1141
description 718 web service operation
Version (pmcmd) listing permissions for 1123
description 1259 listing properties for 1121
Version (pmrep) setting