Debian Codegraph @

doc/source/cli/index.rst

raw
1 Command-line Tool Reference
2
3 In order to use the CLI, you must provide your OpenStack username,
4 password, tenant, and auth endpoint. Use the corresponding
5 configuration options (``--os-username``, ``--os-password``,
6 ``--os-project-id``, and ``--os-auth-url``) or set them in environment
7 variables::
8
9 export OS_USERNAME=user
10 export OS_PASSWORD=pass
11 export OS_PROJECT_ID=c373706f891f48019483f8bd6503c54b
12 export OS_AUTH_URL=http://auth.example.com:5000/v2.0
13
14 The command line tool will attempt to reauthenticate using your
15 provided credentials for every request. You can override this behavior
16 by manually supplying an auth token using ``--os-backup-url`` and
17 ``--os-auth-token``. You can alternatively set these environment
18 variables::
19
20 export OS_BACKUP_URL=http://freezer.example.org:9090/
21 export OS_AUTH_TOKEN=3bdc4d3a03f44e3d8377fa247b0ad155
22
23 Once you've configured your authentication parameters, you can run
24 ``freezer help`` to see a complete listing of available commands.
25
26 .. toctree::
27
28 details
29 freezer