Table of Contents

Search

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

Command Reference

Command Reference

BackupContents

BackupContents

When you run the BackupContents command, the Catalog Service takes a backup of the MongoDB, Solr, PostgresSQL, and the scanner staging data.
You can run the BackupContents command in online and offline mode. The offline mode is set as default. If the Catalog Service is SSL-enabled, before taking the backup in offline mode, you need set the following environment variables:
  • Encrypted INFA_KEYSTORE_PASSWORD
  • Encrypted INFA_TRUSTSTORE_PASSWORD
  • INFA_TRUSTSTORE
  • INFA_KEYSTORE
See the sample command to encrypt password: $INFA_HOME/server/bin/pmpasswd <password>
For example,
  • export INFA_KEYSTORE_PASSWORD=hQDP8O8tfwxRSwbeANEptl4AIQqJcSj9ZMDkVK+9S+Y=
  • export INFA_TRUSTSTORE_PASSWORD=hx/nRWisSjnQ0zEGV3N7j1FCGFOm5RfisQxKTdf5f8Y=
  • export INFA_TRUSTSTORE=/data/Informatica/LDM1040TO1050/services/shared/security/
  • export INFA_KEYSTORE=/data/Informatica/LDM1040TO1050/services/shared/security
Note the following points before you run this command:
  • If you run the command in the online mode, you must make sure that the Catalog Service is up and running.
  • When the online backup is in progress, you can perform the read operation in the Catalog Service.
  • If Solr is deployed on multiple nodes, the cluster shared file path system should be common for all the Solr hosts, the cluster shared path system should be NFS mount, and gateway user ID should be same for all the Solr hosts.
  • The BackupContents command requires the INFA_KEYSTORE and INFA_KEYSTORE_PASSWORD environment variables to connect to Solr and MongoDB services of Informatica Cluster Service.
The infacmd ldm BackupContents command uses the following syntax:
BackupContents <-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] <-OutputFilename|-of> output_file_name [<-BackupMode|-mode> pass the mode in which backup is to be taken. Possible values are OFFLINE or ONLINE. The default value is OFFLINE.] [<-Force|-fr> force [<-StoreType|-st> Comma separated values of backup store type to be taken. Accepted types are Asset,Orchestration,Search,Similarity. Example value: 'Asset,Search,Orchestration' or simply 'Search'). By default, it will take backup for all stores.]
The following table describes infacmd ldm BackupContents options and arguments:
Option
Argument
Description
-DomainName
-dn
domain_name
Required. Name of the Informatica domain. You can set 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
-un
user_name
Required if the domain uses Native or LDAP authentication. 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
-pd
password
Required if you specify the user name. Password for 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.
-ServiceName
-sn
service_name
Required. Name of the Catalog Service.
-SecurityDomain
-sdn
security_domain
Required if the domain uses LDAP authentication. Optional if 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.
-ResilienceTimeout
-re
timeout_period_in_seconds
Optional. Amount of time in seconds that infacmd attempts to establish or reestablish a connection to the domain. You can set the resilience timeout period with the -re option or the environment variable INFA_CLIENT_RESILIENCE_TIMEOUT. If you set the resilience timeout period with both methods, the -re option takes precedence.
-OutputFilename
-of
output_file_name
Required. Complete path and filename of the backup ZIP file on the local machine. The backup command creates the zip file name.
-BackupMode
-mode
Specify the mode in which backup is to be taken
Optional. The mode in which you want to take backup.
Specify one of the following values:
  • OFFLINE
  • ONLINE
The default value is OFFLINE.
If you want to back up the catalog data when the Catalog Service is running, specify the ONLINE mode.
-Force
-fr
force
Optional. If you want to force backup when the backup mode is offline. Forcefully takes backup and overwrites the existing backup.
-StoreType
-st
Data store type values:
  • Asset
  • Orchestration
  • Search
  • Similarity
Optional. Provide the required data store that you want to back up or a comma-separated list of data stores that you want to back up.
Based on the issues you want to troubleshoot, you can back up the required data stores instead of taking a complete backup of the catalog.
You can back up the following data stores in the catalog:
  • Asset
  • Orchestration
  • Search
  • Similarity
You must back up the
Asset
,
Search
, and
Similarity
if you want to view data after you restore data from the backup.
By default, the command backs up all the data stores in the catalog.
See the following samples for more information:
  • To back up data stores that include Asset, Similarity, Search, and Orchestration, add the arguments to the
    -st
    option as shown:
    -st Asset,Similarity, Search, and Orchestration
    .

0 COMMENTS

We’d like to hear from you!
Informatica Documentation Team - March 18, 2024

Hi Astra Valters,

We currently don't have an option to abort the operation from the Catalog Backup Settings page. Please contact GCS to raise a feature request.

Thanks