backupContents
The Catalog Service takes backup of the MongoDB, Solr, PostgresSQL, and scanner staging data. Before you backup the Catalog Service, you need to set the following environment variables:
- •INFA_TRUSTSTORE. See the following sample command to set the variable: export INFA_TRUSTSTORE= <Location of the Informatica truststore file>. Default location is $INFA_HOME/services/shared/security.
- •INFA_KEYSTORE. See the following sample command to set the variable: export INFA_KEYSTORE=<Location of the keystore file>. Default location is $INFA_HOME/services/shared/security. This variable is required only if you used custom SSL configuration for the Informatica domain. For default SSL and non-SSL configurations, you must unset the variable.
- •Encrypted INFA_TRUSTSTORE_PASSWORD. Encrypt the password that you set. See the following sample command to set the encrypted password: export INFA_TRUSTSTORE_PASSWORD="84Ve/soUbpQ/Aae5uGKXQA==".
- •Encrypted INFA_KEYSTORE_PASSWORD. Encrypt the password that you set. See the following sample command to set the encrypted password: export INFA_KEYSTORE_PASSWORD="6cDE/ItyUL/Rtui9nhVRI==". This variable is required only if you used custom SSL configuration for the Informatica domain. For default SSL and non-SSL configurations, you must unset the variable.
.
Note: 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/LDM1051/services/shared/security/
- •export INFA_KEYSTORE=/data/Informatica/LDM1051/services/shared/security
Note the following points before you run this command:
- •When the Catalog Service is up and running and the 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.
- •Set the INFA_TRUSTSTORE and INFA_TRUSTSTORE_PASSWORD environment variables on both SSL and non-SSL enabled Informatica domain.
- •If Solr is installed on multi-node setup, you need to configure the ClusterSharedFilesystemPath option in Informatica Cluster Service to restore the Solr.
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
[<-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. |
-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. Note: 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.
|
Effective in Enterprise Data Catalog version 10.5.1.1, you can see the status of the backup in the following log file on the node where you run the command: <Informatica installation directory>/logs/<Node name>/services/CatalogService/<Catalog Service name>/LDMBackup.log. The maximum file size for each log file is 100 MB. After the maximum file size is reached, a new file is created. The maximum number of log files that are stored is 20. After this limit is reached, the oldest log file is replaced with the latest log file.