Files
python-freezerclient/doc/source/cli/index.rst
Cai Hui c05b79625f Update freezerclient documentation
Change-Id: I2a36243847d8cbe02db7e99ba7c0995917204167
Story: 1706166
Task: 25709
2018-10-16 05:04:19 -04:00

29 lines
1.0 KiB
ReStructuredText

Command-line Tool Reference
In order to use the CLI, you must provide your OpenStack username,
password, tenant, and auth endpoint. Use the corresponding
configuration options (``--os-username``, ``--os-password``,
``--os-project-id``, and ``--os-auth-url``) or set them in environment
variables::
export OS_USERNAME=user
export OS_PASSWORD=pass
export OS_PROJECT_ID=c373706f891f48019483f8bd6503c54b
export OS_AUTH_URL=http://auth.example.com:5000/v2.0
The command line tool will attempt to reauthenticate using your
provided credentials for every request. You can override this behavior
by manually supplying an auth token using ``--os-backup-url`` and
``--os-auth-token``. You can alternatively set these environment
variables::
export OS_BACKUP_URL=http://freezer.example.org:9090/
export OS_AUTH_TOKEN=3bdc4d3a03f44e3d8377fa247b0ad155
Once you've configured your authentication parameters, you can run
``freezer help`` to see a complete listing of available commands.
.. toctree::
details
freezer