~ubuntu-branches/ubuntu/quantal/nova/quantal-proposed

« back to all changes in this revision

Viewing changes to doc/source/man/nova-manage.rst

  • Committer: Package Import Robot
  • Author(s): Chuck Short
  • Date: 2012-08-16 14:04:11 UTC
  • mto: This revision was merged to the branch mainline in revision 84.
  • Revision ID: package-import@ubuntu.com-20120816140411-0mr4n241wmk30t9l
Tags: upstream-2012.2~f3
ImportĀ upstreamĀ versionĀ 2012.2~f3

Show diffs side-by-side

added added

removed removed

Lines of Context:
21
21
DESCRIPTION
22
22
===========
23
23
 
24
 
nova-manage controls cloud computing instances by managing nova users, nova projects, nova roles, shell selection, vpn connections, and floating IP address configuration. More information about OpenStack Nova is at http://nova.openstack.org.
 
24
nova-manage controls cloud computing instances by managing shell selection, vpn connections, and floating IP address configuration. More information about OpenStack Nova is at http://nova.openstack.org.
25
25
 
26
26
OPTIONS
27
27
=======
29
29
The standard pattern for executing a nova-manage command is:
30
30
``nova-manage <category> <command> [<args>]``
31
31
 
32
 
For example, to obtain a list of all projects:
33
 
``nova-manage project list``
34
 
 
35
32
Run without arguments to see a list of available command categories:
36
33
``nova-manage``
37
34
 
38
 
Categories are user, project, role, shell, vpn, and floating. Detailed descriptions are below.
 
35
Categories are project, shell, vpn, and floating. Detailed descriptions are below.
39
36
 
40
37
You can also run with a category argument such as user to see a list of all commands in that category:
41
 
``nova-manage user``
 
38
``nova-manage floating``
42
39
 
43
40
These sections describe the available categories and arguments for nova-manage.
44
41
 
53
50
 
54
51
    Sync the database up to the most recent version. This is the standard way to create the db as well.
55
52
 
56
 
Nova User
57
 
~~~~~~~~~
58
 
 
59
 
``nova-manage user admin <username>``
60
 
 
61
 
    Create an admin user with the name <username>.
62
 
 
63
 
``nova-manage user create <username>``
64
 
 
65
 
    Create a normal user with the name <username>.
66
 
 
67
 
``nova-manage user delete <username>``
68
 
 
69
 
    Delete the user with the name <username>.
70
 
 
71
 
``nova-manage user exports <username>``
72
 
 
73
 
    Outputs a list of access key and secret keys for user to the screen
74
 
 
75
 
``nova-manage user list``
76
 
 
77
 
    Outputs a list of all the user names to the screen.
78
 
 
79
 
``nova-manage user modify <accesskey> <secretkey> <admin?T/F>``
80
 
 
81
 
    Updates the indicated user keys, indicating with T or F if the user is an admin user. Leave any argument blank if you do not want to update it.
82
 
 
83
 
Nova Project
84
 
~~~~~~~~~~~~
85
 
 
86
 
``nova-manage project add <projectname>``
87
 
 
88
 
    Add a nova project with the name <projectname> to the database.
89
 
 
90
 
``nova-manage project create <projectname>``
91
 
 
92
 
    Create a new nova project with the name <projectname> (you still need to do nova-manage project add <projectname> to add it to the database).
93
 
 
94
 
``nova-manage project delete <projectname>``
95
 
 
96
 
    Delete a nova project with the name <projectname>.
97
 
 
98
 
``nova-manage project environment <projectname> <username>``
99
 
 
100
 
    Exports environment variables for the named project to a file named novarc.
101
 
 
102
 
``nova-manage project list``
103
 
 
104
 
    Outputs a list of all the projects to the screen.
105
 
 
106
 
``nova-manage project quota <projectname>``
107
 
 
108
 
    Outputs the size and specs of the project's instances including gigabytes, instances, floating IPs, volumes, and cores.
109
 
 
110
 
``nova-manage project remove <projectname>``
111
 
 
112
 
    Deletes the project with the name <projectname>.
113
 
 
114
 
``nova-manage project zipfile``
115
 
 
116
 
    Compresses all related files for a created project into a zip file nova.zip.
117
 
 
118
 
Nova Role
119
 
~~~~~~~~~
120
 
 
121
 
``nova-manage role add <username> <rolename> <(optional) projectname>``
122
 
 
123
 
    Add a user to either a global or project-based role with the indicated <rolename> assigned to the named user. Role names can be one of the following five roles: cloudadmin, itsec, sysadmin, netadmin, developer. If you add the project name as the last argument then the role is assigned just for that project, otherwise the user is assigned the named role for all projects.
124
 
 
125
 
``nova-manage role has <username> <projectname>``
126
 
    Checks the user or project and responds with True if the user has a global role with a particular project.
127
 
 
128
 
``nova-manage role remove <username> <rolename>``
129
 
    Remove the indicated role from the user.
130
 
 
131
53
Nova Logs
132
54
~~~~~~~~~
133
55