List of Parameters - AFS - Technical Notes

AFS Backup and Restore

Product
AFS
Platform
7.12
Category
Technical Notes
Language
English
Target Audience
public

The following table lists and describes the Generic Backup/Restore tool parameters:

Parameter

Cardinality

Description

--action {backup,restore}

Mandatory

Expects the action to execute, can be repeated. For example, to execute a migration you could run both backup and restore in the same command line.
Defaults to []

--data-config DATA_CONFIG

Mandatory

Expects the configuration file describing what and how to backup/restore. See --help-config for details on the default configuration files.

  • If the configuration file was pre-packaged, write its filename.
  • If the configuration file was customized, write its complete path.

Defaults to data-config.yml

--hosts-config HOSTS_CONFIG

Mandatory

Expects a configuration file describing what hosts to collect from and where to copy the data.

  • If the configuration file was pre-packaged, write its filename.
  • If the configuration file was customized, write its complete path.

Roles set in --hosts-config.yml must match roles set in --data-config.yml.

Defaults to None

--log {debug,info,warning,error,critical}

Optional

Log level. --log only accepts one value.

Defaults to info

-h, --help

Optional

Shows the help message and exits.

--help-config

Optional

Shows some help on the configuration file format and exits.
Defaults to False