=head1 NAME

B<dumpxCATdb> - dumps the xCAT db tables .

=head1 SYNOPSIS

B<dumpxCATdb> [B<-a>] [B<-V>] [{B<-p>|B<--path>} I<path>]

B<dumpxCATdb> [B<-b>] [B<-V>] [{B<-p>|B<--path>} I<path>]

B<dumpxCATdb> [B<-h>|B<--help>] [B<-v>|B<--version>]


=head1 DESCRIPTION

If not using the binary dump option (-b), then the dumpxCATdb command creates .csv files for xCAT database tables and puts them in the directory given by the -p flag. These files can be used by the restorexCATdb command to restore the database. The command will read the list of tables in the site.skiptables attribute and not backup those tables.
Supports using XCAT_SKIPTABLES env variable to provide a list of skip tables.
The command will never backup TEAL or ISNM tables, except isnm_config.  To dump TEAL tables use the documented process for TEAL.  For ISNM use tabdump, after using tabprune to get to prune unnecessary records. 

If using the binary dump option for the DB2 or postgreSQL database, then the routine will use the Database provide utilites for backup of the entire database.  

=head1 OPTIONS


B<-h>          Display usage message.

B<-v>          Command Version.

B<-V>          Verbose.

B<-a>          All,without this flag the eventlog and auditlog will be skipped.

B<-b>          This flag is only used for the DB2 or postgreSQL database. The routine will use the database backup utilities to create a binary backup of the entire  database. Note to use this backup on DB2, you will have first had to modify the logging of the database and have taken an offline initial backup. Refer to the xCAT DB2 documentation for more instructions.  

B<-p>          Path to the directory to dump the database. It will be created, if it does not exist.


=head1 RETURN VALUE

0 The command completed successfully.

1 An error has occurred.

=head1 EXAMPLES

1. To dump the xCAT database into the /tmp/db directory, enter:

B<dumpxCATdb -p /tmp/db>

2. To dump the xCAT database into the /tmp/db directory, including the auditlog and eventlog enter:

B<dumpxCATdb -a -p /tmp/db>

3. To have dumpxCATdb not backup the hosts or passwd table:

B<chtab key=skiptables site.value="hosts,passwd">

B<dumpxCATdb  -p /tmp/db>

4. To have dumpxCATdb not backup the hosts or passwd table:

B<export XCAT_SKIPTABLES="hosts,passwd">

B<dumpxCATdb  -p /tmp/db>

5. To have dumpxCATdb use DB2 utilities to backup the DB2 database:

B<dumpxCATdb -b -p /install/db2backup>


=head1 FILES

/opt/xcat/sbin/dumpxCATdb


=head1 SEE ALSO

L<restorexCATdb(1)|restorexCATdb.1>



