Data Transformation Command Syntax Examples
The following examples show the most common uses of dataxform. The full list of options appears in the table below.
Preparation and GuardPoint File Analysis Examples
Check the dataxform version
dataxform --version
Display basic GuardPoint file information
dataxform --scan --gp dir_path
where dir_path
is the full path to a GuardPoint or an unguarded directory.
Lists the subdirectories in the GuardPoint or unguarded directory, the number of files in the top directory and in each subdirectory, and the total number of files and directories. The disk usage for each directory, and total disk usage, are also listed.
When run on a GuardPoint that has already been transformed but not cleaned, --scan
also returns the number of hard links and soft links that were skipped in the previous dataxform session.
Display file information and create simulation files
dataxform --deep_scan --gp dir_path
where dir_path
is the full path to a GuardPoint or an unguarded directory.
Lists the subdirectories in the GuardPoint or unguarded directory, the number of files in the top directory and in each subdirectory, and the total number of files and directories. The disk usage for each directory, and total disk usage, are also listed.
In addition, this command creates a set of simulation files of various sizes in the GuardPoint or directory, and uses these to estimate how long it would take to rekey the actual GuardPoint or directory. See also Estimating the dataxform Runtime Period.
Check file links
dataxform --check_links --gp guardpoint_path
where dir_path
is the full path to a GuardPoint or an unguarded directory.
Lists the subdirectories in the GuardPoint or unguarded directory, the number of files in the top directory and in each subdirectory, and the total number of files and directories. The disk usage for each directory, and total disk usage, are also listed.
In addition, this argument scans for hard links in the GuardPoint or unguarded directory. This operation generates only a list of hard-link files.
Rekeying a GuardPoint Examples
Check to see if a GuardPoint is ready to be rekeyed
dataxform --rekey_supported --gp guardpoint_path
where guardpoint_path
is the full path to the GuardPoint.
This command makes sure that the GuardPoint is valid, has a rekey policy applied, and is not being accessed by any users or processes.
For example: dataxform --rekey_supported --gp /opt/apps/dx2
Rekey All Files in a GuardPoint
dataxform --rekey --gp guardpoint_path [--nq]
where guardpoint_path
is the full path to the GuardPoint and --nq
is an optional parameter that tells dataxform to run the command silently (without displaying any prompts).
Rekey Specific Files in a GuardPoint
dataxform --rekey_list --file_list file --gp guardpoint_path
where:
-
--file_list file
specifies the name of the input file that contains a list of the files that you want dataxform to process. -
guardpoint_path
is the full path to the GuardPoint.
Troubleshooting and Maintenance Examples
Clean up a GuardPoint after a previous dataxform session
dataxform --cleanup [--nq] --gp guardpoint_path
where:
-
--nq
is an optional parameter that tells dataxform to run the command silently (without displaying any prompts). -
guardpoint_path
is the full path to the GuardPoint.
For example: dataxform --cleanup --nq --gp /opt/apps/dx2
Generate the files necessary to complete an interrupted dataxform session
dataxform --recovery [--file_list file] --gp guardpoint_path [--dir_recovery path] [-nq]
where:
-
--file_list file
specifies the name of the output file you want dataxform to use. dataxform automatically appends _done to this file name. -
guardpoint_path
is the full path to the GuardPoint. -
--dir_recovery path
specifies the name of a custom output directory into which dataxform should write the recovery files. If this option is not specified, dataxform writes the output files to /var/log/vormetric on Linux/AIX or to the standard logs directory on Windows. -
--nq
is an optional parameter that tells dataxform to run the command silently (without displaying any prompts).
For example:
dataxform --recovery --file_list my-output-file --gp /opt/apps/dx2 \
--dir_recovery /var/custom/output/dir