Debian Codegraph @

doc/source/user/shell.rst

raw
1 The :program:`freezer` Shell Utility
2
3 .. program:: freezer
4 .. highlight:: bash
5
6 The :program:`freezer` shell utility interacts with OpenStack Freezer API from the
7 command line. It supports the entirety of the OpenStack Freezer API.
8
9 You'll need to provide :program:`freezer` with your OpenStack Keystone user
10 information. You can do this with the `--os-username`, `--os-password`,
11 `--os-project-name` (`--os-project-id`), `--os-project-domain-name`
12 (`--os-project-domain-id`) and `--os-user-domain-name` (`--os-user-domain-id`)
13 options, but it's easier to just set them as environment variables by setting
14 some environment variables:
15
16 .. envvar:: OS_USERNAME
17
18 Your OpenStack Keystone user name.
19
20 .. envvar:: OS_PASSWORD
21
22 Your password.
23
24 .. envvar:: OS_PROJECT_NAME
25
26 The name of project for work.
27
28 .. envvar:: OS_PROJECT_ID
29
30 The ID of project for work.
31
32 .. envvar:: OS_PROJECT_DOMAIN_NAME
33
34 The name of domain containing the project.
35
36 .. envvar:: OS_PROJECT_DOMAIN_ID
37
38 The ID of domain containing the project.
39
40 .. envvar:: OS_USER_DOMAIN_NAME
41
42 The user's domain name.
43
44 .. envvar:: OS_USER_DOMAIN_ID
45
46 The user's domain ID.
47
48 .. envvar:: OS_AUTH_URL
49
50 The OpenStack Keystone endpoint URL.
51
52 .. envvar:: OS_BACKUP_API_VERSION
53
54 The OpenStack freezer API version.
55
56 .. envvar:: OS_REGION_NAME
57
58 The Keystone region name. Defaults to the first region if multiple regions
59 are available.
60
61 For example, in Bash you'd use::
62
63 export OS_USERNAME=yourname
64 export OS_PASSWORD=yadayadayada
65 export OS_PROJECT_NAME=myproject
66 export OS_PROJECT_DOMAIN_NAME=default
67 export OS_USER_DOMAIN_NAME=default
68 export OS_AUTH_URL=http://<url-to-openstack-keystone>/identity
69 export OS_BACKUP_API_VERSION=2
70
71 From there, all shell commands take the form::
72
73 freezer <command> [arguments...]
74
75 Run :program:`freezer help` to get a full list of all possible commands, and run
76 :program:`freezer help <command>` to get detailed help for that command.
77
78 Reference
79 ---------
80
81 For more information, see the reference:
82
83 .. toctree::
84 :maxdepth: 2
85
86 /cli/freezer