cc_staff
1,486
edits
Line 66: | Line 66: | ||
==Command Line Clients== | ==Command Line Clients== | ||
==Combined OpenStack CLI tool== | ===Combined OpenStack CLI tool=== | ||
The OpenStack CLI tools allow one to perform many of the actions one would perform using the OpenStack dashboard GUI but on the command line. They also allow more functionality above and beyond the OpenStack dashboard. The OpenStack combined tools replaces the various separate command line tools, such as nova, swift, glance, cider etc. See [http://docs.openstack.org/developer/python-openstackclient/ http://docs.openstack.org/developer/python-openstackclient/] for the official documentation. The rest of this section gives a very basic overview to get a user started and points out some of the commands available. | The OpenStack CLI tools allow one to perform many of the actions one would perform using the OpenStack dashboard GUI but on the command line. They also allow more functionality above and beyond the OpenStack dashboard. The OpenStack combined tools replaces the various separate command line tools, such as nova, swift, glance, cider etc. See [http://docs.openstack.org/developer/python-openstackclient/ http://docs.openstack.org/developer/python-openstackclient/] for the official documentation. The rest of this section gives a very basic overview to get a user started and points out some of the commands available. | ||
===Installation=== | ====Installation==== | ||
{{command|sudo apt-get install python-dev python-pip}} | {{command|sudo apt-get install python-dev python-pip}} | ||
{{command|pip install python-openstackclient}} | {{command|pip install python-openstackclient}} | ||
Line 77: | Line 77: | ||
provided that pip is install which installs to ~/.local/lib/pythonX.Y/site-packages/ so by adding <code>export PYTHONPATH=${HOME}/.local/lib/python2.7/site-packages/:${PYTHONPATH}</code> to your <code>.bashrc</code> file if you are using Python major version X=2, and minor version Y=7 python can then load those modules. Further adding <code>export PATH=${HOME}/.local/bin:${PATH}</code> to your .bashrc will allow you to run the openstack commands directly. | provided that pip is install which installs to ~/.local/lib/pythonX.Y/site-packages/ so by adding <code>export PYTHONPATH=${HOME}/.local/lib/python2.7/site-packages/:${PYTHONPATH}</code> to your <code>.bashrc</code> file if you are using Python major version X=2, and minor version Y=7 python can then load those modules. Further adding <code>export PATH=${HOME}/.local/bin:${PATH}</code> to your .bashrc will allow you to run the openstack commands directly. | ||
===Executing commands=== | ====Executing commands==== | ||
The combined CLI tool can be used interactively by running | The combined CLI tool can be used interactively by running | ||
{{Command|openstack}} | {{Command|openstack}} | ||
Line 86: | Line 86: | ||
To execute a command type {{Command|openstack <command group> <command>}} | To execute a command type {{Command|openstack <command group> <command>}} | ||
====<code>server</code> command group==== | =====<code>server</code> command group===== | ||
{|- | {|- | ||
| <code>add security group</code> || <code>migrate</code> || <code>resume</code> || <code>unlock</code> | | <code>add security group</code> || <code>migrate</code> || <code>resume</code> || <code>unlock</code> | ||
Line 105: | Line 105: | ||
|} | |} | ||
====<code>volume</code> command group==== | =====<code>volume</code> command group===== | ||
{|- | {|- | ||
|<code>create</code>||<code>set</code> | |<code>create</code>||<code>set</code> | ||
Line 114: | Line 114: | ||
|} | |} | ||
====<code>console</code> command group==== | =====<code>console</code> command group===== | ||
{|- | {|- | ||
|<code>log show</code>||<code>url show</code> | |<code>log show</code>||<code>url show</code> | ||
|} | |} | ||
====<code>image</code> command group==== | =====<code>image</code> command group===== | ||
{|- | {|- | ||
|<code>create</code>||<code>save</code>| | |<code>create</code>||<code>save</code>| | ||
Line 126: | Line 126: | ||
|<code>list</code>||<code>show</code>| | |<code>list</code>||<code>show</code>| | ||
|} | |} | ||
====<code>ip</code> command group==== | =====<code>ip</code> command group===== | ||
{|- | {|- | ||
|<code>fixed add</code>||<code>floating list</code> | |<code>fixed add</code>||<code>floating list</code> | ||
Line 139: | Line 139: | ||
|} | |} | ||
====<code>keypair</code> command group==== | =====<code>keypair</code> command group===== | ||
{|- | {|- | ||
|<code>create</code>||<code>list</code> | |<code>create</code>||<code>list</code> | ||
Line 145: | Line 145: | ||
|<code>delete</code>||<code>show</code> | |<code>delete</code>||<code>show</code> | ||
|} | |} | ||
====<code>network</code> command group==== | |||
=====<code>network</code> command group===== | |||
{|- | {|- | ||
|<code>create</code>||<code>set</code> | |<code>create</code>||<code>set</code> | ||
Line 154: | Line 155: | ||
|} | |} | ||
====<code>snapshot</code> command group==== | =====<code>snapshot</code> command group===== | ||
{|- | {|- | ||
|<code>create</code>||<code>set</code> | |<code>create</code>||<code>set</code> | ||
Line 163: | Line 164: | ||
|} | |} | ||
====<code>security group</code> command group==== | =====<code>security group</code> command group===== | ||
{|- | {|- | ||
|<code>create</code>||<code>rule list</code> | |<code>create</code>||<code>rule list</code> | ||
Line 176: | Line 177: | ||
|} | |} | ||
====<code>limits show</code>==== | =====<code>limits show</code>===== | ||
<!--These two (container and object) are not widely publicized | <!--These two (container and object) are not widely publicized | ||
====container==== | =====container===== | ||
{|- | {|- | ||
|<code>create</code>||<code>set</code> | |<code>create</code>||<code>set</code> | ||
Line 190: | Line 191: | ||
|<code>save</code> | |<code>save</code> | ||
|} | |} | ||
====object==== | =====object===== | ||
{|- | {|- | ||
|<code>create</code>||<code>show</code> | |<code>create</code>||<code>show</code> |