HMC Manual Reference Pages  - BKCONSDATA (1)

NAME

bkconsdata - back up console data

CONTENTS

Synopsis
Description
Options
Examples
Environment
Bugs
Author
See Also

SYNOPSIS

bkconsdata -r {usb | ftp | sftp | nfs | none}
[-h host-name] [-u user-ID] [--passwd password] [-k SSH-private-key]
[-l mount-location] [-o "mount-command-options"]
[-d remote-directory] [-f file] [--force]
[-i perfmon] [--help]

DESCRIPTION

bkconsdata backs up critical Hardware Management Console (HMC) data, which is HMC data that is stored on the HMC hard disk. This backup data may be used to restore the HMC if the HMC needs to be reinstalled from the HMC recovery CDs in the event of an HMC hard disk failure.

OPTIONS

-r The archive option for the backup data. Valid values are usb for a USB flash memory device, ftp for a remote FTP site, sftp for a remote secure FTP (SFTP) site, nfs for an NFS file system, or none. The none option is used to remove the backup task lock allowing this task to be re-executed immediately.
-h The host name or IP address of the remote server.

This option is required when backing up the data to a remote FTP site, SFTP site, or NFS file system. Otherwise, this option is not valid.

-u The user ID to use to log in to the remote FTP or SFTP site.

This option is required when backing up the data to a remote FTP or SFTP site. Otherwise, this option is not valid.

--passwd The password to use to log in to the remote FTP or SFTP site.

If this option is omitted and the data is being backed up to a remote FTP site, you will be prompted to enter the password. If both this option and the -k option are omitted and the data is being backed up to a remote SFTP site, you will be prompted to enter the password. The --passwd and -k options are mutually exclusive.

This option is only valid when backing up the data to a remote FTP or SFTP site.

-k The name of the file that contains the SSH private key. If the file name is not fully qualified, the file must exist in the user’s home directory on the HMC.

Use the ssh-keygen command to generate the public and private SSH key pair. The ssh-keygen command is not allowed to write to the .ssh directory in the user’s home directory on the HMC, so when you run the command on the HMC, you must specify both the directory and the file name for the private key. If you generate a key with a passphrase, you will be prompted to enter the passphrase when you run any HMC command that uses the key.

If both this option and the --passwd option are omitted and the data is being backed up to a remote SFTP site, you will be prompted to enter the password. The -k and --passwd options are mutually exclusive.

This option is only valid when backing up the data to a remote SFTP site.

-l The mount location defined on the NFS server where the backup data will be written.

This option is required when backing up the data to an NFS file system. Otherwise, this option is not valid.

-o Options to be passed to the mount command used to mount the NFS file system where the backup data will be written. The options must be enclosed in double quotes.

The HMC supports NFS versions 3 and 4, and this command uses version 3 by default. To use version 4, include the option vers=4.

This option is only valid when backing up the data to an NFS file system.

-d The name of the directory on the remote server to which to write the backup data. If this option is not specified when backing up the data to a remote FTP or SFTP site, the backup data will be written to the user’s home directory. If this option is not specified when backing up the data to an NFS file system, the backup data will be written to the mount-location on the NFS server.

This option is only valid when backing up the data to a remote FTP site, SFTP site, or NFS file system.

-f The name of the file on the remote server to which to write the backup data. The name must start with HMCBackup_.

If the specified file already exists, this command will fail unless the --force option is specified.

This option is only valid when backing up the data to a remote FTP site, SFTP site, or NFS file system.

--force When -f is specified, specify this option to allow the specified file to be overwritten if it already exists. If it already exists and this option is not specified, the backup will fail.

This option is only valid when -f is specified.

-i Additional data to be included in the backup data. The only valid value is perfmon to include performance monitoring data.
--help Display the help text for this command and exit.

EXAMPLES

Back up critical HMC data to a USB flash memory device:

bkconsdata -r usb

Back up critical HMC data to a remote FTP site:

bkconsdata -r ftp -h ftpserver -u ftpuser --passwd ftppassword

Back up critical HMC data to a remote SFTP site using SSH keys for authentication and include performance monitoring data:

bkconsdata -r sftp -h sftpserver -u sftpuser -i perfmon
-k /home/hmcuser/keys/id_rsa

Back up critical HMC data to an NFS file system using NFS version 4:

bkconsdata -r nfs -h 9.3.145.52 -l /home/hmc/backups -o "vers=4"

ENVIRONMENT

None

BUGS

None

AUTHOR

IBM Austin

SEE ALSO

rstconsdata


Linux BKCONSDATA (1) June 2024
Generated by manServer 1.07 from bkconsdata.1 using man macros.