Jump to: navigation, search

Difference between revisions of "UnifiedCLI/Mapping"

m (Text replace - "<<TableOfContents()>>" to "__TOC__")
(Redirected page to OpenStackClient/Commands)
 
(166 intermediate revisions by 4 users not shown)
Line 1: Line 1:
__NOTOC__
+
#REDIRECT [[OpenStackClient/Commands]]
 +
 
 +
'''''Note: this page is being deprecated in favor of a new [[OpenStackClient/Commands|OpenStackClient Commands]] page with the correct name.'''''
 +
 
 
__TOC__
 
__TOC__
  
Line 9: Line 12:
  
 
= Command Structure =
 
= Command Structure =
 +
 +
The OpenStackClient has a consistent and predictable format for all of its commands.
 +
 +
* The top level command name is <code>openstack</code>
 +
* Sub-commands take the form:
 +
<code>openstack [<global-options>] <object> <verb> [<second-object>] [<command-local-arguments>]</code>
 +
'''''Note: The command format change was committed on 13May2013.  This is the new format.'''''
 +
 +
 +
== Command Arguments ==
 +
 +
* All long options names shall use '-' as the interpolation character (<code>--like-this</code>)
 +
* Authentication options conform to [[/Authentication| a revised version of]] the original [[CLIAuth]]
 +
* Global arguments generally have a corresponding environment variable that may also be used to set the value.  If both are present, the command-line option takes priority.  The environment variable names can be derived from the option by dropping the leading '--', converting all embedded dashes ('-') to underscores ('_'), and converting to upper case.
 +
* Positional arguments trail command options.
 +
* Some commands require two objects be acted upon, both objects appear in the command and if both are positional arguments they appear in the same order as in the command.  In words it can be expressed as "(given) object1 add object2 (to it)"
 +
  * <object-1> <verb> <object-2>
 +
    * group add user
 +
    * access token list  (here, 'access token' is a two-word single object)
 +
    * user list role (needs more thinking)
 +
 +
== Other ==
 +
 +
* Arguments that normally require an ID in the OS-API may also use the name or other short identifier where reasonable to support
 +
* Optional machine-parsable format is available with list and show commands.  List has an option for CSV-formatted output (see --format, --quote options for a list command) while show has an option for shell-assignment formatted output (see --format option for a show command).
  
 
== Verbs ==
 
== Verbs ==
  
The verbs used by the default [[OpenStack]] clients have been mapped to the set below that attempts to define a consistent meaning to each action.  Many of them have logical opposite actions.  Those verbs with an opposite action is noted in parens if applicable.
+
The verbs used by the default [[OpenStack]] clients are defined below to provide a consistent meaning to each action.  Many of them have logical opposite actions.  Those verbs with an opposite action are noted in parens if applicable.
  
* <code><nowiki>add</nowiki></code> (<code><nowiki>remove</nowiki></code>) - add an object to a container which itself is usually another object; the command is built in the order of "add object1 to object2" (<object1>-<object2>), the positional arguments also appear in that order
+
* <code>authorize</code> - authorize a token (used in OAuth)
* <code><nowiki>attach</nowiki></code> (<code><nowiki>detach</nowiki></code>) - connect two objects (is this different from add/remove?)
+
* <code>add</code> (<code>remove</code>) - add some object to a container object; the command is built in the order of "container add object" (<container> <object>), the positional arguments appear in the same order
 +
* <code>attach</code> (<code>detach</code>) - connect two objects (is this different from add/remove? not really, use the same argument order as <code>add</code>)
 
* <code><nowiki>create</nowiki></code> (<code><nowiki>delete</nowiki></code>) - create a new occurrance of the specified object
 
* <code><nowiki>create</nowiki></code> (<code><nowiki>delete</nowiki></code>) - create a new occurrance of the specified object
 
* <code><nowiki>delete</nowiki></code> (<code><nowiki>create</nowiki></code>) - delete a specific occurrance of the specified object
 
* <code><nowiki>delete</nowiki></code> (<code><nowiki>create</nowiki></code>) - delete a specific occurrance of the specified object
Line 38: Line 67:
 
* <code><nowiki>unrescue</nowiki></code> (<code><nowiki>rescue</nowiki></code>) - return a server to normal boot mode
 
* <code><nowiki>unrescue</nowiki></code> (<code><nowiki>rescue</nowiki></code>) - return a server to normal boot mode
 
* <code><nowiki>unset</nowiki></code> (<code><nowiki>set</nowiki></code>) - remove an attribute of the object
 
* <code><nowiki>unset</nowiki></code> (<code><nowiki>set</nowiki></code>) - remove an attribute of the object
 +
 +
 +
== Objects ==
 +
 +
'''''Note: these need a review to sync up with the revised object names without dashes ('-') in them.'''''
 +
 +
* <code>access-token</code> - [[#Identity|Identity]] - OAuth [[#access-token|access-token]]
 +
* <code>agent</code> - [[#Compute|Compute]] - [[#agent|agent]]
 +
* <code>aggregate</code> - [[#Compute|Compute]] - [[#aggregate|aggregate]]
 +
* <code>bash-completion</code> - [[#Compute|Compute]] - [[#bash-completion|bash-completion]]
 +
* <code>catalog</code> - [[#Identity|Identity]] - [[#catalog|catalog]]
 +
* <code>cloudpipe</code> - [[#Compute|Compute]] - [[#cloudpipe|cloudpipe]]
 +
* <code>console</code> - [[#Compute|Compute]] - [[#console|console]]
 +
* <code>consumer</code> - [[#Identity|Identity]] - an OAuth [[#consumer|consumer]]
 +
* <code>credential</code> - [[#API_v3|Identity v3]] - [[#credential|credential]]
 +
* <code>credentials</code> - [[#Compute|Compute]] - [[#credentials|credentials]]
 +
* <code>diagnostics</code> - [[#Compute|Compute]] - [[#diagnostics|diagnostics]]
 +
* <code>dns</code> - [[#Compute|Compute]] - [[#dns|dns]]
 +
* <code>domain</code> - [[#API_v3|Identity v3]] - [[#domain|domain]]
 +
* <code>ec2-credentials</code> - [[#Identity|Identity]] - [[#ec2-credentials|ec2-credentials]]
 +
* <code>endpoint</code> - [[#Identity|Identity]] - [[#endpoint|endpoint]]
 +
* <code>endpoints</code> - [[#Compute|Compute]] - [[#endpoints|endpoints]]
 +
* <code>fixed-ip</code> - [[#Compute|Compute]] - [[#fixed-ip|fixed-ip]]
 +
* <code>flavor</code> - [[#Compute|Compute]] - [[#flavor|flavor]]
 +
* <code>floating-ip</code> - [[#Compute|Compute]] - [[#floating-ip|floating-ip]]
 +
* <code>floating-ip-pool</code> - [[#Compute|Compute]] - [[#floating-ip-pool|floating-ip-pool]]
 +
* <code>group</code> - [[#API_v3|Identity v3]] - [[#group|group]]
 +
* <code>host</code> - [[#Compute|Compute]] - [[#host|host]]
 +
* <code>hypervisor</code> - [[#Compute|Compute]] - [[#hypervisor|hypervisor]]
 +
* <code>keypair</code> - [[#Compute|Compute]] - [[#keypair|keypair]]
 +
* <code>limits</code> - [[#Compute|Compute]] - [[#limits|limits]]
 +
* <code>policy</code> - [[#API_v3|Identity v3]] - [[#policy|policy]]
 +
* <code>project</code> - [[#API_v3|Identity v3]] - [[#project|project]]
 +
* <code>quota</code> - [[#Compute|Compute]] - [[#quota|quota]]
 +
* <code>quota</code> - [[#Volume|Volume]] - [[#quota|quota]]
 +
* <code>request-token</code> - [[#Identity|Identity]] - OAuth [[#request-token|request-token]]
 +
* <code>role</code> - [[#Identity|Identity]] - [[#role|role]]
 +
* <code>secgroup</code> - [[#Compute|Compute]] - [[#secgroup|secgroup]]
 +
* <code>secgroup-group-rule</code> - [[#Compute|Compute]] - [[#secgroup-group-rule|secgroup-group-rule]]
 +
* <code>secgroup-rule</code> - [[#Compute|Compute]] - [[#secgroup-rule|secgroup-rule]]
 +
* <code>server</code> - [[#Compute|Compute]] - [[#server|server]]
 +
* <code>service</code> - [[#Identity|Identity]] - [[#service|service]]
 +
* <code>snapshot</code> - [[#Volume|Volume]] - [[#snapshot|snapshot]]
 +
* <code>tenant</code> - [[#API_v2.0|Identity v2.0]] - [[#tenant|tenant]]
 +
* <code>token</code> - [[#Identity|Identity]] - [[#token|token]]
 +
* <code>user</code> - [[#Identity|Identity]] - [[#user|user]]
 +
* <code>user role</code> - [[#Identity|Identity]] - [[#user-role|user-role]]
 +
* <code>volume</code> - [[#Volume|Volume]] - [[#volume|volume]]
 +
* <code>volume-type</code> - [[#Volume|Volume]] - [[#volume-type|volume-type]]
 +
  
 
== Global Options ==
 
== Global Options ==
Line 43: Line 122:
 
The common global options from the default [[OpenStack]] clients have been mapped to the set of global options below.
 
The common global options from the default [[OpenStack]] clients have been mapped to the set of global options below.
  
 
+
{| class="wikitable"
<pre><nowiki>#!csv ,
+
|-
Option, Environment Variable, , OSC Option, Environment Variable
+
! OSC Option !! Environment Variable !!  !! Option !! Environment Variable
--version,, ,--version,
+
|-
--help,, ,--help,
+
| --version ||  || || --version ||
--debug,, ,--debug,
+
|-
,, ,--quiet,
+
| --help ||  || || --help ||
,, ,--verbose
+
|-
,, ,--log-file <filename>,
+
| --debug ||  || || --debug ||
--os-auth-url <url>,OS_AUTH_URL, ,--os-auth-url,OS_AUTH_URL
+
|-
--os-tenant-name <name>,OS_TENANT_NAME, ,--os-tenant-name <name>,OS_TENANT_NAME
+
| --quiet ||  || ||  ||
--os-tenant-id <id>,OS_TENANT_ID, ,--os-tenant-id <id>,OS_TENANT_ID
+
|-
--os-username <name>,OS_USERNAME, ,--os-username <name>,OS_USERNAME
+
| --verbose ||  || ||  ||
--os-password <pw>,OS_PASSWORD, ,--os-password <pw>,OS_PASSWORD
+
|-
--os-region-name <region>,OS_REGION_NAME, ,--os-region-name <region>,OS_REGION_NAME
+
| --log-file <filename> ||  || ||  ||
--os-cacert <file>,OS_CACERT, ,--os-cacert <file>,OS_CACERT
+
|-
--insecure,, ,,
+
| --os-auth-url <url> || OS_AUTH_URL ||  || --os-auth-url <url> || OS_AUTH_URL
,, ,--os-use-keyring,
+
|-
</nowiki></pre>
+
| --os-tenant-name <name> || OS_TENANT_NAME ||  || --os-tenant-name <name> || OS_TENANT_NAME
 +
|-
 +
| --os-tenant-id <id> || OS_TENANT_ID ||  || --os-tenant-id <id> || OS_TENANT_ID
 +
|-
 +
| --os-username <name> || OS_USERNAME ||  || --os-username <name> || OS_USERNAME
 +
|-
 +
| --os-password <pw> || OS_PASSWORD ||  || --os-password <pw> || OS_PASSWORD
 +
|-
 +
| --os-region-name <region> || OS_REGION_NAME ||  || --os-region-name <region> || OS_REGION_NAME
 +
|-
 +
| --os-cacert <file> || OS_CACERT ||  || --os-cacert <file> || OS_CACERT
 +
|-
 +
|  ||  || || --insecure ||
 +
|-
 +
| --os-use-keyring ||  || ||  ||
 +
|}
  
  
Line 68: Line 162:
 
A number of options will appear in many commands and should have the same form in all commands to the extent possible.
 
A number of options will appear in many commands and should have the same form in all commands to the extent possible.
  
 
+
{| class="wikitable"
<pre><nowiki>#!csv ,
+
|-
Option, Description, Usual Default
+
! Option !! Description !! Usual Default
--description,describes an object, none
+
|-
--enable | --disable, Used for setting the enabled state for an object, n/a
+
| --description || describes an object || none
</nowiki></pre>
+
|-
 +
| --enable || Used for setting the enabled state for an object || n/a
 +
|-
 +
| --disable || Used for setting the enabled state for an object || n/a
 +
|}
  
  
Line 83: Line 181:
  
  
<pre><nowiki>#!csv ,
+
{| class="wikitable"
,
+
|-
nova x509-create-cert [<pk-file>] [<x509-cert>],os create credentials --x509 [<pk-file>] [<x509-cert>]
+
| nova x509-create-cert [<pk-file>] [<x509-cert>] || os create credentials --x509 [<pk-file>] [<x509-cert>]
nova credentials,os show credentials
+
|-
nova x509-get-root-cert,os show credentials --x509 --root
+
| nova credentials || os show credentials
</nowiki></pre>
+
|-
 +
| nova x509-get-root-cert || os show credentials --x509 --root
 +
|}
  
  
== Identity ==
+
== Cross API ==
  
 +
Object names that appear in multiple APIs, like quota, are handled by putting their command handler classes in openstackclient.common.  If the number of these becomes large they should be moved into a subdirectory.
  
<pre><nowiki>#!csv ,
+
==== credentials ====
Keystone Option, Environment Variable, , OSC Option, Environment Variable
 
--os-identity-api-version <ver>,OS_IDENTITY_API_VERSION, ,--os-identity-api-version <ver>,OS_IDENTITY_API_VERSION
 
--os-token <token>,OS_SERVICE_TOKEN , ,--os-token <token>,OS_TOKEN
 
--os-endpoint <url>,OS_SERVICE_ENDPOINT, ,--os-url <url>,OS_URL
 
--os-cert <file>,OS_CERT, ,,
 
--os-key <key-file>,OS_KEY, ,,
 
--os-cache,OS_CACHE, ,,
 
--force-new-token,, ,,
 
--stale-duration <seconds>,, ,,
 
</nowiki></pre>
 
  
 +
''[consider rolling the ec2 creds into this too]''
  
=== API v2.0 ===
+
{| class="wikitable"
 +
|-
 +
! OSC Command !! Implemented !! !! Keystone command
 +
|-
 +
|
 +
<source lang="bash">
 +
os credentials create
 +
    --x509
 +
    [<private-key-file>]
 +
    [<certificate-file>]
 +
</source>
 +
|| no
 +
|| ||
 +
<source lang="bash">
 +
nova x509-create-cert
 +
    [<pk-file>]
 +
    [<x509-cert>]
 +
</source>
 +
|-
 +
|
 +
<source lang="bash">
 +
os credentials show
 +
    [--token]
 +
    [--user]
 +
    [--x509 [--root]]
 +
</source>
 +
|| no
 +
|| ||
 +
<source lang="bash">
 +
nova credentials
 +
    [--wrap <integer>]
  
'''token'''
+
nova x509-get-root-cert
 +
    [<filename>]
 +
</source>
 +
|}
  
<pre><nowiki>#!bash
+
==== limits ====
keystone token-get [--wrap <integer>]
 
  
os show token [--width <pki-token-display-width>]
+
{| class="wikitable"
</nowiki></pre>
+
|-
 +
! OSC Command !! Implemented !! !! Keystone command
 +
|-
 +
|
 +
<source lang="bash">
 +
os limits show
 +
    --absolute [--reserved] | --rate
 +
</source>
 +
|| yes
 +
|| ||
 +
<source lang="bash">
 +
nova absolute-limits
 +
    [--reserved]
  
 +
nova rate-limits
  
'''catalog'''
+
cinder absolute-limits
  
<pre><nowiki>#!bash
+
cinder rate-limits
keystone catalog [--service <service-type>]
+
</source>
 +
|}
  
os show service [--catalog <service-type>]
+
==== quota ====
</nowiki></pre>
 
  
 +
{| class="wikitable"
 +
|-
 +
! OSC Command !! Implemented !! !! Keystone command
 +
|-
 +
|
 +
<source lang="bash">
 +
os quota set
 +
    # Compute settings
 +
    [--cores <num-cores>]
 +
    [--fixed-ips <num-fixed-ips>]
 +
    [--floating-ips <num-floating-ips>]
 +
    [--injected-file-size <injected-file-bytes>]
 +
    [--injected-files <num-injected-files>]
 +
    [--instances <num-instances>]
 +
    [--key-pairs <num-key-pairs>]
 +
    [--properties <num-properties>]
 +
    [--ram <ram-mb>]
  
'''ec2-credentials'''
+
    # Volume settings
 +
    [--gigabytes <new-gigabytes>]
 +
    [--snapshots <new-snapshots>]
 +
    [--volumes <new-volumes>]
  
<pre><nowiki>#!bash
+
    <project>
keystone ec2-credentials-create [--user <user-id>]  
+
</source>
                      [--tenant_id <tenant-id>]
+
|| yes
 +
|| ||
 +
<source lang="bash">
 +
nova quota-update
 +
    [--instances <instances>]
 +
    [--cores <cores>]
 +
    [--ram <ram>]
 +
    [--volumes <volumes>]
 +
    [--gigabytes <gigabytes>]
 +
    [--floating-ips <floating_ips>]
 +
    [--metadata-items <metadata_items>]
 +
    [--injected-files <injected_files>]
 +
    [--injected-file-content-bytes <injected_file_content_bytes>]
 +
    <tenant_id>
  
os create ec2-credentials --tenant_id <tenant-id> [--user <user-id>]
+
cinder quota-update
 +
    [--volumes <volumes>]
 +
    [--snapshots <snapshots>]
 +
    [--gigabytes <gigabytes>]
 +
    <tenant_id>
 +
</source>
 +
|-
 +
|
 +
<source lang="bash">
 +
os quota set
 +
    --class
 +
    # Compute settings
 +
    [--cores <num-cores>]
 +
    [--fixed-ips <num-fixed-ips>]
 +
    [--floating-ips <num-floating-ips>]
 +
    [--injected-file-size <injected-file-bytes>]
 +
    [--injected-files <num-injected-files>]
 +
    [--instances <num-instances>]
 +
    [--key-pairs <num-key-pairs>]
 +
    [--properties <num-properties>]
 +
    [--ram <ram-mb>]  
  
## are both args really optional?
+
    # Volume settings
</nowiki></pre>
+
    [--gigabytes <new-gigabytes>]
 +
    [--snapshots <new-snapshots>]
 +
    [--volumes <new-volumes>]
  
 +
    <class>
 +
</source>
 +
|| yes
 +
|| ||
 +
<source lang="bash">
 +
nova quota-class-update
 +
    [--instances <instances>]
 +
    [--cores <cores>]
 +
    [--ram <ram>]
 +
    [--volumes <volumes>]
 +
    [--gigabytes <gigabytes>]
 +
    [--floating-ips <floating_ips>]
 +
    [--metadata-items <metadata_items>]
 +
    [--injected-files <injected_files>]
 +
    [--injected-file-content-bytes <injected_file_content_bytes>]
 +
    <class>
  
<pre><nowiki>#!bash
+
cinder quota-class-update
keystone ec2-credentials-delete [--user <user-id>]
+
    [--volumes <volumes>]
                      --access <access-key>
+
    [--snapshots <snapshots>]
 +
    [--gigabytes <gigabytes>]
 +
    <tenant_id>
 +
</source>
 +
|-
 +
|
 +
<source lang="bash">
 +
os quota show
 +
    [--default]
 +
    <project>
 +
</source>
 +
|| yes
 +
|| ||
 +
<source lang="bash">
 +
nova quota-show
 +
    [--tenant <tenant-id>]
  
os delete ec2-credentials <access-key>
+
cinder quota-show
 +
    <tenant_id>
  
## what changes if --user is not provided?
+
nova quota-defaults
</nowiki></pre>
+
    <tenant_id>
  
 +
cinder quota-defaults
 +
    <tenant_id>
 +
</source>
 +
|-
 +
|
 +
<source lang="bash">
 +
os quota show
 +
    --class
 +
    <class>
 +
</source>
 +
|| yes
 +
|| ||
 +
<source lang="bash">
 +
nova quota-class-show
 +
    <class>
  
<pre><nowiki>#!bash
+
cinder quota-class-show
keystone ec2-credentials-get [--user <user-id>]
+
    <class>
                            --access <access-key>
+
</source>
 +
|}
  
os show ec2-credentials <access-key>
+
== Identity ==
  
## what changes if --user is not provided?
+
{| class="wikitable"
</nowiki></pre>
+
|-
 +
! OSC Option !!  Environment Variable !!  !!  Keystone Option !!  Environment Variable
 +
|-
 +
| --os-identity-api-version <ver> || OS_IDENTITY_API_VERSION ||  || --os-identity-api-version <ver> || OS_IDENTITY_API_VERSION
 +
|-
 +
| --os-token <token> || OS_TOKEN || || --os-token <token> || OS_SERVICE_TOKEN
 +
|-
 +
| --os-url <url> || OS_URL || || --os-endpoint <url> || OS_SERVICE_ENDPOINT
 +
|-
 +
|  ||  || || --os-cert <file> || OS_CERT
 +
|-
 +
|  ||  || || --os-key <key-file> || OS_KEY
 +
|-
 +
|  ||  || || --os-cache || OS_CACHE
 +
|-
 +
|  ||  || || --force-new-token ||
 +
|-
 +
|  ||  || || --stale-duration <seconds> ||
 +
|-
 +
|}
  
 +
=== API v2.0 ===
  
<pre><nowiki>#!bash
+
==== catalog ====
keystone ec2-credentials-list [--user <user-id>]
 
 
 
os list ec2-credentials [--user <user-id>]
 
</nowiki></pre>
 
 
 
  
'''endpoint'''
+
{| class="wikitable"
 +
|-
 +
! OSC Command !! Implemented !! !! Keystone command
 +
|-
 +
|
 +
<source lang="bash">
 +
os catalog show
 +
    [--service <service>]
 +
</source>
 +
|| no
 +
|| ||
 +
<source lang="bash">
 +
keystone catalog
 +
    [--service <service-type>]
 +
</source>
 +
|}
  
<pre><nowiki>#!bash
+
==== ec2 credentials ====
keystone endpoint-create [--region <endpoint-region>]
 
                        [--service_id <service-id>]
 
                        [--publicurl <public-url>]
 
                        [--adminurl <admin-url>]
 
                        [--internalurl <internal-url>]
 
  
os create endpoint
+
{| class="wikitable"
        [--region <endpoint-region>]
+
|-
        [--publicurl <public-url>]
+
! OSC Command !! Implemented !! !! Keystone command
        [--adminurl <admin-url>]
+
|-
        [--internalurl <internal-url>]
+
|
        <service>
+
<source lang="bash">
</nowiki></pre>
+
os ec2 credentials create
 +
    [--project <project>]
 +
    [--user <user>]
 +
</source>
 +
|| yes
 +
|| ||
 +
<source lang="bash">
 +
keystone ec2-credentials-create
 +
    [--user <user-id>]  
 +
    [--tenant_id <tenant-id>]
 +
</source>
 +
|-
 +
|
 +
<source lang="bash">
 +
os ec2 credentials delete
 +
    [--user <user>]
 +
    <access-key>
 +
</source>
 +
|| yes
 +
|| ||
 +
<source lang="bash">
 +
keystone ec2-credentials-delete
 +
    [--user <user-id>]  
 +
    --access <access-key>
 +
</source>
 +
|-
 +
|
 +
<source lang="bash">
 +
os ec2 credentials list
 +
    [--user <user>]
 +
</source>
 +
|| yes
 +
|| ||
 +
<source lang="bash">
 +
keystone ec2-credentials-list
 +
    [--user <user-id>]
 +
</source>
 +
|-
 +
|
 +
<source lang="bash">
 +
os ec2 credentials show
 +
    [--user <user>]
 +
    <access-key>
 +
</source>
 +
|| yes
 +
|| ||
 +
<source lang="bash">
 +
keystone ec2-credentials-get
 +
    [--user <user-id>]
 +
    --access <access-key>
 +
</source>
 +
|}
  
 +
==== endpoint ====
  
<pre><nowiki>#!bash
+
{| class="wikitable"
keystone endpoint-delete <endpoint-id>
+
|-
 
+
! OSC Command !! Implemented !! !! Keystone command
os delete endpoint <endpoint-id>
+
|-
</nowiki></pre>
+
|
 
+
<source lang="bash">
 
+
os endpoint create
<pre><nowiki>#!bash
+
    --publicurl <public-url>
keystone endpoint-get --service <service-type>
+
    [--adminurl <admin-url>]
                      [--endpoint_type <endpoint-type>]
+
    [--internalurl <internal-url>]
                      [--attr <service-attribute>]  
+
    [--region <endpoint-region>]
                      [--value <value>]
+
    <service>
 
+
</source>
os show endpoint
+
|| yes
        [--type <endpoint-type>]
+
|| ||
        [--attr <endpoint-attribute>]  
+
<source lang="bash">
        [--value <endpoint-value>]
+
keystone endpoint-create
        <service>
+
    [--region <endpoint-region>]
 
+
    [--service_id <service-id>]
os show endpoint
+
    [--publicurl <public-url>]
        [--all]
+
    [--adminurl <admin-url>]
        <service>
+
    [--internalurl <internal-url>]
</nowiki></pre>
+
</source>
 
+
|-
 
+
|
<pre><nowiki>#!bash
+
<source lang="bash">
 +
os endpoint delete
 +
    <endpoint-id>
 +
</source>
 +
|| yes
 +
|| ||
 +
<source lang="bash">
 +
keystone endpoint-delete
 +
    <endpoint-id>
 +
</source>
 +
|-
 +
|
 +
<source lang="bash">
 +
os endpoint list
 +
    [--long]
 +
</source>
 +
|| yes
 +
|| ||
 +
<source lang="bash">
 
keystone endpoint-list
 
keystone endpoint-list
 +
</source>
 +
|-
 +
|
 +
<source lang="bash">
 +
os endpoint show
 +
    [--type <endpoint-type>]
 +
    [--attr <endpoint-attribute>]
 +
    [--value <endpoint-value>]
 +
    [--all]
 +
    <service-type>
 +
</source>
 +
|| yes
 +
|| ||
 +
<source lang="bash">
 +
keystone endpoint-get
 +
    --service <service-type>
 +
    [--endpoint_type <endpoint-type>]
 +
    [--attr <service-attribute>]
 +
    [--value <value>]
 +
</source>
 +
|}
  
os list endpoint [--long]
+
==== role ====
</nowiki></pre>
 
  
 
+
{| class="wikitable"
'''role'''
+
|-
 
+
! OSC Command !! Implemented !! !! Keystone command
<pre><nowiki>#!bash
+
|-
keystone role-create --name <role-name>
+
|
 
+
<source lang="bash">
os create role <role-name>
+
os role create
</nowiki></pre>
+
    <role-name>
 
+
</source>
 
+
|| yes
<pre><nowiki>#!bash
+
|| ||
keystone role-delete <role-id>
+
<source lang="bash">
 
+
keystone role-create --name
os delete role <role>
+
    <role-name>
</nowiki></pre>
+
</source>
 
+
|-
 
+
|
<pre><nowiki>#!bash
+
<source lang="bash">
keystone role-get <role-id>
+
os role delete
 
+
    <role>
os show role <role>
+
</source>
</nowiki></pre>
+
|| yes
 
+
|| ||
 
+
<source lang="bash">
<pre><nowiki>#!bash
+
keystone role-delete
 +
    <role-id>
 +
</source>
 +
|-
 +
|
 +
<source lang="bash">
 +
os role list
 +
</source>
 +
|| yes
 +
|| ||
 +
<source lang="bash">
 
keystone role-list
 
keystone role-list
 +
</source>
 +
|-
 +
|
 +
<source lang="bash">
 +
os role show
 +
    <role>
 +
</source>
 +
|| yes
 +
|| ||
 +
<source lang="bash">
 +
keystone role-get
 +
    <role-id>
 +
</source>
 +
|}
  
os list role
+
==== service ====
</nowiki></pre>
 
  
 
+
{| class="wikitable"
'''service'''
+
|-
 
+
! OSC Command !! Implemented !! !! Keystone command
<pre><nowiki>#!bash
+
|-
keystone service-create --name <name>
+
|
                        --type <type>
+
<source lang="bash">
                        [--description <service-description>]
+
os service create
 
+
    [--type <service-type>]
os create service
+
    [--description <service-description>]
        [--type <service-type>]
+
    <service-name>
        [--description <service-description>]
+
</source>
        <service-name>
+
|| yes
</nowiki></pre>
+
|| ||
 
+
<source lang="bash">
 
+
keystone service-create
<pre><nowiki>#!bash
+
    --name <name>  
keystone service-delete <service-id>
+
    --type <type>
 
+
    [--description <service-description>]
os delete service <service>
+
</source>
</nowiki></pre>
+
|-
 
+
|
 
+
<source lang="bash">
<pre><nowiki>#!bash
+
os service delete
keystone service-get <service-id>
+
    <service>
 
+
</source>
os show service <service>
+
|| yes
</nowiki></pre>
+
|| ||
 
+
<source lang="bash">
 
+
keystone service-delete
<pre><nowiki>#!bash
+
    <service-id>
 +
</source>
 +
|-
 +
|
 +
<source lang="bash">
 +
os service list
 +
    [--long]
 +
</source>
 +
|| yes
 +
|| ||
 +
<source lang="bash">
 
keystone service-list
 
keystone service-list
 +
</source>
 +
|-
 +
|
 +
<source lang="bash">
 +
os service show
 +
    [--catalog]
 +
    <service>
 +
</source>
 +
|| yes
 +
|| ||
 +
<source lang="bash">
 +
keystone service-get
 +
    <service-id>
 +
</source>
 +
|}
  
os list service [--long]
+
==== tenant ====
</nowiki></pre>
 
  
 
+
{| class="wikitable"
'''tenant'''
+
|-
 
+
! OSC Command !! Implemented !! !! Keystone command
<pre><nowiki>#!bash
+
|-
keystone tenant-create --name <tenant-name>
+
|
                      [--description <tenant-description>]
+
<source lang="bash">
                      [--enabled <true|false>]
+
os tenant create
 
+
    [--description <description>]
os create tenant
+
    [--enable | --disable]
        [--description <tenant-description>]
+
    <tenant-name>
        [--enable | --disable]
+
</source>
        <tenant-name>
+
|| yes
</nowiki></pre>
+
|| ||
 
+
<source lang="bash">
 
+
keystone tenant-create
<pre><nowiki>#!bash
+
    --name <tenant-name>
keystone tenant-delete <tenant-id>
+
    [--description <tenant-description>]
 
+
    [--enabled <true|false>]
os delete tenant <tenant>
+
</source>
</nowiki></pre>
+
|-
 
+
|
 
+
<source lang="bash">
<pre><nowiki>#!bash
+
os tenant delete
keystone tenant-get <tenant-id>
+
    <tenant>
 
+
</source>
os show tenant <tenant>
+
|| yes
</nowiki></pre>
+
|| ||
 
+
<source lang="bash">
 
+
keystone tenant-delete
<pre><nowiki>#!bash
+
    <tenant>
 +
</source>
 +
|-
 +
|
 +
<source lang="bash">
 +
os tenant list
 +
    [--long]
 +
</source>
 +
|| yes
 +
|| ||
 +
<source lang="bash">
 
keystone tenant-list
 
keystone tenant-list
 
+
</source>
os list tenant [--long]
+
|-
</nowiki></pre>
+
|
 
+
<source lang="bash">
 
+
os tenant set
<pre><nowiki>#!bash
+
    [--name <new-tenant-name>]
 +
    [--description <new-tenant-description>]
 +
    [--enable | --disable]
 +
    <tenant>
 +
</source>
 +
|| yes
 +
|| ||
 +
<source lang="bash">
 
keystone tenant-update
 
keystone tenant-update
        [--name <tenant_name>]
+
    [--name <tenant_name>]
        [--description <tenant-description>]
+
    [--description <tenant-description>]
        [--enabled <true|false>]
+
    [--enabled <true|false>]
        <tenant-id>
+
    <tenant-id>
 +
</source>
 +
|-
 +
|
 +
<source lang="bash">
 +
os tenant show
 +
    <tenant>
 +
</source>
 +
|| yes
 +
|| ||
 +
<source lang="bash">
 +
keystone tenant-get
 +
    <tenant-id>
 +
</source>
 +
|}
  
os set tenant
+
==== token ====
        [--name <new-tenant-name>]
 
        [--description <new-tenant-description>]
 
        [--enable | --disable]
 
        <tenant>
 
</nowiki></pre>
 
  
 +
{| class="wikitable"
 +
|-
 +
! OSC Command !! Implemented !! !! Keystone command
 +
|-
 +
|
 +
<source lang="bash">
 +
os token show
 +
    [--width <token-display-width>]
 +
</source>
 +
|| ??
 +
|| ||
 +
<source lang="bash">
 +
keystone token-get [--wrap <integer>]
 +
</source>
 +
|}
  
'''user'''
+
==== user ====
 
 
<pre><nowiki>#!bash
 
keystone user-create --name <user-name>
 
                    [--tenant_id <tenant-id>]
 
                    [--pass <pass>]
 
                    [--email <email>]
 
                    [--enabled <true|false>]
 
 
 
os create user
 
        [--password <user-password>]
 
        [--email <user-email>]
 
        [--tenant <tenant>]
 
        [--enable | --disable]
 
        <user-name>
 
</nowiki></pre>
 
 
 
 
 
<pre><nowiki>#!bash
 
keystone user-delete <user-id>
 
 
 
os delete user <user>
 
</nowiki></pre>
 
 
 
 
 
<pre><nowiki>#!bash
 
keystone user-get <user-id>
 
 
 
os show user <user>
 
</nowiki></pre>
 
 
 
 
 
<pre><nowiki>#!bash
 
keystone user-list [<tenant-id>]
 
 
 
os list user [--tenant <tenant>] [--long]
 
</nowiki></pre>
 
 
 
 
 
<pre><nowiki>#!bash
 
keystone user-password-update --pass <password> <user-id>
 
 
 
os set user
 
        [--name <new-user-name>]
 
        [--password <user-password>]
 
        [--email <user-email>]
 
        [--tenant <tenant>]
 
        [--enable|--disable]
 
        <user>
 
</nowiki></pre>
 
 
 
 
 
'''user-role'''
 
 
 
<pre><nowiki>#!bash
 
keystone user-role-add --user <user-id>
 
                      --role <role-id>
 
                      [--tenant_id <tenant-id>]
 
  
os add role-user
+
{| class="wikitable"
        [--tenant <tenant>]
+
|-
        <role> <user>
+
! OSC Command !! Implemented !! !! Keystone command
</nowiki></pre>
+
|-
 +
|
 +
<source lang="bash">
 +
os user create
 +
    [--password <user-password>]
 +
    [--email <user-email>]
 +
    [--tenant <tenant>]
 +
    [--enable | --disable]
 +
    <user-name>
 +
</source>
 +
|| yes
 +
|| ||
 +
<source lang="bash">
 +
keystone user-create
 +
    --name <user-name>
 +
    [--tenant_id <tenant-id>]
 +
    [--pass <pass>]
 +
    [--email <email>]
 +
    [--enabled <true|false>]
 +
</source>
 +
|-
 +
|
 +
<source lang="bash">
 +
os user delete
 +
    <user>
 +
</source>
 +
|| yes
 +
|| ||
 +
<source lang="bash">
 +
keystone user-delete
 +
    <user-id>
 +
</source>
 +
|-
 +
|
 +
<source lang="bash">
 +
os user list
 +
    [--tenant <tenant>]
 +
    [--long]
 +
</source>
 +
|| yes
 +
|| ||
 +
<source lang="bash">
 +
keystone user-list
 +
    [<tenant-id>]
 +
</source>
 +
|-
 +
|
 +
<source lang="bash">
 +
os user set
 +
    [--name <new-user-name>]
 +
    [--password <user-password>]
 +
    [--email <user-email>]
 +
    [--tenant <tenant>]
 +
    [--enable|--disable]
 +
    <user>
 +
</source>
 +
|| yes
 +
|| ||
 +
<source lang="bash">
 +
keystone user-password-update
 +
    --pass <password>
 +
    <user-id>
 +
</source>
 +
|-
 +
|
 +
<source lang="bash">
 +
os user show
 +
    <user>
 +
</source>
 +
|| yes
 +
|| ||
 +
<source lang="bash">
 +
keystone user-get
 +
    <user-id>
 +
</source>
 +
|}
  
 +
==== user role ====
  
<pre><nowiki>#!bash
+
{| class="wikitable"
keystone user-role-list [--user <user-id>]  
+
|-
                  [--tenant_id <tenant-id>]
+
! OSC Command !! Implemented !! !! Keystone command
 +
|-
 +
|
 +
<source lang="bash">
 +
os user role add
 +
    [--tenant <tenant>]
 +
    <user>
 +
    <role>
 +
</source>
 +
|| yes
 +
|| ||
 +
<source lang="bash">
 +
keystone user-role-add
 +
    --user <user-id>
 +
    --role <role-id>
 +
    [--tenant_id <tenant-id>]
 +
</source>
 +
|-
 +
|
 +
<source lang="bash">
 +
os user role list
 +
    [--tenant <tenant>]
 +
    [<user>]
 +
</source>
 +
|| yes
 +
|| ||
 +
<source lang="bash">
 +
keystone user-role-list
 +
    [--user <user-id>]
 +
    [--tenant_id <tenant-id>]
 +
</source>
 +
|-
 +
|
 +
<source lang="bash">
 +
os user role remove
 +
    [--tenant <tenant>]
 +
    <user>
 +
    <role>
 +
</source>
 +
|| yes
 +
|| ||
 +
<source lang="bash">
 +
keystone user-role-remove
 +
    --user <user-id>
 +
    --role <role-id>
 +
    [--tenant_id <tenant-id>]
 +
</source>
 +
|}
  
os list role-user
+
==== <other> ====
        [--tenant <tenant>]
 
        [<user>]
 
</nowiki></pre>
 
  
 +
These keystone commands are not planned for re-implementation in OpenStackClient
  
<pre><nowiki>#!bash
+
<source lang="bash">
keystone user-role-remove --user <user-id>
 
                          --role <role-id>
 
                          [--tenant_id <tenant-id>]
 
 
 
os remove role-user
 
        [--tenant <tenant>]
 
        <role> <user>
 
</nowiki></pre>
 
 
 
 
 
'''<other>'''
 
 
 
<pre><nowiki>#!bash
 
 
keystone bootstrap
 
keystone bootstrap
 
         --pass <password>
 
         --pass <password>
Line 425: Line 919:
 
         [--role-name <role-name>]
 
         [--role-name <role-name>]
 
         [--tenant-name <tenant-name>]
 
         [--tenant-name <tenant-name>]
 +
</source>
  
##TBD
+
<source lang="bash">
</nowiki></pre>
 
 
 
 
 
 
 
<pre><nowiki>#!bash
 
 
keystone discover
 
keystone discover
 
+
</source>
##TBD
 
</nowiki></pre>
 
 
 
  
 
=== API v3 ===
 
=== API v3 ===
  
'''credential'''
+
==== credential ====
  
<pre><nowiki>#!bash
+
{| class="wikitable"
keystone credential-create --user_id <user-id>
+
|-
                      --type <credential-type>
+
! OSC Command !! Implemented !! !! Keystone command
                      --data <credential-data>
+
|-
                      [--project_id <project-id>]
+
|
 
+
<source lang="bash">
os create credential
+
os credential create
        [--project <project>]
+
    [--project <project>]
        <user>
+
    [--type ec2|cert]
        <type>
+
    <user>
        <data>
+
    <data>
</nowiki></pre>
+
</source>
 
+
|| yes
 
+
|| ||
<pre><nowiki>#!bash
+
<source lang="bash">
keystone credential-delete <credential-id>
+
keystone credential-create
 
+
    --user_id <user-id>
os delete credential <credential-id>
+
    --type <credential-type>
</nowiki></pre>
+
    --data <credential-data>
 
+
    [--project_id <project-id>]
 
+
</source>
<pre><nowiki>#!bash
+
|-
keystone credential-get <credential-id>
+
|
 
+
<source lang="bash">
os show credential <credential-id>
+
os credential delete
</nowiki></pre>
+
    <credential-id>
 
+
</source>
 
+
|| yes
<pre><nowiki>#!bash
+
|| ||
 +
<source lang="bash">
 +
keystone credential-delete
 +
    <credential-id>
 +
</source>
 +
|-
 +
|
 +
<source lang="bash">
 +
os credential list
 +
</source>
 +
|| yes
 +
|| ||
 +
<source lang="bash">
 
keystone credential-list
 
keystone credential-list
 
+
</source>
os list credential [--long]
+
|-
</nowiki></pre>
+
|
 
+
<source lang="bash">
 
+
os credential set
<pre><nowiki>#!bash
+
    [--user <user>]
 +
    [--type ec2|cert]
 +
    [--data <data>]
 +
    [--project <project>]
 +
    <credential-id>
 +
</source>
 +
|| yes
 +
|| ||
 +
<source lang="bash">
 
keystone credential-update
 
keystone credential-update
        [--user <user>]
+
    [--user <user>]
        [--type <type>]
+
    [--type <type>]
        [--data <data>]
+
    [--data <data>]
        [--project <project>]
+
    [--project <project>]
        <credential-id>
+
    <credential-id>
 
+
</source>
os set credential
+
|-
        [--user <user>]
+
|
        [--type <type>]
+
<source lang="bash">
        [--data <data>]
+
os credential show
        [--project <project>]
+
    <credential-id>
        <credential-id>
+
</source>
</nowiki></pre>
+
|| yes
 
+
|| ||
 
+
<source lang="bash">
'''domain'''
+
keystone credential-get
 
+
    <credential-id>
<pre><nowiki>#!bash
+
</source>
keystone domain-create --name <domain-name>
+
|}
                      [--description <domain-description>]
 
                      [--enabled <true|false>]
 
                      [--private_project_names <true|false>]
 
                      [--private_user_names <true|false>]
 
 
 
os create domain
 
        [--description <domain-description>]
 
        [--enable | --disable]
 
        [--private_project_names]
 
        [--private_user_names]
 
        <domain-name>
 
</nowiki></pre>
 
  
 +
==== domain ====
  
<pre><nowiki>#!bash
+
{| class="wikitable"
keystone domain-delete <domain-id>
+
|-
 
+
! OSC Command !! Implemented !! !! Keystone command
os delete domain <domain>
+
|-
</nowiki></pre>
+
|
 
+
<source lang="bash">
 
+
os domain create
<pre><nowiki>#!bash
+
    [--description <domain-description>]
keystone domain-get <domain-id>
+
    [--enable | --disable]
 
+
    <domain-name>
os show domain <domain>
+
</source>
</nowiki></pre>
+
|| yes
 
+
|| ||
 
+
<source lang="bash">
<pre><nowiki>#!bash
+
keystone domain-create
 +
    --name <domain-name>
 +
    [--description <domain-description>]
 +
    [--enabled <true|false>]
 +
    [--private_project_names <true|false>]
 +
    [--private_user_names <true|false>]
 +
</source>
 +
|-
 +
|
 +
<source lang="bash">
 +
os domain delete
 +
    <domain>
 +
</source>
 +
|| yes
 +
|| ||
 +
<source lang="bash">
 +
keystone domain-delete
 +
    <domain-id>
 +
</source>
 +
|-
 +
|
 +
<source lang="bash">
 +
os domain list
 +
</source>
 +
|| yes
 +
|| ||
 +
<source lang="bash">
 
keystone domain-list
 
keystone domain-list
 
+
</source>
os list domain [--long]
+
|-
</nowiki></pre>
+
|
 
+
<source lang="bash">
 
+
os domain set
<pre><nowiki>#!bash
+
    [--name <new-domain-name>]
 +
    [--description <new-domain-description>]
 +
    [--enable | --disable]
 +
    <domain>
 +
</source>
 +
|| yes
 +
|| ||
 +
<source lang="bash">
 
keystone domain-update
 
keystone domain-update
        [--name <domain_name>]
+
    [--name <domain_name>]
        [--description <domain-description>]
+
    [--description <domain-description>]
        [--enabled <true|false>]
+
    [--enabled <true|false>]
        [--private_project_names <true|false>]
+
    [--private_project_names <true|false>]
        [--private_user_names <true|false>]
+
    [--private_user_names <true|false>]
        <domain-id>
+
    <domain-id>
 +
</source>
 +
|-
 +
|
 +
<source lang="bash">
 +
os domain show
 +
    <domain>
 +
</source>
 +
|| yes
 +
|| ||
 +
<source lang="bash">
 +
keystone domain-get
 +
    <domain-id>
 +
</source>
 +
|}
  
os set domain
+
==== endpoint ====
        [--name <new-domain-name>]
 
        [--description <new-domain-description>]
 
        [--private_project_names]
 
        [--private_user_names]
 
        [--enable | --disable]
 
        <domain>
 
</nowiki></pre>
 
  
 
+
{| class="wikitable"
'''endpoint'''
+
|-
 
+
! OSC Command !! Implemented !! !! Keystone command
<pre><nowiki>#!bash
+
|-
keystone endpoint-create --service_id <service-id>
+
|
--interface <endpoint-interface>
+
<source lang="bash">
--url <endpoint-url>
+
os endpoint create
[--region <endpoint-region>]
+
    [--region <endpoint-region>
                        [--enabled <true|false>]
+
    [--enable | --disable]
 
+
    <service>
os create endpoint
+
    <interface admin|public|internal>
[--region <endpoint-region>]
+
    <url>
        [--enabled <true|false>]
+
</source>
<service-id>  
+
|| yes
<endpoint-interface>
+
|| ||
<endpoint-url>
+
<source lang="bash">
       
+
keystone endpoint-create  
</nowiki></pre>
+
    [--region <endpoint-region>
 
+
    [--enable | --disable]
 
+
    <service_id>
<pre><nowiki>#!bash
+
    <interface admin|public|internal>
keystone endpoint-delete <endpoint-id>
+
    <url>
 
+
</source>
os delete endpoint <endpoint-id>
+
|-
</nowiki></pre>
+
|
 
+
<source lang="bash">
 
+
os endpoint delete
<pre><nowiki>#!bash
+
    <endpoint-id>
 +
</source>
 +
|| yes
 +
|| ||
 +
<source lang="bash">
 +
</source>
 +
|-
 +
|
 +
<source lang="bash">
 +
os endpoint list
 +
    [--long]
 +
</source>
 +
|| yes
 +
|| ||
 +
<source lang="bash">
 
keystone endpoint-list
 
keystone endpoint-list
 +
</source>
 +
|-
 +
|
 +
<source lang="bash">
 +
os endpoint set
 +
    [--interface <endpoint-interface>]
 +
    [--url <endpoint-url>]
 +
    [--service <service-id>]
 +
    [--region <endpoint-region>]
 +
    [--enable | --disable]
 +
    <endpoint>
 +
</source>
 +
|| yes
 +
|| ||
 +
<source lang="bash">
 +
keystone endpoint-set
 +
    [--interface <endpoint-interface>]
 +
    [--url <endpoint-url>]
 +
    [--service <service-id>]
 +
    [--region <endpoint-region>]
 +
    [--enable | --disable]
 +
    <endpoint>
 +
</source>
 +
|-
 +
|
 +
<source lang="bash">
 +
os endpoint show
 +
    <endpoint>
 +
</source>
 +
|| yes
 +
|| ||
 +
<source lang="bash">
 +
keystone endpoint-get
 +
    <endpoint>
 +
</source>
 +
|}
  
os list endpoint [--long]
+
==== group ====
</nowiki></pre>
 
 
 
 
 
<pre><nowiki>#!bash
 
keystone enpoint-get <endpoint-id>
 
 
 
os show endpoint <endpoint-id>
 
</nowiki></pre>
 
 
 
 
 
<pre><nowiki>#!bash
 
keystone endpoint-update --endpoint_id <endpoint-id>
 
[--region <endpoint-region>]
 
        [--enabled <true|false>]
 
[<service-id>]
 
[<endpoint-interface>]
 
[<endpoint-url>]
 
 
 
os update endpoint
 
[--region <endpoint-region>]
 
        [--enabled <true|false>]
 
[--service <service-id>]
 
[--interface <endpoint-interface>]
 
[--url <endpoint-url>]
 
        <endpoint-id>
 
</nowiki></pre>
 
  
 
+
{| class="wikitable"
'''group'''
+
|-
 
+
! OSC Command !! Implemented !! !! Keystone command
<pre><nowiki>#!bash
+
|-
keystone group-create --name <group-name>
+
|
                      [--domain_id <domain-id>]
+
<source lang="bash">
                      [--description <group-description>]
+
os group create
 
+
    [--domain <domain>]
os create group
+
    [--description <group-description>]
        [--domain <domain>]
+
    <group-name>
        [--description <group-description>]
+
</source>
        <group-name>
+
|| yes
</nowiki></pre>
+
|| ||
 
+
<source lang="bash">
 
+
keystone group-create
<pre><nowiki>#!bash
+
    --name <group-name>
keystone group-delete <group-id>
+
    [--domain_id <domain-id>]
 
+
    [--description <group-description>]
os delete group <group>
+
</source>
</nowiki></pre>
+
|-
 
+
|
 
+
<source lang="bash">
<pre><nowiki>#!bash
+
os group delete
keystone group-get <group-id>
+
    <group>
 
+
</source>
os show group <group>
+
|| yes
</nowiki></pre>
+
|| ||
 
+
<source lang="bash">
 
+
keystone group-delete
<pre><nowiki>#!bash
+
    <group-id>
 +
</source>
 +
|-
 +
|
 +
<source lang="bash">
 +
os group list
 +
    [--long]
 +
</source>
 +
|| yes
 +
|| ||
 +
<source lang="bash">
 
keystone group-list
 
keystone group-list
 
+
</source>
os list group [--long]
+
|-
</nowiki></pre>
+
|
 
+
<source lang="bash">
 
+
os group set
<pre><nowiki>#!bash
+
    [--name <new-group-name>]
 +
    [--domain <domain>]
 +
    [--description <new-group-description>]
 +
    <group>
 +
</source>
 +
|| yes
 +
|| ||
 +
<source lang="bash">
 
keystone group-update
 
keystone group-update
        [--name <group_name>]
+
    [--name <group_name>]
        [--domain_id <domain-id>]
+
    [--domain_id <domain-id>]
        [--description <group-description>]
+
    [--description <group-description>]
        <group-id>
+
    <group-id>
 
+
</source>
os set group
+
|-
        [--name <new-group-name>]
+
|
        [--domain <domain>]
+
<source lang="bash">
        [--description <new-group-description>]
+
os group show
        <group>
+
    <group>
</nowiki></pre>
+
</source>
 
+
|| yes
 
+
|| ||
'''policy'''
+
<source lang="bash">
 
+
keystone group-get
<pre><nowiki>#!bash
+
    <group-id>
keystone policy-create --type <policy-type>
+
</source>
                      --blob <policy-blob>
+
|}
 
 
os create policy
 
        --type <policy-type>
 
        --blob <policy-blob>
 
</nowiki></pre>
 
 
 
  
<pre><nowiki>#!bash
+
==== oauth ====
keystone policy-delete <policy-id>
 
  
os delete policy <policy-id>
+
{| class="wikitable"
</nowiki></pre>
+
|-
 +
! OSC Command !! Implemented !! !! Keystone command
 +
|-
 +
|
 +
<source lang="bash">
 +
os access token create
 +
    --consumer-key <consumer-key>
 +
    --consumer-secret <consumer-secret>
 +
    --request-key <request-key>
 +
    --request-secret <request-secret>
 +
    --verifier <pin>
 +
</source>
 +
|| yes
 +
|| ||
 +
<source lang="bash">
 +
n/a
 +
</source>
 +
|-
 +
| look at some alternatives: || || ||
 +
|-
 +
|
 +
<source lang="bash">
 +
os oauth token create
 +
    --consumer-key <consumer-key>
 +
    --consumer-secret <consumer-secret>
 +
    --request-key <request-key>
 +
    --request-secret <request-secret>
 +
    --verifier <pin>
 +
</source>
 +
|| nyet
 +
|| ||
 +
<source lang="bash">
 +
* makes the token specific to oauth
 +
* add [--oauth-ver X] if versioning for oauth2 is an issue?
 +
</source>
 +
|-
 +
|
 +
<source lang="bash">
 +
os oauth token create
 +
    --access
 +
    --consumer-key <consumer-key>
 +
    --consumer-secret <consumer-secret>
 +
    --request-key <request-key>
 +
    --request-secret <request-secret>
 +
    --verifier <pin>
  
 +
os oauth token create
 +
    --request
 +
    --consumer-key <consumer-key>
 +
    --roles <roles>
 +
</source>
 +
|| nyet
 +
|| ||
 +
<source lang="bash">
 +
* collapse 'access token' and 'request token' into 'oauth token'?
 +
</source>
 +
|}
  
<pre><nowiki>#!bash
+
==== policy ====
keystone policy-get <policy-id>
 
  
os show policy <policy-id>
+
{| class="wikitable"
</nowiki></pre>
+
|-
 
+
! OSC Command !! Implemented !! !! Keystone command
 
+
|-
<pre><nowiki>#!bash
+
|
 +
<source lang="bash">
 +
os policy create
 +
    [--type <policy-type>]
 +
    --blob-file <blob-file>
 +
</source>
 +
|| yes
 +
|| ||
 +
<source lang="bash">
 +
keystone policy-create
 +
    --type <policy-type>
 +
    --blob <policy-blob>
 +
</source>
 +
|-
 +
|
 +
<source lang="bash">
 +
os policy delete
 +
    <policy-id>
 +
</source>
 +
|| yes
 +
|| ||
 +
<source lang="bash">
 +
keystone policy-delete
 +
    <policy-id>
 +
</source>
 +
|-
 +
|
 +
<source lang="bash">
 +
os policy list
 +
    [--include-blob]
 +
</source>
 +
|| yes
 +
|| ||
 +
<source lang="bash">
 
keystone policy-list
 
keystone policy-list
 
+
</source>
os list policy [--long]
+
|-
</nowiki></pre>
+
|
 
+
<source lang="bash">
 
+
os policy set
<pre><nowiki>#!bash
+
    [--type <policy-type>]
 +
    [--blob-file<blob-file>]
 +
    <policy-id>
 +
</source>
 +
|| yes
 +
|| ||
 +
<source lang="bash">
 
keystone policy-update
 
keystone policy-update
        [--type <policy-type>]
+
    [--type <policy-type>]
        [--blob <policy-blob>]
+
    [--blob <policy-blob>]
        <policy-id>
+
    <policy-id>
 
+
</source>
os set policy
+
|-
        [--type <policy-type>]
+
|
        [--blob <policy-blob>]
+
<source lang="bash">
        <policy-id>
+
os policy show
</nowiki></pre>
+
    <policy-id>
 
+
</source>
 
+
|| yes
'''project'''
+
|| ||
 
+
<source lang="bash">
<pre><nowiki>#!bash
+
keystone policy-get
keystone project-create --name <project-name>
+
    <policy-id>
                      [--domain_id <project-domain-id>]
+
</source>
                      [--description <project-description>]
+
|}
                      [--enabled <true|false>]
 
  
os create project
+
==== project ====
        [--domain <project-domain>]
 
        [--description <project-description>]
 
        [--enable | --disable]
 
        <project-name>
 
</nowiki></pre>
 
  
 
+
{| class="wikitable"
<pre><nowiki>#!bash
+
|-
keystone project-delete <project-id>
+
! OSC Command !! Implemented !! !! Keystone command
 
+
|-
os delete project <project>
+
|
</nowiki></pre>
+
<source lang="bash">
 
+
os project create
 
+
    [--domain <project-domain>]
<pre><nowiki>#!bash
+
    [--description <project-description>]
keystone project-get <project-id>
+
    [--enable | --disable]
 
+
    <project-name>
os show project <project>
+
</source>
</nowiki></pre>
+
|| yes
 
+
|| ||
 
+
<source lang="bash">
<pre><nowiki>#!bash
+
keystone project-create
 +
    [--domain_id <domain_id>]
 +
    [--description <description>]
 +
    [--enable | --disable]
 +
    <name>
 +
</source>
 +
|-
 +
|
 +
<source lang="bash">
 +
os project delete
 +
    <project>
 +
</source>
 +
|| yes
 +
|| ||
 +
<source lang="bash">
 +
os project-delete
 +
    <project_id>
 +
</source>
 +
|-
 +
|
 +
<source lang="bash">
 +
os project list
 +
    [--long]
 +
</source>
 +
|| yes
 +
|| ||
 +
<source lang="bash">
 
keystone project-list
 
keystone project-list
 +
</source>
 +
|-
 +
|
 +
<source lang="bash">
 +
os project set
 +
    [--name <new-project-name>]
 +
    [--domain <project-domain>]
 +
    [--description <new-project-description>]
 +
    [--enable | --disable]
 +
    <project>
 +
</source>
 +
|| yes
 +
|| ||
 +
<source lang="bash">
 +
keystone project-set
 +
    [--name <new-project-name>]
 +
    [--domain <project-domain>]
 +
    [--description <new-project-description>]
 +
    [--enable | --disable]
 +
    <project_id>
 +
</source>
 +
|-
 +
|
 +
<source lang="bash">
 +
os project show
 +
    <project>
 +
</source>
 +
|| yes
 +
|| ||
 +
<source lang="bash">
 +
keystone project-get
 +
    <project_id>
 +
</source>
 +
|}
  
os list project [--long]
+
==== role ====
</nowiki></pre>
 
  
 +
{| class="wikitable"
 +
|-
 +
! OSC Command !! Implemented !! !! Keystone command
 +
|-
 +
|
 +
<source lang="bash">
 +
os role add
 +
    [--user <user> | --group <group>]
 +
    [--domain <domain> | --project <project>]
 +
    <role>
 +
</source>
 +
|| yes
 +
|| ||
 +
<source lang="bash">
 +
</source>
 +
|-
 +
|
 +
<source lang="bash">
 +
os role create
 +
    <role-name>
 +
</source>
 +
|| yes
 +
|| ||
 +
<source lang="bash">
 +
</source>
 +
|-
 +
|
 +
<source lang="bash">
 +
os role delete
 +
    <role>
 +
</source>
 +
|| yes
 +
|| ||
 +
<source lang="bash">
 +
</source>
 +
|-
 +
|
 +
<source lang="bash">
 +
os role list
 +
</source>
 +
|| yes
 +
|| ||
 +
<source lang="bash">
 +
</source>
 +
|-
 +
|
 +
<source lang="bash">
 +
os role remove
 +
    [--user <user> | --group <group>]
 +
    [--domain <domain> | --project <project>]
 +
    <role>
 +
</source>
 +
|| yes
 +
|| ||
 +
<source lang="bash">
 +
</source>
 +
|-
 +
|
 +
<source lang="bash">
 +
os role set
 +
    [--name <new-role-name>]
 +
    <role>
 +
</source>
 +
|| yes
 +
|| ||
 +
<source lang="bash">
 +
</source>
 +
|-
 +
|
 +
<source lang="bash">
 +
os role show
 +
    <role>
 +
</source>
 +
|| yes
 +
|| ||
 +
<source lang="bash">
 +
</source>
 +
|}
  
<pre><nowiki>#!bash
+
==== service ====
keystone project-update
 
        [--name <project_name>]
 
        [--domain_id <project-domain-id>]
 
        [--description <project-description>]
 
        [--enabled <true|false>]
 
        <project-id>
 
  
os set project
+
{| class="wikitable"
        [--name <new-project-name>]
+
|-
        [--domain <project-domain>]
+
! OSC Command !! Implemented !! !! Keystone command
        [--description <new-project-description>]
+
|-
        [--enable | --disable]
+
|
        <project>
+
<source lang="bash">
</nowiki></pre>
+
os service create
 
 
 
 
'''role'''
 
 
 
<pre><nowiki>#!bash
 
keystone role-create --name <role-name>
 
 
 
os create role <role-name>
 
</nowiki></pre>
 
 
 
 
 
<pre><nowiki>#!bash
 
keystone role-delete <role-id>
 
 
 
os delete role <role>
 
</nowiki></pre>
 
 
 
 
 
<pre><nowiki>#!bash
 
keystone role-get <role-id>
 
 
 
os show role <role>
 
</nowiki></pre>
 
 
 
 
 
<pre><nowiki>#!bash
 
keystone role-list
 
 
 
os list role
 
</nowiki></pre>
 
 
 
 
 
<pre><nowiki>#!bash
 
keystone role-update <role-id>
 
 
 
os update role <role>
 
</nowiki></pre>
 
 
 
 
 
'''service'''
 
 
 
<pre><nowiki>#!bash
 
keystone service-create --type <type>
 
[--name <name>]
 
                        [--enabled <true|false>]
 
 
 
os create service
 
 
[--name <name>]
 
[--name <name>]
 
         [--enabled <true|false>]
 
         [--enabled <true|false>]
 
         <type>
 
         <type>
</nowiki></pre>
+
</source>
 
+
|| yes
 
+
|| ||
<pre><nowiki>#!bash
+
<source lang="bash">
keystone service-delete <service-id>
+
keystone service-create
 
 
os delete service <service>
 
</nowiki></pre>
 
 
 
 
 
<pre><nowiki>#!bash
 
keystone service-get <service-id>
 
 
 
os show service <service>
 
</nowiki></pre>
 
 
 
 
 
<pre><nowiki>#!bash
 
keystone service-list
 
 
 
os list service [--long]
 
</nowiki></pre>
 
 
 
 
 
<pre><nowiki>#!bash
 
keystone service-update --service_id <service-id>
 
[--type <type>]
 
[--name <name>]
 
                        [--enabled <true|false>]
 
 
 
os update service
 
[--type <type>]
 
 
[--name <name>]
 
[--name <name>]
 
         [--enabled <true|false>]
 
         [--enabled <true|false>]
         <service>
+
         <type>
</nowiki></pre>
+
</source>
 
+
|-
 
+
|
'''user'''
+
<source lang="bash">
 
+
os service delete
<pre><nowiki>#!bash
+
    <service>
keystone user-create --name <user-name>  
+
</source>
                    [--domain_id <domain-id>]
+
|| yes
                    [--default_project_id <project-id>]
+
|| ||
                    [--description <description>]
+
<source lang="bash">
                    [--enabled <true|false>]
+
keystone service-delete
                    [--password <password>]
+
    <service_id>
 
+
</source>
os create user
+
|-
        [--domain_id <domain-id>]
+
|
        [--default_project_id <project-id>]
+
<source lang="bash">
        [--description <description>]
+
os list service
        [--enabled <true|false>]
+
</source>
        [--password <password>]  
+
|| yes
        <user-name>
+
|| ||
</nowiki></pre>
+
<source lang="bash">
 
+
keystone service-list
 
+
</source>
<pre><nowiki>#!bash
+
|-
keystone user-delete <user-id>
+
|
 
+
<source lang="bash">
os delete user <user>
+
os service set
</nowiki></pre>
+
    [--type <service-type>]
 
+
    [--name <new-name>]
 +
    [--enable | --disable]
 +
    <service>
 +
</source>
 +
|| yes
 +
|| ||
 +
<source lang="bash">
 +
keystone service-set
 +
    [--type <service-type>]
 +
    [--name <new-name>]
 +
    [--enable | --disable]
 +
    <service>
 +
</source>
 +
|-
 +
|
 +
<source lang="bash">
 +
os service show
 +
    <service>
 +
</source>
 +
|| yes
 +
|| ||
 +
<source lang="bash">
 +
keystone service-get
 +
    <service_id>
 +
</source>
 +
|}
  
<pre><nowiki>#!bash
+
==== user ====
keystone user-get <user-id>
 
  
os show user <user>
+
{| class="wikitable"
</nowiki></pre>
+
|-
 
+
! OSC Command !! Implemented !! !! Keystone command
 
+
|-
<pre><nowiki>#!bash
+
|
 +
<source lang="bash">
 +
os user create
 +
    [--password <password>]
 +
    [--project <project>]
 +
    [--email <user-email>]
 +
    [--enable | --disable]
 +
    <name>
 +
</source>
 +
|| yes
 +
|| ||
 +
<source lang="bash">
 +
keystone user-create
 +
    --name <user-name>
 +
    [--domain_id <domain-id>]
 +
    [--default_project_id <project-id>]
 +
    [--description <description>]
 +
    [--enabled <true|false>]
 +
    [--password <password>]
 +
</source>
 +
|-
 +
|
 +
<source lang="bash">
 +
os user delete
 +
    <user>
 +
</source>
 +
|| yes
 +
|| ||
 +
<source lang="bash">
 +
keystone user-delete
 +
    <user-id>
 +
</source>
 +
|-
 +
|
 +
<source lang="bash">
 +
os user list
 +
    [--project <project>]
 +
    [--long]
 +
</source>
 +
|| yes
 +
|| ||
 +
<source lang="bash">
 
keystone user-list  
 
keystone user-list  
 
+
</source>
os list user [--long]
+
|-
</nowiki></pre>
+
|
 
+
<source lang="bash">
 
+
os user set
<pre><nowiki>#!bash
+
    [--name <new-name>]
keystone user-update --user_id <user-id>
+
    [--password <password>]
    [--name <user-name>]
+
    [--project <project>]
                    [--domain_id <domain-id>]
+
    [--email <user-email>]
                    [--default_project_id <project-id>]
+
    [--enable | --disable]
                    [--description <description>]
+
    <user>
                    [--enabled <true|false>]
+
</source>
                    [--password <password>]  
+
|| yes
 
+
|| ||
os set user
+
<source lang="bash">
        [--domain_id <domain-id>]
+
keystone user-update
        [--default_project_id <project-id>]
+
    --user_id <user-id>
        [--description <description>]
+
    [--name <user-name>]
        [--enabled <true|false>]
+
    [--domain_id <domain-id>]
        [--password <password>]
+
    [--default_project_id <project-id>]
        [--user_name <user-name>]
+
    [--description <description>]
        <user>
+
    [--enabled <true|false>]
</nowiki></pre>
+
    [--password <password>]  
 
+
</source>
 +
|-
 +
|
 +
<source lang="bash">
 +
os user show
 +
    <user>
 +
</source>
 +
|| yes
 +
|| ||
 +
<source lang="bash">
 +
keystone user-get
 +
    <user-id>
 +
</source>
 +
|}
  
 
== Compute ==
 
== Compute ==
  
  
<pre><nowiki>#!csv ,
+
{| class="wikitable"
Nova Option, Environment Variable, , OSC Option, Environment Variable
+
|-
--os-auth-system <auth-system>,OS_AUTH_SYSTEM, ,,
+
! OSC Option !! Environment Variable !! !! Nova Option !! Environment Variable
--service-type <type>,, ,,
+
|-
--service-name <name>,NOVA_SERVICE_NAME, ,,
+
| || || || --os-auth-system <auth-system> || OS_AUTH_SYSTEM
--volume-service-name <name>,NOVA_VOLUME_SERVICE_NAME, ,,
+
|-
--endpoint-type <type>,NOVA_ENDPOINT_TYPE, ,,
+
| || || || --service-type <type> ||
--os-compute-api-version <ver>,OS_COMPUTE_API_VERSION, ,--os-compute-api-version <ver>,OS_COMPUTE_API_VERSION
+
|-
--bypass-url <bypass-url>,, ,,
+
| || || || --service-name <name> || NOVA_SERVICE_NAME
</nowiki></pre>
+
|-
 +
| || || || --volume-service-name <name> || NOVA_VOLUME_SERVICE_NAME
 +
|-
 +
| || || || --endpoint-type <type> || NOVA_ENDPOINT_TYPE
 +
|-
 +
| --os-compute-api-version <ver> || OS_COMPUTE_API_VERSION || || --os-compute-api-version <ver> || OS_COMPUTE_API_VERSION
 +
|-
 +
| || || || --bypass-url <bypass-url> ||
 +
|}
  
  
 
=== API v2 (1.1) ===
 
=== API v2 (1.1) ===
  
'''aggregate'''
+
==== agent ====
  
<pre><nowiki>#!bash
+
{| class="wikitable"
nova aggregate-create <name> <availability_zone>
+
|-
 +
! OSC Command !! Implemented !! !! Nova command
 +
|-
 +
|
 +
<source lang="bash">
 +
os agent create
 +
    <os>
 +
    <architecture>
 +
    <version>
 +
    <url>
 +
    <md5hash>
 +
    <hypervisor>
 +
</source>
 +
|| yes
 +
|| ||
 +
|-
 +
|
 +
<source lang="bash">
 +
os agent delete
 +
    <id>
 +
</source>
 +
|| yes
 +
|| ||
 +
|-
 +
|
 +
<source lang="bash">
 +
os agent list
 +
    [--hypervisor <hypervisor>]
 +
</source>
 +
|| yes
 +
|| ||
 +
|-
 +
|
 +
<source lang="bash">
 +
os agent set
 +
    <id>
 +
    <version>
 +
    <url>
 +
    <md5hash>
 +
</source>
 +
|| yes
 +
|| ||
 +
|}
  
os create aggregate ...
 
</nowiki></pre>
 
  
 +
==== aggregate ====
  
<pre><nowiki>#!bash
+
{| class="wikitable"
nova aggregate-delete <id>
+
|-
 
+
! OSC Command !! Implemented !! !! Nova command
os delete aggregate ...
+
|-
</nowiki></pre>
+
|
 
+
<source lang="bash">
 
+
os aggregate add host
<pre><nowiki>#!bash
+
    <aggregate>
nova aggregate-details <id>
+
    <host>
 
+
</source>
os show aggregate ...
+
|| yes
</nowiki></pre>
+
|| ||
 
+
<source lang="bash">
 
+
nova aggregate-add-host
<pre><nowiki>#!bash
+
    <id>
 +
    <host>
 +
</source>
 +
|-
 +
|
 +
<source lang="bash">
 +
os aggregate create
 +
    [--zone <availability-zone>]
 +
    [--property <key=value>]
 +
    <name>
 +
</source>
 +
|| yes
 +
|| ||
 +
<source lang="bash">
 +
nova aggregate-create
 +
    <name>
 +
    [<availability_zone>]
 +
</source>
 +
|-
 +
|
 +
<source lang="bash">
 +
os aggregate delete
 +
    <aggregate>
 +
</source>
 +
|| yes
 +
|| ||
 +
<source lang="bash">
 +
nova aggregate-delete
 +
    <id>
 +
</source>
 +
|-
 +
|
 +
<source lang="bash">
 +
os aggregate list
 +
    [--long]
 +
</source>
 +
|| yes
 +
|| ||
 +
<source lang="bash">
 
nova aggregate-list
 
nova aggregate-list
 +
</source>
 +
|-
 +
|
 +
<source lang="bash">
 +
os aggregate remove host
 +
    <aggregate>
 +
    <host>
 +
</source>
 +
|| yes
 +
|| ||
 +
<source lang="bash">
 +
nova aggregate-remove-host
 +
    <id>
 +
    <host>
 +
</source>
 +
|-
 +
|
 +
<source lang="bash">
 +
os aggregate set
 +
    [--name <new-name>]
 +
    [--zone <availability-zone>]
 +
    [--property <key=value>]
 +
    <aggregate>
 +
</source>
 +
|| yes
 +
|| ||
 +
<source lang="bash">
 +
nova aggregate-update
 +
    <id>
 +
    <name>
 +
    [<availability_zone>]
  
os list aggregate
+
nova aggregate-set-metadata
</nowiki></pre>
+
    <id>
 
+
    <key=value>
 
+
    [<key=value> ...]
<pre><nowiki>#!bash
+
</source>
nova aggregate-update <id> <name> [<availability_zone>]
+
|-
 
+
|
os set aggregate ...
+
<source lang="bash">
</nowiki></pre>
+
os aggregate show
 
+
    <aggregate>
 
+
</source>
<pre><nowiki>#!bash
+
|| yes
nova aggregate-set-metadata <id> <key=value> [<key=value> ...]
+
|| ||
 
+
<source lang="bash">
os set aggregate --metadata ...
+
nova aggregate-details
</nowiki></pre>
+
    <id>
 
+
</source>
 
+
|}
'''aggregate-host'''
 
 
 
<pre><nowiki>#!bash
 
nova aggregate-add-host <id> <host>
 
 
 
os add aggregate-host ...
 
</nowiki></pre>
 
 
 
 
 
<pre><nowiki>#!bash
 
nova aggregate-remove-host <id> <host>
 
  
os remove aggregate-host ...
+
==== bash-completion ====
</nowiki></pre>
 
  
 
+
{| class="wikitable"
'''bash-completion'''
+
|-
 
+
! OSC Command !! Implemented !! !! Nova command
<pre><nowiki>#!bash
+
|-
 +
|
 +
TBD
 +
|| no
 +
|| ||
 +
<source lang="bash">
 
nova bash-completion
 
nova bash-completion
 +
</source>
 +
|}
  
os show bash-completion
+
==== cloudpipe ====
</nowiki></pre>
 
  
 
+
{| class="wikitable"
'''cloudpipe'''
+
|-
 
+
! OSC Command !! Implemented !! !! Nova command
<pre><nowiki>#!bash
+
|-
nova cloudpipe-create <project>
+
|
 
+
<source lang="bash">
os create cloudpipe ...
+
os create cloudpipe
</nowiki></pre>
+
    <project>
 
+
</source>
 
+
|| no
<pre><nowiki>#!bash
+
|| ||
 +
<source lang="bash">
 +
nova cloudpipe-create
 +
    <project>
 +
</source>
 +
|-
 +
|
 +
<source lang="bash">
 +
os list cloudpipe
 +
</source>
 +
|| no
 +
|| ||
 +
<source lang="bash">
 
nova cloudpipe-list
 
nova cloudpipe-list
 +
</source>
 +
|}
  
os list cloudpipe
+
==== console ====
</nowiki></pre>
 
  
 +
{| class="wikitable"
 +
|-
 +
! OSC Command !! Implemented !! !! Nova command
 +
|-
 +
|
 +
<source lang="bash">
 +
os console log show
 +
    [--lines <num-lines>]
 +
    <server>
 +
</source>
 +
|| yes
 +
|| ||
 +
<source lang="bash">
 +
nova console-log
 +
    [--length <length>]
 +
    <server>
 +
</source>
 +
|-
 +
|
 +
<source lang="bash">
 +
os console url show
 +
    [--novnc | --xvpvnc | --spice]
 +
    <server>
 +
</source>
 +
|| yes
 +
|| ||
 +
<source lang="bash">
 +
nova get-vnc-console
 +
    <server>
 +
    <console_type>
 +
</source>
 +
|}
  
'''console'''
+
==== credentials ====
  
<pre><nowiki>#!bash
+
See [[#credentials|credentials]] in the [[#Cross_API|cross API section]].
nova console-log [--length <length>] <server>
 
  
os show console ...
+
==== diagnostics ====
</nowiki></pre>
 
  
 +
''Consider implementing this as: show server --diagnostics <server>''
 +
{| class="wikitable"
 +
|-
 +
! OSC Command !! Implemented !! !! Nova command
 +
|-
 +
|
 +
<source lang="bash">
 +
os diagnostics show
 +
    <server>
 +
</source>
 +
|| no
 +
|| ||
 +
<source lang="bash">
 +
nova diagnostics
 +
    <server>
 +
</source>
 +
|}
  
<pre><nowiki>#!bash
+
==== dns ====
nova get-vnc-console <server> <console_type>
 
  
os show console [--vnc] ...
+
''These commands need some attention...an IP shouldn't be required for all record types.  They need to be more DNS-y.  Zone anyone?''
</nowiki></pre>
+
{| class="wikitable"
 +
|-
 +
! OSC Command !! Implemented !! !! Nova command
 +
|-
 +
|
 +
<source lang="bash">
 +
os create dns
 +
    [--type <type>]
 +
    <ip>
 +
    <name>
 +
    <domain>
 +
</source>
 +
|| no
 +
|| ||
 +
<source lang="bash">
 +
nova dns-create
 +
    [--type <type>]
 +
    <ip>
 +
    <name>
 +
    <domain>
 +
</source>
 +
|-
 +
|
 +
<source lang="bash">
 +
os delete dns
 +
    <domain>
 +
    <name>
 +
</source>
 +
|| no
 +
|| ||
 +
<source lang="bash">
 +
nova dns-delete
 +
    <domain>
 +
    <name>
 +
</source>
 +
|-
 +
|
 +
<source lang="bash">
 +
os list dns
 +
    [--ip <ip>]
 +
    [--name <name>]
 +
    <domain>
 +
</source>
 +
|| no
 +
|| ||
 +
<source lang="bash">
 +
nova dns-list
 +
    [--ip <ip>]
 +
    [--name <name>]
 +
    <domain>
 +
</source>
 +
|-
 +
|
 +
<source lang="bash">
 +
os create dns-domain
 +
    [--project <project>]
 +
    [--availability-zone <availability-zone>]
 +
    [--public | --private]
 +
    <domain>
 +
</source>
 +
|| no
 +
|| ||
 +
<source lang="bash">
 +
nova dns-create-private-domain
 +
    [--availability_zone <availability_zone>]
 +
    <domain>
  
 
+
nova dns-create-public-domain
'''credentials'''
+
    [--project <project>]
 
+
    <domain>
<pre><nowiki>#!bash
+
</source>
nova credentials
+
|-
 
+
|
os show credentials
+
<source lang="bash">
</nowiki></pre>
+
os delete dns-domain
 
+
    <domain>
 
+
</source>
'''diagnostics'''
+
|| no
 
+
|| ||
<pre><nowiki>#!bash
+
<source lang="bash">
nova diagnostics <server>
+
nova dns-delete-domain
 
+
    <domain>
os show diagnostics ...
+
</source>
</nowiki></pre>
+
|-
 
+
|
 
+
<source lang="bash">
'''dns'''
+
os list dns-domains
 
+
</source>
<pre><nowiki>#!bash
+
|| no
nova dns-create [--type <type>] <ip> <name> <domain>
+
|| ||
 
+
<source lang="bash">
os create dns ...
 
</nowiki></pre>
 
 
 
 
 
<pre><nowiki>#!bash
 
nova dns-delete <domain> <name>
 
 
 
os delete dns ...
 
</nowiki></pre>
 
 
 
 
 
<pre><nowiki>#!bash
 
nova dns-list [--ip <ip>] [--name <name>] <domain>
 
 
 
os list dns ...
 
</nowiki></pre>
 
 
 
 
 
'''dns-domain'''
 
 
 
<pre><nowiki>#!bash
 
nova dns-create-private-domain [--availability_zone <availability_zone>]
 
                              <domain>
 
 
 
os create dns-domain [--private] ...
 
</nowiki></pre>
 
 
 
 
 
'''dns-public-domain'''
 
 
 
<pre><nowiki>#!bash
 
nova dns-create-public-domain [--project <project>] <domain>
 
 
 
os create dns-domain [--public] ...
 
</nowiki></pre>
 
 
 
 
 
<pre><nowiki>#!bash
 
nova dns-delete-domain <domain>
 
 
 
os delete dns-domain ...
 
</nowiki></pre>
 
 
 
 
 
<pre><nowiki>#!bash
 
 
nova dns-domains
 
nova dns-domains
 +
</source>
 +
|}
  
os list dns-domains
+
==== endpoints ====
</nowiki></pre>
 
 
 
 
 
'''endpoints'''
 
  
<pre><nowiki>#!bash
+
''Totally duplicates Identity catalog command''
 +
{| class="wikitable"
 +
|-
 +
! OSC Command !! Implemented !! !! Nova command
 +
|-
 +
|
 +
<source lang="bash">
 +
os endpoint list
 +
</source>
 +
|| no
 +
|| ||
 +
<source lang="bash">
 
nova endpoints
 
nova endpoints
 +
</source>
 +
|}
  
os list endpoints
+
==== fixed-ip ====
 
 
# does this overlap with keystone?
 
</nowiki></pre>
 
 
 
 
 
'''fixed-ip'''
 
 
 
<pre><nowiki>#!bash
 
nova add-fixed-ip <server> <network_id>
 
 
 
os add fixed-ip ...
 
</nowiki></pre>
 
 
 
 
 
<pre><nowiki>#!bash
 
nova remove-fixed-ip <server> <address>
 
 
 
os remove fixed-ip ...
 
</nowiki></pre>
 
 
 
  
'''flavor'''
+
{| class="wikitable"
 +
|-
 +
! OSC Command !! Implemented !! !! Nova command
 +
|-
 +
|
 +
<source lang="bash">
 +
os ip fixed add
 +
    <network>
 +
    <server>
 +
</source>
 +
|| yes
 +
|| ||
 +
<source lang="bash">
 +
nova add-fixed-ip
 +
    <server>
 +
    <network_id>
 +
</source>
 +
|-
 +
|
 +
<source lang="bash">
 +
os ip fixed remove
 +
    <ip-address>
 +
    <server>
 +
</source>
 +
|| yes
 +
|| ||
 +
<source lang="bash">
 +
nova remove-fixed-ip
 +
    <server>
 +
    <address>
 +
</source>
 +
|}
  
<pre><nowiki>#!bash
 
nova flavor-create [--ephemeral <ephemeral>]
 
                  [--swap <swap>]
 
                  [--rxtx-factor <factor>]
 
                  <name> <id> <ram> <disk> <vcpus>
 
  
os create flavor ...
+
==== flavor ====
</nowiki></pre>
 
  
 +
{| class="wikitable"
 +
|-
 +
! OSC Command !! Implemented !! !! Nova command
 +
|-
 +
|
 +
<source lang="bash">
 +
os flavor create
 +
    [--id <id>]
 +
    [--ram <size-mb>]
 +
    [--disk <size-gb>]
 +
    [--ephemeral-disk <size-gb>]
 +
    [--swap <size-mb>]
 +
    [--vcpus <num-cpu>]
 +
    [--rxtx-factor <factor>]
 +
    [--public | --private]
 +
    <name>
 +
</source>
 +
||
 +
<source lang="bash">
 +
(partial)
 +
default: auto
 +
default: 256M
 +
default: 0G
 +
default: 0G
 +
default: 0G
 +
default: 1
 +
default: 1
 +
default: public
  
<pre><nowiki>#!bash
+
</source>
nova flavor-delete <id>
+
|| ||
 
+
<source lang="bash">
os delete flavor ...
+
nova flavor-create
</nowiki></pre>
+
    [--ephemeral <ephemeral>]
 
+
    [--swap <swap>]
 
+
    [--rxtx-factor <factor>]
<pre><nowiki>#!bash
+
    <name>
 +
    <id>
 +
    <ram>
 +
    <disk>
 +
    <vcpus>
 +
</source>
 +
|-
 +
|
 +
<source lang="bash">
 +
os flavor delete
 +
    <flavor>
 +
</source>
 +
|| yes
 +
|| ||
 +
<source lang="bash">
 +
nova flavor-delete
 +
    <id>
 +
</source>
 +
|-
 +
|
 +
<source lang="bash">
 +
os flavor list
 +
</source>
 +
|| yes
 +
|| ||
 +
<source lang="bash">
 
nova flavor-list
 
nova flavor-list
 +
</source>
 +
|-
 +
|
 +
<source lang="bash">
 +
os flavor show
 +
    <flavor>
 +
</source>
 +
|| yes
 +
|| ||
 +
|}
  
os list flavor
 
</nowiki></pre>
 
 
 
'''floating-ip'''
 
 
<pre><nowiki>#!bash
 
nova add-floating-ip <server> <address>
 
 
os add floating-ip ...
 
</nowiki></pre>
 
 
 
<pre><nowiki>#!bash
 
nova floating-ip-create [<floating_ip_pool>]
 
  
os create floating-ip ...
+
==== floating-ip ====
</nowiki></pre>
 
  
 
+
{| class="wikitable"
<pre><nowiki>#!bash
+
|-
nova floating-ip-delete <address>
+
! OSC Command !! Implemented !! !! Nova command
 
+
|-
os delete floating-ip
+
|
</nowiki></pre>
+
<source lang="bash">
 
+
os ip floating add
 
+
    <ip-address>
<pre><nowiki>#!bash
+
    <server>
 +
</source>
 +
|| yes
 +
|| ||
 +
<source lang="bash">
 +
nova add-floating-ip
 +
    <server>
 +
    <address>
 +
</source>
 +
|-
 +
|
 +
<source lang="bash">
 +
os ip floating create
 +
    [<pool>]
 +
</source>
 +
|| yes
 +
|| ||
 +
<source lang="bash">
 +
nova floating-ip-create
 +
    [<floating_ip_pool>]
 +
</source>
 +
|-
 +
|
 +
<source lang="bash">
 +
os ip floating delete
 +
    <ip-address>
 +
</source>
 +
|| yes
 +
|| ||
 +
<source lang="bash">
 +
nova floating-ip-delete
 +
    <address>
 +
</source>
 +
|-
 +
|
 +
<source lang="bash">
 +
os ip floating list
 +
</source>
 +
|| yes
 +
|| ||
 +
<source lang="bash">
 
nova floating-ip-list
 
nova floating-ip-list
 +
</source>
 +
|-
 +
|
 +
<source lang="bash">
 +
os ip floating remove
 +
    <ip-address>
 +
    <server>
 +
</source>
 +
|| yes
 +
|| ||
 +
<source lang="bash">
 +
nova remove-floating-ip
 +
    <server>
 +
    <address>
 +
</source>
 +
|}
  
os list floating-ip
 
</nowiki></pre>
 
  
 +
==== floating-ip-pool ====
  
<pre><nowiki>#!bash
 
nova remove-floating-ip <server> <address>
 
  
os remove floating-ip ...
+
{| class="wikitable"
</nowiki></pre>
+
|-
 
+
! OSC Command !! Implemented !! !! Nova command
 
+
|-
'''floating-ip-pool'''
+
|
 
+
<source lang="bash">
<pre><nowiki>#!bash
+
os ip floating pool list
 +
</source>
 +
|| yes
 +
|| ||
 +
<source lang="bash">
 
nova floating-ip-pool-list
 
nova floating-ip-pool-list
 +
</source>
 +
|}
  
os list floating-ip-pool
 
</nowiki></pre>
 
  
 +
==== host ====
  
'''host'''
+
{| class="wikitable"
 +
|-
 +
! OSC Command !! Implemented !! !! Nova command
 +
|-
 +
|
 +
<source lang="bash">
 +
os host list
 +
    [--zone <availability-zone>]
 +
</source>
 +
|| yes
 +
|| ||
 +
<source lang="bash">
 +
nova host-action
 +
    [--action <action>]
 +
    <hostname>
 +
</source>
 +
|-
 +
|
 +
<source lang="bash">
 +
os host set
 +
    ...
 +
</source>
 +
|| no
 +
|| ||
 +
<source lang="bash">
 +
nova host-update
 +
    [--status <status>]
 +
    [--maintenance <maintenance_mode>]
 +
    <hostname>
 +
</source>
 +
|-
 +
|
 +
<source lang="bash">
 +
os host show
 +
    <host>
 +
</source>
 +
|| yes
 +
|| ||
 +
|}
  
<pre><nowiki>#!bash
 
nova host-action [--action <action>] <hostname>
 
  
os ?? host ...
+
==== hypervisor ====
</nowiki></pre>
 
  
 +
{| class="wikitable"
 +
|-
 +
! OSC Command !! Implemented !! !! Nova command
 +
|-
 +
|
 +
<source lang="bash">
 +
os hypervisor list
 +
    [--matching <hostname>]
 +
</source>
 +
|| yes
 +
|| ||
 +
|-
 +
|
 +
<source lang="bash">
 +
os hypervisor show
 +
    <id>
 +
</source>
 +
|| yes
 +
|| ||
 +
|}
  
<pre><nowiki>#!bash
 
nova host-update [--status <status>]
 
                [--maintenance <maintenance_mode>]
 
                <hostname>
 
  
os set host ...
+
==== keypair ====
</nowiki></pre>
 
  
 
+
{| class="wikitable"
'''image'''
+
|-
 
+
! OSC Command !! Implemented !! !! Nova command
<pre><nowiki>#!bash
+
|-
nova image-create [--poll] <server> <name>
+
|
 
+
<source lang="bash">
os create image ...
+
os keypair create
</nowiki></pre>
+
    [--public-key <file>]
 
+
    <name>
 
+
</source>
<pre><nowiki>#!bash
+
|| yes
nova image-delete <image>
+
|| ||
 
+
<source lang="bash">
os delete image ...
+
nova keypair-add
</nowiki></pre>
+
    [--pub_key <pub_key>]
 
+
    <name>
 
+
</source>
<pre><nowiki>#!bash
+
|-
nova image-list
+
|
 
+
<source lang="bash">
os list image
+
os keypair delete
</nowiki></pre>
+
    <name>
 
+
</source>
 
+
|| yes
<pre><nowiki>#!bash
+
|| ||
nova image-meta <image> <action> <key=value> [<key=value> ...]
+
<source lang="bash">
 
+
nova keypair-delete
os set image ...
+
    <name>
</nowiki></pre>
+
</source>
 
+
|-
 
+
|
<pre><nowiki>#!bash
+
<source lang="bash">
nova image-show <image>
+
os keypair list
 
+
</source>
os show image ...
+
|| yes
</nowiki></pre>
+
|| ||
 
+
<source lang="bash">
 
 
'''keypair'''
 
 
 
<pre><nowiki>#!bash
 
nova keypair-add [--pub_key <pub_key>] <name>
 
 
 
os create keypair ...
 
</nowiki></pre>
 
 
 
 
 
<pre><nowiki>#!bash
 
nova keypair-delete <name>
 
 
 
os delete keypair
 
</nowiki></pre>
 
 
 
 
 
<pre><nowiki>#!bash
 
 
nova keypair-list
 
nova keypair-list
 +
</source>
 +
|-
 +
|
 +
<source lang="bash">
 +
os keypair show
 +
    [--public-key]
 +
    <name>
 +
</source>
 +
|| yes
 +
|| ||
 +
|}
  
os list keypair
 
</nowiki></pre>
 
 
 
'''limits'''
 
 
<pre><nowiki>#!bash
 
nova absolute-limits
 
 
os show limits --absolute
 
## is there any other kind?
 
</nowiki></pre>
 
 
 
'''quota'''
 
 
<pre><nowiki>#!bash
 
nova quota-defaults <tenant_id>
 
nova quota-show <tenant_id>
 
 
os show quota <tenant> [--defaults]
 
</nowiki></pre>
 
 
 
<pre><nowiki>#!bash
 
nova quota-update [--instances <instances>]
 
                  [--cores <cores>]
 
                  [--ram <ram>]
 
                  [--volumes <volumes>]
 
                  [--gigabytes <gigabytes>]
 
                  [--floating-ips <floating_ips>]
 
                  [--metadata-items <metadata_items>]
 
                  [--injected-files <injected_files>]
 
                  [--injected-file-content-bytes <injected_file_content_bytes>]
 
                  <tenant_id>
 
 
os set quota ...
 
</nowiki></pre>
 
 
 
'''quota-class'''
 
 
<pre><nowiki>#!bash
 
nova quota-class-show <class>
 
 
os show quota-class ...
 
</nowiki></pre>
 
 
 
<pre><nowiki>#!bash
 
nova quota-class-update [--instances <instances>]
 
                        [--cores <cores>]
 
                        [--ram <ram>]
 
                        [--volumes <volumes>]
 
                        [--gigabytes <gigabytes>]
 
                        [--floating-ips <floating_ips>]
 
                        [--metadata-items <metadata_items>]
 
                        [--injected-files <injected_files>]
 
                        [--injected-file-content-bytes <injected_file_content_bytes>]
 
                        <class>
 
 
os set quota-class ...
 
</nowiki></pre>
 
 
 
'''rate-limits'''
 
 
<pre><nowiki>#!bash
 
nova rate-limits
 
  
os show rate-limits
+
==== limits ====
</nowiki></pre>
 
  
 +
See [[#limits|limits]] in the [[#Cross_API|cross API section]].
  
'''resource'''
+
==== quota ====
  
<pre><nowiki>#!bash
+
See [[#quota|quota]] in the [[#Cross_API|cross API section]].
nova describe-resource <hostname>
 
  
os show resource ...
 
</nowiki></pre>
 
  
 +
==== resource ====
  
'''secgroup'''
+
{| class="wikitable"
 +
|-
 +
! OSC Command !! Implemented !! !! Nova command
 +
|-
 +
|
 +
<source lang="bash">
 +
os show resource
 +
    <hostname>
 +
</source>
 +
|| no
 +
|| ||
 +
<source lang="bash">
 +
nova describe-resource
 +
    <hostname>
 +
</source>
 +
|}
  
<pre><nowiki>#!bash
+
==== secgroup ====
nova secgroup-create <name> <description>
 
  
os create secgroup ...
+
{| class="wikitable"
</nowiki></pre>
+
|-
 +
! OSC Command !! Implemented !! !! Nova command
 +
|-
 +
|
 +
<source lang="bash">
 +
os secgroup add
  
 
+
(see server add secgroup)
<pre><nowiki>#!bash
+
</source>
nova secgroup-delete <secgroup>
+
|| no
 
+
|| ||
os delete secgroup ...
+
<source lang="bash">
</nowiki></pre>
+
nova add-secgroup
 
+
    <server>
 
+
    <secgroup>
<pre><nowiki>#!bash
+
</source>
 +
|-
 +
|
 +
<source lang="bash">
 +
os secgroup create
 +
    [--description <description>]
 +
    <name>
 +
</source>
 +
|| yes
 +
|| ||
 +
<source lang="bash">
 +
nova secgroup-create
 +
    <name>
 +
    <description>
 +
</source>
 +
|-
 +
|
 +
<source lang="bash">
 +
os secgroup delete
 +
    <group>
 +
</source>
 +
|| yes
 +
|| ||
 +
<source lang="bash">
 +
nova secgroup-delete
 +
    <secgroup>
 +
</source>
 +
|-
 +
|
 +
<source lang="bash">
 +
os secgroup list
 +
    [--all-projects]
 +
</source>
 +
|| yes
 +
|| ||
 +
<source lang="bash">
 
nova secgroup-list
 
nova secgroup-list
 +
    [--all-tenants [<0|1>]]
 +
</source>
 +
|-
 +
|
 +
<source lang="bash">
 +
os secgroup remove
  
os list secgroup
+
(see server remove secgroup)
</nowiki></pre>
+
</source>
 
+
|| no
 
+
|| ||
'''secgroup-group-rule'''
+
<source lang="bash">
 
+
nova remove-secgroup
<pre><nowiki>#!bash
+
    <server>
nova secgroup-add-group-rule [--ip_proto <ip_proto>]
+
    <secgroup>
                            [--from_port <from_port>]
+
</source>
                            [--to_port <to_port>]
+
|-
                            <secgroup> <source_group>
+
|
 
+
<source lang="bash">
os create secgroup-group-rule
+
os secgroup set
</nowiki></pre>
+
    [--name <new-name>]
 
+
    [--description [<new-description>]
 
+
    <group>
<pre><nowiki>#!bash
+
</source>
nova secgroup-delete-group-rule [--ip_proto <ip_proto>]
+
|| yes
                                [--from_port <from_port>]
+
|| ||
                                [--to_port <to_port>]
+
<source lang="bash">
                                <secgroup> <source_group>
+
nova secgroup-update
 
+
    <secgroup>
os delete secgroup-group-rule ...
+
    <name>
</nowiki></pre>
+
    <description>
 
+
</source>
 
+
|-
'''secgroup-rule'''
+
|
 
+
<source lang="bash">
<pre><nowiki>#!bash
+
os secgroup show
nova secgroup-add-rule <secgroup> <ip_proto> <from_port> <to_port> <cidr>
+
    <group>
 
+
</source>
os create secgroup-rule
+
|| yes
</nowiki></pre>
+
|| ||
 
+
<source lang="bash">
 
+
n/a
<pre><nowiki>#!bash
+
</source>
nova secgroup-delete-rule <secgroup> <ip_proto> <from_port> <to_port> <cidr>
+
|}
  
os delete secgroup-rule
+
==== secgroup-group-rule ====
</nowiki></pre>
 
  
 +
{| class="wikitable"
 +
|-
 +
! OSC Command !! Implemented !! !! Nova command
 +
|-
 +
|
 +
<source lang="bash">
 +
os secgroup group rule create
 +
    [--proto <protocol>]
 +
    [--port <port>:<port>]
 +
    <source-group>
 +
    <secgroup>
 +
</source>
 +
|| no
 +
|| ||
 +
<source lang="bash">
 +
nova secgroup-add-group-rule
 +
    [--ip_proto <ip_proto>]
 +
    [--from_port <from_port>]
 +
    [--to_port <to_port>]
 +
    <secgroup>
 +
    <source_group>
 +
</source>
 +
|-
 +
|
 +
<source lang="bash">
 +
os secgroup group rule delete
 +
    [--proto <protocol>]
 +
    [--port <port>:<port>]
 +
    <source-group>
 +
    <secgroup>
 +
</source>
 +
|| no
 +
|| ||
 +
<source lang="bash">
 +
nova secgroup-delete-group-rule
 +
    [--ip_proto <ip_proto>]
 +
    [--from_port <from_port>]
 +
    [--to_port <to_port>]
 +
    <secgroup>
 +
    <source_group>
 +
</source>
 +
|}
  
<pre><nowiki>#!bash
+
==== secgroup-rule ====
nova secgroup-list-rules <secgroup>
 
  
os list secgroup-rule ...
+
{| class="wikitable"
</nowiki></pre>
+
|-
 +
! OSC Command !! Implemented !! !! Nova command
 +
|-
 +
|
 +
<source lang="bash">
 +
os secgroup rule create
 +
    [--proto <proto>]
 +
    [--src-ip <ip-address>]
 +
    [--dst-port <port-range>]
 +
    <group>
 +
</source>
 +
|| no
 +
|| ||
 +
<source lang="bash">
 +
nova secgroup-add-rule
 +
    <secgroup>
 +
    <ip_proto>
 +
    <from_port>
 +
    <to_port>
 +
    <cidr>
 +
</source>
 +
|-
 +
|
 +
<source lang="bash">
 +
os secgroup rule delete
 +
    [--proto <proto>]
 +
    [--src-ip <ip-address>]
 +
    [--dst-port <port-range>]
 +
    <group>
 +
</source>
 +
|| no
 +
|| ||
 +
<source lang="bash">
 +
nova secgroup-delete-rule
 +
    <secgroup>
 +
    <ip_proto>
 +
    <from_port>
 +
    <to_port>
 +
    <cidr>
 +
</source>
 +
|-
 +
|
 +
<source lang="bash">
 +
os secgroup rule list
 +
    <group>
 +
</source>
 +
|| no
 +
|| ||
 +
<source lang="bash">
 +
nova secgroup-list-rules
 +
    <secgroup>
 +
</source>
 +
|}
  
 +
====server====
  
'''server'''
+
{| class="wikitable"
 +
|-
 +
! OSC Command !! Implemented !! !! Nova command
 +
|-
 +
|
 +
<source lang="bash">
 +
os server add secgroup
 +
    <server>
 +
    <group>
 +
</source>
 +
|| no
 +
|| ||
 +
<source lang="bash">
 +
nova add-secgroup
 +
    <server>
 +
    <secgroup>
 +
</source>
 +
|-
 +
|
 +
<source lang="bash">
 +
os server create
 +
    --image <image>
 +
    --flavor <flavor>
 +
    [--security-group <security-group-list> [...] ]
 +
    [--key-name <key-name>]
 +
    [--meta-data <key=value> [...] ]
 +
    [--file <dest-filename=source-filename>] [...] ]
 +
    [--user-data <user-data>]
 +
    [--availability-zone <zone-name>]
 +
    [--block-device-mapping <dev-name=mapping> [...] ]
 +
    [--nic <net-id=net-uuid,v4-fixed-ip=ip-addr> [...] ]
 +
    [--hint <key=value> [...] ]
 +
    [--config-drive <value>|True ]
 +
    [--min <count>]
 +
    [--max <count>]
 +
    [--wait]
 +
    <server-name>
 +
</source>
 +
|| yes
 +
|| ||
 +
<source lang="bash">
 +
nova boot
 +
    [--flavor <flavor>]
 +
    [--image <image>]
 +
    [--meta <key=value>]
 +
    [--file <dst-path=src-path>]
 +
    [--key_name <key_name>]
 +
    [--user_data <user-data>]
 +
    [--availability_zone <availability-zone>]
 +
    [--security_groups <security_groups>]
 +
    [--block_device_mapping <dev_name=mapping>]
 +
    [--hint <key=value>]
 +
    [--nic <net-id=net-uuid,v4-fixed-ip=ip-addr>]
 +
    [--config-drive <value>]
 +
    [--poll]
 +
    <name>
 +
</source>
 +
|-
 +
|
 +
<source lang="bash">
 +
os server delete
 +
    <server>
 +
</source>
 +
|| yes
 +
|| ||
 +
<source lang="bash">
 +
nova delete
 +
    <server>
 +
</source>
 +
|-
 +
|
 +
<source lang="bash">
 +
os server list
 +
    [--reservation-id <reservation-id>]
 +
    [--ip <ip-regex>]
 +
    [--ip6 <ip6-regex>]
 +
    [--name <name-regex>]
 +
    [--instance-name <instance-name-regex>]
 +
    [--status <status>]
 +
    [--flavor <flavor>]
 +
    [--image <image>]
 +
    [--host <hostname>]
 +
    [--all-tenants]
 +
</source>
 +
|| yes
 +
|| ||
 +
<source lang="bash">
 +
nova list
 +
    [--reservation_id <reservation_id>]
 +
    [--ip <ip_regexp>]
 +
    [--ip6 <ip6_regexp>]
 +
    [--name <name_regexp>]
 +
    [--instance_name <name_regexp>]
 +
    [--status <status>]
 +
    [--flavor <flavor>] [--image <image>]
 +
    [--host <hostname>]
 +
    [--all_tenants [<0|1>]]
 +
</source>
 +
|-
 +
|
 +
<source lang="bash">
 +
os server lock
 +
    <server>
 +
</source>
 +
|| no
 +
|| ||
 +
<source lang="bash">
 +
nova lock
 +
    <server>
 +
</source>
 +
|-
 +
|
 +
<source lang="bash">
 +
os server migrate
 +
    --live
 +
    [--block_migrate]
 +
    [--disk_over_commit]
 +
    <server>
 +
    <host>
  
<pre><nowiki>#!bash
+
os server migrate
nova boot [--flavor <flavor>]
+
    [--wait]
          [--image <image>]
+
    <server>
          [--meta <key=value>]
+
</source>
          [--file <dst-path=src-path>]
+
|| no
          [--key_name <key_name>]
+
|| ||
          [--user_data <user-data>]
+
<source lang="bash">
          [--availability_zone <availability-zone>]
+
nova live-migration
          [--security_groups <security_groups>]
+
    [--block_migrate]  
          [--block_device_mapping <dev_name=mapping>]
+
    [--disk_over_commit]
          [--hint <key=value>]
+
    <server>
          [--nic <net-id=net-uuid,v4-fixed-ip=ip-addr>]
+
<host>
          [--config-drive <value>]
 
          [--poll]
 
          <name>
 
  
os create server
+
nova migrate
          --image <image>
+
    [--poll]
          --flavor <flavor>
+
    <server>
          [--security-group <security-group-list> [...] ]
+
</source>
          [--key-name <key-name>]
+
|-
          [--meta-data <key=value> [--meta-data <key=value] [...] ]
+
|
          [--file <dest-filename=source-filename> [--file <dest-filename=source-filename>] [...] ]
+
<source lang="bash">
          [--user-data <user-data>]
+
os server pause
          [--reservation-id <uuid>]
+
    <server>
          [--availability-zone <zone-name>]
+
</source>
          [--block-device-mapping <dev-name=mapping> [...] ]
+
|| yes
          [--nic <net-id=net-uuid,v4-fixed-ip=ip-addr> [...] ]
+
|| ||
          [--hint <key=value> [...] ]
+
<source lang="bash">
          [--config-drive <value>|True ]
+
nova pause
          [--min <count>]
+
    <server>
          [--max <count>]
+
</source>
          [--wait]
+
|-
          <server-name>
+
|
</nowiki></pre>
+
<source lang="bash">
 
+
os server reboot
 
+
    [--hard | --soft]
<pre><nowiki>#!bash
+
    [--wait]
nova delete <server>
+
    <server>
 
+
</source>
os delete server <server>
+
|| yes
</nowiki></pre>
+
|| ||
 
+
<source lang="bash">
 
+
nova reboot
 
+
    [--hard]
<pre><nowiki>#!bash
+
    [--poll]
nova list [--reservation_id <reservation_id>]  
+
    <server>
          [--ip <ip_regexp>]
+
</source>
          [--ip6 <ip6_regexp>]
+
|-
          [--name <name_regexp>]
+
|
          [--instance_name <name_regexp>]
+
<source lang="bash">
          [--status <status>]
+
os server rebuild
          [--flavor <flavor>] [--image <image>]
+
    --image <image>
          [--host <hostname>]
+
    [--password <password>]  
          [--all_tenants [<0|1>]]
+
    [--wait]
 
+
    <server>
os list server  
+
</source>
          [--reservation-id <reservation-id>]
+
|| yes
          [--ip <ip-regex>]
+
|| ||
          [--ip6 <ip6-regex>]
+
<source lang="bash">
          [--name <name-regex>]
+
nova rebuild
          [--instance-name <instance-name-regex>]  
+
    [--rebuild_password <rebuild_password>]  
          [--status <status>]
+
    [--poll]
          [--flavor <flavor>]
+
    <server>
          [--image <image>]
+
    <image>
          [--host <hostname>]
+
</source>
          [--all-tenants]
+
|-
</nowiki></pre>
+
|
 
+
<source lang="bash">
 
+
os server remove secgroup
<pre><nowiki>#!bash
+
    <server>
nova lock <server>
+
    <group>
 
+
</source>
os lock server <server>
+
|| no
</nowiki></pre>
+
|| ||
 
+
<source lang="bash">
 
+
nova remove-secgroup
<pre><nowiki>#!bash
+
    <server>
nova live-migration [--block_migrate]
+
    <secgroup>
                    [--disk_over_commit]
+
</source>
                    <server> <host>
+
|-
nova migrate [--poll] <server>
+
|
 
+
<source lang="bash">
os migrate server --live
+
os server rename
          [--block_migrate]
+
    <server>
          [--disk_over_commit]
+
    <new-name>
          <server>
+
</source>
          <host>
+
|| no
os migrate server [--wait] <server>
+
|| ||
</nowiki></pre>
+
<source lang="bash">
 
+
nova rename
 
+
    <server>
<pre><nowiki>#!bash
+
    <name>
nova pause <server>
+
</source>
 
+
|-
os pause server <server>
+
|
</nowiki></pre>
+
<source lang="bash">
 
+
os server rescue
 
+
    <server>
<pre><nowiki>#!bash
+
</source>
nova reboot [--hard] [--poll] <server>
+
|| no
 
+
|| ||
os reboot server [--hard|--soft] [--wait] <server>
+
<source lang="bash">
</nowiki></pre>
+
nova rescue
 
+
    <server>
 
+
</source>
<pre><nowiki>#!bash
+
|-
nova rebuild [--rebuild_password <rebuild_password>]
+
|
            [--poll]
+
<source lang="bash">
            <server> <image>
+
os server resize
 
+
    --flavor <flavor>
os rebuild server  
+
    [--wait]
          --image <image>
+
    <server>
          [--rebuild-password <rebuild-password>]
+
</source>
          [--wait]
+
|| no
          <server>
+
|| ||
</nowiki></pre>
+
<source lang="bash">
 
+
nova resize
 
+
    [--poll]
<pre><nowiki>#!bash
+
    <server>
nova rename <server> <name>
+
    <flavor>
 
+
</source>
os rename server <server> <new-name>
+
|-
</nowiki></pre>
+
|
 
+
<source lang="bash">
 
+
os server resize
<pre><nowiki>#!bash
+
    --confirm
nova rescue <server>
+
    <server>
 
+
</source>
os rescue server <server>
+
|| no
</nowiki></pre>
+
|| ||
 
+
<source lang="bash">
 
+
nova resize-confirm
<pre><nowiki>#!bash
+
    <server>
nova resize [--poll] <server> <flavor>
+
</source>
 
+
|-
os resize server --flavor <flavor> [--wait] <server>
+
|
</nowiki></pre>
+
<source lang="bash">
 
+
os server resume
 
+
    <server>
<pre><nowiki>#!bash
+
</source>
nova resize-confirm <server>
+
|| yes
 
+
|| ||
os resize server --confirm <server>
+
<source lang="bash">
</nowiki></pre>
+
nova resume
 
+
    <server>
 
+
</source>
<pre><nowiki>#!bash
+
|-
nova resume <server>
+
|
 
+
<source lang="bash">
os resume server <server>
+
os server set
</nowiki></pre>
+
    --meta-data <key=value>
 
+
    [--meta-data <key=value>] ...
 
+
    <server>
<pre><nowiki>#!bash
 
nova resize-revert <server>
 
 
 
os resize server --revert <server>
 
</nowiki></pre>
 
 
 
 
 
<pre><nowiki>#!bash
 
nova meta <server> <action> <key=value> [<key=value> ...]
 
 
 
os set server
 
          --meta-data <key=value>
 
          [--meta-data <key=value>] ...
 
          <server>
 
 
os unset server
 
os unset server
          --meta-data <key>
+
    --meta-data <key>
          [--meta-data <key>] ...
+
    [--meta-data <key>] ...
          <server>
+
    <server>
</nowiki></pre>
+
</source>
 +
|| no
 +
|| ||
 +
<source lang="bash">
 +
nova meta
 +
    <server>
 +
    <action>
 +
    <key=value>
 +
    [<key=value> ...]
 +
</source>
 +
|-
 +
|
 +
<source lang="bash">
 +
os server set
 +
    --root-password
 +
    <server>
 +
</source>
 +
|| no
 +
|| ||
 +
<source lang="bash">
 +
nova root-password
 +
    <server>
 +
</source>
 +
|-
 +
|
 +
<source lang="bash">
 +
os server show
 +
    <server>
 +
</source>
 +
|| yes
 +
|| ||
 +
<source lang="bash">
 +
nova show
 +
    <server>
 +
</source>
 +
|-
 +
|
 +
<source lang="bash">
 +
os server ssh
 +
    [--port PORT]
 +
    --private]
 +
    [--ipv6]
 +
    [--login <login>]
 +
    <server>
 +
</source>
 +
|| no
 +
|| ||
 +
<source lang="bash">
 +
nova ssh
 +
    [--port PORT]
 +
    [--private]
 +
    [--ipv6]
 +
    [--login <login>]
 +
    <server>
 +
</source>
 +
|-
 +
|
 +
<source lang="bash">
 +
os server suspend
 +
    <server>
 +
</source>
 +
|| yes
 +
|| ||
 +
<source lang="bash">
 +
nova suspend
 +
    <server>
 +
</source>
 +
|-
 +
|
 +
<source lang="bash">
 +
os server unlock
 +
    <server>
 +
</source>
 +
|| no
 +
|| ||
 +
<source lang="bash">
 +
nova unlock
 +
    <server>
 +
</source>
 +
|-
 +
|
 +
<source lang="bash">
 +
os server unpause
 +
    <server>
 +
</source>
 +
|| yes
 +
|| ||
 +
<source lang="bash">
 +
nova unpause
 +
    <server>
 +
</source>
 +
|-
 +
|
 +
<source lang="bash">
 +
os server unrescue
 +
    <server>
 +
</source>
 +
|| no
 +
|| ||
 +
<source lang="bash">
 +
nova unrescue
 +
    <server>
 +
</source>
 +
|}
  
 +
==== usage ====
  
<pre><nowiki>#!bash
+
{| class="wikitable"
nova root-password <server>
+
|-
 +
! OSC Command !! Implemented !! !! Keystone command
 +
|-
 +
|
 +
<source lang="bash">
 +
os usage list
 +
    [--start <start>]
 +
    [--end <end>]
 +
</source>
 +
|| no
 +
|| ||
 +
<source lang="bash">
 +
nova usage-list
 +
    [--start <start>]
 +
    [--end <end>]
 +
</source>
 +
|}
  
os set server --root-password <server>
 
</nowiki></pre>
 
  
 +
==== volume ====
  
<pre><nowiki>#!bash
+
{| class="wikitable"
nova show <server>
+
|-
 +
! OSC Command !! Implemented !! !! Keystone command
 +
|-
 +
|
 +
<source lang="bash">
 +
os volume attach
 +
    <volume>
 +
    <server>
 +
    <device>
 +
</source>
 +
|| no
 +
|| ||
 +
<source lang="bash">
 +
nova volume-attach
 +
    <server>
 +
    <volume>
 +
    <device>
 +
</source>
 +
|-
 +
|
 +
<source lang="bash">
 +
os volume detach
 +
    <server>
 +
    <volume>
 +
</source>
 +
|| no
 +
|| ||
 +
<source lang="bash">
 +
nova volume-detach
 +
    <server>
 +
    <volume>
 +
</source>
 +
|}
  
os show server <server>
 
</nowiki></pre>
 
  
 +
==== x509-cert ====
  
<pre><nowiki>#!bash
+
See [[#credentials|credentials]] in the [[#Cross_API|cross API section]].
nova ssh [--port PORT] [--private] [--ipv6] [--login <login>] <server>
 
  
os ssh server
+
==== x509-root-cert ====
          [--port PORT]
 
          [--private]
 
          [--ipv6]
 
          [--login <login>]
 
          <server>
 
</nowiki></pre>
 
 
 
 
 
<pre><nowiki>#!bash
 
nova suspend <server>
 
 
 
os suspend server <server>
 
</nowiki></pre>
 
 
 
 
 
<pre><nowiki>#!bash
 
nova unlock <server>
 
 
 
os unlock server <server>
 
</nowiki></pre>
 
 
 
 
 
<pre><nowiki>#!bash
 
nova unpause <server>
 
 
 
os unpause server <server>
 
</nowiki></pre>
 
 
 
 
 
<pre><nowiki>#!bash
 
nova unrescue <server>
 
 
 
os unrescue server <server>
 
</nowiki></pre>
 
 
 
 
 
'''usage'''
 
 
 
<pre><nowiki>#!bash
 
nova usage-list [--start <start>] [--end <end>]
 
 
 
os list usage ...
 
</nowiki></pre>
 
 
 
 
 
'''volume'''
 
 
 
<pre><nowiki>#!bash
 
nova volume-attach <server> <volume> <device>
 
 
 
os attach volume ...
 
</nowiki></pre>
 
 
 
 
 
<pre><nowiki>#!bash
 
nova volume-create [--snapshot_id <snapshot_id>]
 
                  [--display_name <display_name>]
 
                  [--display_description <display_description>]
 
                  [--volume_type <volume_type>]
 
                  <size>
 
 
 
os create volume ...
 
</nowiki></pre>
 
 
 
 
 
<pre><nowiki>#!bash
 
nova volume-delete <volume>
 
 
 
os delete volume ...
 
</nowiki></pre>
 
 
 
 
 
<pre><nowiki>#!bash
 
nova volume-detach <server> <volume>
 
 
 
os detach volume ...
 
</nowiki></pre>
 
 
 
 
 
<pre><nowiki>#!bash
 
nova nova volume-list
 
 
 
os list volume
 
</nowiki></pre>
 
 
 
 
 
<pre><nowiki>#!bash
 
nova volume-show <volume>
 
 
 
os show volume ...
 
</nowiki></pre>
 
 
 
 
 
'''volume-snapshot'''
 
 
 
<pre><nowiki>#!bash
 
nova volume-snapshot-create [--force <True|False>]
 
                            [--display_name <display_name>]
 
                            [--display_description <display_description>]
 
                            <volume_id>
 
 
 
os create volume-snapshot ...
 
</nowiki></pre>
 
 
 
 
 
<pre><nowiki>#!bash
 
nova volume-snapshot-delete <snapshot_id>
 
 
 
os delete volume-snapshot ...
 
</nowiki></pre>
 
 
 
 
 
<pre><nowiki>#!bash
 
nova volume-snapshot-list
 
 
 
os list volume-snapshot
 
</nowiki></pre>
 
 
 
 
 
<pre><nowiki>#!bash
 
nova volume-snapshot-show <snapshot>
 
 
 
os show volume-snapshot
 
</nowiki></pre>
 
 
 
 
 
'''volume-type'''
 
 
 
<pre><nowiki>#!bash
 
nova volume-type-create <name>
 
 
 
os create volume-type ...
 
</nowiki></pre>
 
 
 
 
 
<pre><nowiki>#!bash
 
nova volume-type-delete <id>
 
 
 
os delete volume-type ...
 
</nowiki></pre>
 
 
 
 
 
<pre><nowiki>#!bash
 
nova volume-type-list
 
 
 
os list volume-type
 
</nowiki></pre>
 
 
 
 
 
'''x509-cert'''
 
 
 
<pre><nowiki>#!bash
 
nova x509-create-cert [<private_key_file>] [<x509_cert>]
 
 
 
os create x509-cert ...
 
</nowiki></pre>
 
 
 
 
 
'''x509-root-cert'''
 
 
 
<pre><nowiki>#!bash
 
nova x509-get-root-cert [<filename>]
 
 
 
os show x509-root-cert ...
 
</nowiki></pre>
 
  
 +
See [[#credentials|credentials]] in the [[#Cross_API|cross API section]].
  
 
== Image ==
 
== Image ==
  
 
+
{| class="wikitable"
<pre><nowiki>#!csv ,
+
|-
Nova Option, Environment Variable, , OSC Option, Environment Variable
+
! OSC Option !!  Environment Variable !!  !!  Glance Option !!  Environment Variable
--force,, ,,
+
|-  
--dry-run,, ,,
+
| --os-image-api-version <ver> || OS_IMAGE_API_VERSION ||  || --os-image-api-version <ver> || OS_IMAGE_API_VERSION
--os-image-url <url>,OS_IMAGE_URL, ,,
+
|-
--os-image-api-version <ver>,OS_IMAGE_API_VERSION, ,--os-image-api-version <ver>,OS_IMAGE_API_VERSION
+
|  ||  || || --os-service-type <type> || OS_SERVICE_TYPE
--os-service-type <type>,OS_SERVICE_TYPE, ,,
+
|-
--os-endpoint-type <type>,OS_ENDPOINT_TYPE, ,,
+
|  ||  || || --os-endpoint-type <type> || OS_ENDPOINT_TYPE
--cert-file <file>,, ,,
+
|-
--key-file <file>,, ,,
+
| --os-token <token> || OS_TOKEN || || --os-auth-token <token> || OS_AUTH_TOKEN
--timeout <seconds>,, ,,
+
|-
--no-ssl-compression,, ,,
+
| --os-url <url> || OS_URL || || --os-image-url <url> || OS_IMAGE_URL
</nowiki></pre>
+
|-
 +
|  ||  || || --os-cacert <file> || OS_CACERT
 +
|-
 +
|  ||  || || --cert-file <file> || CERT_FILE
 +
|-
 +
|  ||  || || --key-file <key-file> || KEY_FILE
 +
|-  
 +
|  ||  || || --no-ssl-compression ||
 +
|-
 +
|}
  
  
=== API v2.0 ===
+
=== API v1 ===
  
'''image'''
+
==== image ====
  
<pre><nowiki>#!bash
+
{| class="wikitable"
glance image-create [--id <IMAGE_ID>] [--name <NAME>]
+
|-
                                  [--disk-format <CONTAINER_FORMAT>]
+
! OSC Command !! Implemented !! !! Glance command
                                  [--container-format <DISK_FORMAT>]
+
|-
                                  [--owner <TENANT_ID>] [--size <SIZE>]
+
|
                                  [--min-disk <DISK_GB>] [--min-ram <DISK_RAM>]
+
<source lang="bash">
                                  [--location <IMAGE_URL>] [--checksum <CHECKSUM>]
+
os image create
                                  [--copy-from <IMAGE_URL>] [--public] [--protected]
+
    [--id <id>]
                                  [--property <key=value>]
+
    [--store <store>]
 
+
    [--container-format <format>]
os create image ...
+
    [--disk-format <format>]
</nowiki></pre>
+
    [--owner <tenant>]
 +
    [--size <size-bytes>]
 +
    [--min-disk <disk-gb>]
 +
    [--min-ram <ram-mg>]
 +
    [--location <image-url>]
 +
    [--copy-from <image-url>]
 +
    [--file <local-filename>]
 +
    [--checksum <checksum>]
 +
    [--protected | --unprotected]
 +
    [--public | --private]
 +
    [--property <key=value>]
 +
    <name>
 +
</source>
 +
|| yes
 +
|| ||
 +
<source lang="bash">
 +
glance image-create
 +
    [--id <IMAGE_ID>]
 +
    [--name <NAME>]
 +
    [--disk-format <DISK_FORMAT>]
 +
    [--container-format <CONTAINER_FORMAT>]
 +
    [--owner <TENANT_ID>]
 +
    [--size <SIZE>]
 +
    [--min-disk <DISK_GB>]
 +
    [--min-ram <DISK_RAM>]
 +
    [--location <IMAGE_URL>]
 +
    [--checksum <CHECKSUM>]
 +
    [--copy-from <IMAGE_URL>]
 +
    [--is-public [True|False]]
 +
    [--is-protected [True|False]]
 +
    [--property <key=value>]
 +
    [--human-readable]
 +
</source>
 +
|-
 +
|
 +
<source lang="bash">
 +
os image delete
 +
    <image>
 +
</source>
 +
|| yes
 +
|| ||
 +
<source lang="bash">
 +
glance image-delete
 +
    <IMAGE_ID>
 +
</source>
 +
|-
 +
|
 +
<source lang="bash">
 +
os image list
 +
    [--page-size <size>]
 +
</source>
 +
|| yes
 +
|| ||
 +
<source lang="bash">
 +
glance image-list
 +
</source>
 +
|-
 +
|
 +
<source lang="bash">
 +
os image save
 +
    [--file <filename>]
 +
    <image>
 +
</source>
 +
|| yes
 +
|| ||
 +
<source lang="bash">
 +
glance image-download
 +
    [--file <FILE>]
 +
    <IMAGE>
 +
</source>
 +
|-
 +
|
 +
<source lang="bash">
 +
os image set
 +
    [--name <name>]
 +
    [--owner <tenant>]
 +
    [--min-disk <disk-gb>]
 +
    [--min-ram <ram-mg>]
 +
    [--protected | --unprotected]
 +
    [--public | --private]
 +
    [--property <key=value>]
 +
    <image>
 +
</source>
 +
|| yes
 +
|| ||
 +
<source lang="bash">
 +
glance image-update
 +
    [--name <NAME>]
 +
    [--disk-format <DISK_FORMAT>]
 +
    [--container-format <CONTAINER_FORMAT>]
 +
    [--owner <TENANT_ID>]
 +
    [--size <SIZE>]
 +
    [--min-disk <DISK_GB>]
 +
    [--min-ram <DISK_RAM>]
 +
    [--location <IMAGE_URL>]
 +
    [--file <FILE>]
 +
    [--checksum <CHECKSUM>]
 +
    [--copy-from <IMAGE_URL>]
 +
    [--is-public [True|False]]
 +
    [--is-protected [True|False]]
 +
    [--property <key=value>]
 +
    [--purge-props]
 +
    [--human-readable]
 +
    <IMAGE>
 +
</source>
 +
|-
 +
|
 +
<source lang="bash">
 +
os image show
 +
    <image>
 +
</source>
 +
|| yes
 +
|| ||
 +
<source lang="bash">
 +
glance image-show
 +
    [--human-readable]
 +
    <IMAGE>
 +
</source>
 +
|}
  
 +
=== API v2 ===
  
<pre><nowiki>#!bash
+
==== image ====
glance image-delete <IMAGE_ID>
 
  
os delete image ...
+
{| class="wikitable"
</nowiki></pre>
+
|-
 
+
! OSC Command !! Implemented !! !! Glance command
 
+
|-
<pre><nowiki>#!bash
+
|
 +
<source lang="bash">
 +
os image delete
 +
    <image>
 +
</source>
 +
|| yes
 +
|| ||
 +
<source lang="bash">
 +
glance image-delete
 +
    <IMAGE_ID>
 +
</source>
 +
|-
 +
|
 +
<source lang="bash">
 +
os image list
 +
    [--page-size <size>]
 +
</source>
 +
|| yes
 +
|| ||
 +
<source lang="bash">
 
glance image-list
 
glance image-list
 +
</source>
 +
|-
 +
|
 +
<source lang="bash">
 +
</source>
 +
|| no
 +
|| ||
 +
<source lang="bash">
 +
glance member-images
 +
    [options]
 +
    <MEMBER>
 +
</source>
 +
|-
 +
|
 +
<source lang="bash">
 +
os image save
 +
    [--file <filename>]
 +
    <image>
 +
</source>
 +
|| yes
 +
|| ||
 +
<source lang="bash">
 +
glance image-download
 +
    [--file <FILE>]
 +
    <IMAGE>
 +
</source>
 +
|-
 +
|
 +
<source lang="bash">
 +
os image set
 +
    [--id <id>]
 +
    [--store <store>]
 +
    [--container-format <format>]
 +
    [--disk-format <format>]
 +
    [--owner <tenant>]
 +
    [--size <size-bytes>]
 +
    [--min-disk <disk-gb>]
 +
    [--min-ram <ram-mg>]
 +
    [--location <image-url>]
 +
    [--copy-from <image-url>]
 +
    [--file <local-filename>]
 +
    [--checksum <checksum>]
 +
    [--protected | --unprotected]
 +
    [--public | --private]
 +
    [--property <key=value>]
 +
    <name>
 +
</source>
 +
|| no
 +
|| ||
 +
<source lang="bash">
 +
glance image-update
 +
    [--name <NAME>]
 +
    [--disk-format <DISK_FORMAT>]
 +
    [--container-format <CONTAINER_FORMAT>]
 +
    [--owner <TENANT_ID>]
 +
    [--size <SIZE>]
 +
    [--min-disk <DISK_GB>]
 +
    [--min-ram <DISK_RAM>]
 +
    [--location <IMAGE_URL>]
 +
    [--file <FILE>]
 +
    [--checksum <CHECKSUM>]
 +
    [--copy-from <IMAGE_URL>]
 +
    [--is-public [True|False]]
 +
    [--is-protected [True|False]]
 +
    [--property <key=value>]
 +
    [--purge-props]
 +
    [--human-readable]
 +
    <IMAGE>
 +
</source>
 +
|-
 +
|
 +
<source lang="bash">
 +
os image show
 +
    <image>
 +
</source>
 +
|| yes
 +
|| ||
 +
<source lang="bash">
 +
glance image-show
 +
    [--human-readable]
 +
    <IMAGE>
 +
</source>
 +
|}
  
os list image ...
 
</nowiki></pre>
 
 
 
<pre><nowiki>#!bash
 
glance image-show <IMAGE_ID>
 
 
os show image ...
 
</nowiki></pre>
 
 
 
<pre><nowiki>#!bash
 
glance member-images [options] <MEMBER>
 
 
os list image --member <member> [options]
 
</nowiki></pre>
 
 
 
<pre><nowiki>#!bash
 
glance show [options] <ID>
 
 
os show image ...
 
</nowiki></pre>
 
  
 +
==== image-member ====
  
<pre><nowiki>#!bash
+
Need to discuss the future of these commands with markwash...
glance update [options] <ID> <field1=value1 field2=value2 ...>
 
  
os set image ...
+
<source lang="bash">
</nowiki></pre>
 
 
 
 
 
'''image-member'''
 
 
 
<pre><nowiki>#!bash
 
 
glance member-create [--can-share] <IMAGE_ID> <TENANT_ID>
 
glance member-create [--can-share] <IMAGE_ID> <TENANT_ID>
  
 
os create image-member ...
 
os create image-member ...
</nowiki></pre>
+
</source>
  
  
<pre><nowiki>#!bash
+
<source lang="bash">
 
glance member-delete <IMAGE_ID> <TENANT_ID>
 
glance member-delete <IMAGE_ID> <TENANT_ID>
  
 
os list image-member <image> [options]
 
os list image-member <image> [options]
</nowiki></pre>
+
</source>
  
  
<pre><nowiki>#!bash
+
<source lang="bash">
 
glance member-delete [options] <ID> <MEMBER>
 
glance member-delete [options] <ID> <MEMBER>
  
 
os delete image-member ...
 
os delete image-member ...
</nowiki></pre>
+
</source>
  
  
<pre><nowiki>#!bash
+
<source lang="bash">
 
glance member-list [--image-id <IMAGE_ID>] [--tenant-id <TENANT_ID>]
 
glance member-list [--image-id <IMAGE_ID>] [--tenant-id <TENANT_ID>]
  
 
os list image-member ...
 
os list image-member ...
</nowiki></pre>
+
</source>
 
 
  
 
== Volume ==
 
== Volume ==
  
 
+
{| class="wikitable"
<pre><nowiki>#!csv ,
+
|-
Cinder Option, Environment Variable, , OSC Option, Environment Variable
+
! Cinder Option !!  Environment Variable !!  !!  OSC Option !!  Environment Variable
--os-volume-api-version <ver>,OS_VOLUME_API_VERSION, ,--os-volume-api-version <ver>,OS_VOLUME_API_VERSION
+
|-
--service-type <type>,, ,,
+
| --os-volume-api-version <ver> || OS_VOLUME_API_VERSION ||  || --os-volume-api-version <ver> || OS_VOLUME_API_VERSION
--service-name <name>,CINDER_SERVICE_NAME, ,,
+
|-
--volume-service-name <name>,CINDER_VOLUME_SERVICE_NAME, ,,
+
| --service-type <type> ||  ||  ||  ||
--endpoint-type <type>,CINDER_ENDPOINT_TYPE, ,,
+
|-
--retries <int>,, ,,
+
| --service-name <name> || CINDER_SERVICE_NAME ||  ||  ||
</nowiki></pre>
+
|-
 +
| --volume-service-name <name> || CINDER_VOLUME_SERVICE_NAME ||  ||  ||
 +
|-
 +
| --endpoint-type <type> || CINDER_ENDPOINT_TYPE ||  ||  ||
 +
|-
 +
| --retries <int> ||  ||  ||  ||
 +
|-
 +
|}
  
  
 
=== API v1.0 ===
 
=== API v1.0 ===
  
'''credentials'''
+
==== limits ====
 
 
<pre><nowiki>#!bash
 
cinder credentials
 
 
 
os list credential
 
</nowiki></pre>
 
  
'''limits'''
+
See [[#limits|limits]] in the [[#Cross_API|cross API section]].
  
<pre><nowiki>#!bash
+
==== quota ====
cinder rate-limits
 
  
os list limit --rate
+
See [[#quota|quota]] in the [[#Cross_API|cross API section]].
</nowiki></pre>
 
  
 +
==== snapshot ====
  
<pre><nowiki>#!bash
+
{| class="wikitable"
cinder absolute-limits
+
|-
 
+
! OSC Command !! Implemented !! !! Cinder command
os list limit --absolute
+
|-
</nowiki></pre>
+
|
 
+
<source lang="bash">
'''snapshot'''
+
os snapshot create
 
+
    --name <name>
<pre><nowiki>#!bash
+
    [--description <description>]
 +
    [--force]
 +
    <volume>
 +
</source>
 +
|| yes
 +
|| ||
 +
<source lang="bash">
 
cinder snapshot-create
 
cinder snapshot-create
<volume-id>
+
    --force <True|False>
--force <True|False>
+
    --display-name <display-name>
--display-name <display-name>
+
    --display-description <display-description>
--display-description <display-description>
+
    <volume-id>
 
+
</source>
os create snapshot
+
|-
--force
+
|
--display-name <display-name>
+
<source lang="bash">
--display-description <display-description>
+
os snapshot delete
<volume-id>
+
    <snapshot>
</nowiki></pre>
+
</source>
 
+
|| yes
 
+
|| ||
<pre><nowiki>#!bash
+
<source lang="bash">
cinder snapshot-delete <snapshot-id>
+
cinder snapshot-delete
 
+
    <snapshot-id>
os delete snapshot <snapshot-id>
+
</source>
</nowiki></pre>
+
|-
 
+
|
 
+
<source lang="bash">
<pre><nowiki>#!bash
+
os snapshot list
cinder snapshot-list
+
</source>
--all-tenants [<0|1>]
+
|| yes (no opts yet)
--display-name <display-name>
+
|| ||
--status <status>
+
<source lang="bash">
--volume-id <volume-id>
+
cinder snapshot-list  
 
+
    --all-tenants [<0|1>]
os list snapshot
+
    --display-name <display-name>
--all-tenants [<0|1>]
+
    --status <status>
--display-name <display-name>
+
    --volume-id <volume-id>
--status <status>
+
</source>
--volume-id <volume-id>
+
|-
</nowiki></pre>
+
|
 
+
<source lang="bash">
 
+
os snapshot set
<pre><nowiki>#!bash
+
    [--name <new-name>]
 +
    [--description <new-description>]
 +
    <snapshot>
 +
</source>
 +
|| yes
 +
|| ||
 +
<source lang="bash">
 
cinder snapshot-rename
 
cinder snapshot-rename
--display-description <display-description>
+
    --display-description <display-description>
<snapshot-id>
+
    --display-name <display-name>
<display-name>
+
    <snapshot-id>
 
+
</source>
os update snapshot
+
|-
--display-description <display-description>
+
|
<snapshot-id>
+
<source lang="bash">
<display-name>
+
os snapshot show
</nowiki></pre>
+
    <snapshot>
 
+
</source>
 
+
|| yes
<pre><nowiki>#!bash
+
|| ||
cinder snapshot-show <snapshot-id>
+
<source lang="bash">
 
+
cinder snapshot-show
os show snapshot <snapshot-id>
+
    <snapshot-id>
</nowiki></pre>
+
</source>
 
+
|}
'''type'''
 
 
 
<pre><nowiki>#!bash
 
cinder type-create <type-name>
 
 
 
os create type <type-name>
 
</nowiki></pre>
 
 
 
 
 
<pre><nowiki>#!bash
 
cinder type-delete <type-id>
 
 
 
os delete type <type>
 
</nowiki></pre>
 
 
 
 
 
<pre><nowiki>#!bash
 
cinder type-list
 
 
 
os list type
 
</nowiki></pre>
 
 
 
  
<pre><nowiki>#!bash
+
==== volume ====
cinder extra-specs-list
 
  
os tbd
+
{| class="wikitable"
</nowiki></pre>
+
|-
 
+
! OSC Command !! Implemented !! !! Cinder command
 
+
|-
<pre><nowiki>#!bash
+
|
cinder type-key <type-name-or-id> <action (set|unset)> <key=value>
+
<source lang="bash">
 
+
os volume create
os tbd
+
    --size <size>
</nowiki></pre>
+
    [--description <description>]
 
+
    [--volume-type <volume-type>]
'''volume'''
+
    [--snapshot-id <snapshot-id>]
 
+
    [--source <volid>]
<pre><nowiki>#!bash
+
    [--image <image-id>]
 +
    [--availability-zone <availability-zone>]
 +
    [--property <key=value>]
 +
    [--user <user>]          # admin only
 +
    [--project <project>]    # admin only
 +
    <name>
 +
</source>
 +
|| yes
 +
|| ||
 +
<source lang="bash">
 
cinder create
 
cinder create
[--snapshot-id <snapshot-id>]
+
    [--snapshot-id <snapshot-id>]
[--source-volid <source-volid>]
+
    [--source-volid <source-volid>]
[--image-id <image-id>]
+
    [--image-id <image-id>]
[--display-name <display-name>]
+
    [--display-name <display-name>]
[--display-description <display-description>]
+
    [--display-description <display-description>]
[--volume-type <volume-type>]
+
    [--volume-type <volume-type>]
[--availability-zone <availability-zone>]
+
    [--availability-zone <availability-zone>]
[--metadata [<key=value>]]
+
    [--metadata <key=value>]
<size>
+
    <size>
 
+
</source>
os create volume
+
|-
[--snapshot-id <snapshot-id>]
+
|
[--source-volid <source-volid>]
+
<source lang="bash">
[--image-id <image-id>]
+
os volume delete
[--display-name <display-name>]
+
    [--force]
[--display-description <display-description>]
+
    <volume>
[--volume-type <volume-type>]
+
</source>
[--availability-zone <availability-zone>]
+
|| yes
[--metadata [<key=value>]]
+
|| ||
<size>
+
<source lang="bash">
</nowiki></pre>
+
cinder delete
 +
    <volume-id>
  
 
+
cinder force-delete
<pre><nowiki>#!bash
+
    <volume-id>
cinder delete <volume-id>
+
</source>
 
+
|-
os delete volume <volume-id>
+
|
</nowiki></pre>
+
<source lang="bash">
 
+
os volume list
 
+
    [--name <name>]
<pre><nowiki>#!bash
+
    [--status <status>]
 +
    [--long]
 +
    [--all-tenants]          # admin only
 +
</source>
 +
|| yes
 +
|| ||
 +
<source lang="bash">
 
cinder list  
 
cinder list  
--all-tenants [<0|1>]
+
    --all-tenants [<0|1>]
--display-name <display-name>
+
    --display-name <display-name>
--status <status>
+
    --status <status>
 +
</source>
 +
|-
 +
|
 +
<source lang="bash">
 +
os volume set
 +
    [--name <new-name>]
 +
    [--description <new-description>]
 +
    [--property <key=value>]
 +
    <volume>
 +
</source>
 +
|| yes
 +
|| ||
 +
<source lang="bash">
 +
cinder metadata
 +
    <volume-id>
 +
    <action>
 +
    <key=value>
  
os list volume
 
--long
 
</nowiki></pre>
 
 
 
<pre><nowiki>#!bash
 
 
cinder rename
 
cinder rename
--display-description <display-description>
+
    --display-description <display-description>
<volume-id>
+
    <volume-id>
<display-name>
+
    <display-name>
 +
</source>
 +
|-
 +
|
 +
<source lang="bash">
 +
os volume show
 +
    <volume>
 +
</source>
 +
|| yes
 +
|| ||
 +
<source lang="bash">
 +
cinder show
 +
    <volume-id>
 +
</source>
 +
|-
 +
|
 +
<source lang="bash">
 +
os volume unset
 +
    [--property <key=value>]
 +
    <volume>
 +
</source>
 +
|| yes
 +
|| ||
 +
<source lang="bash">
 +
</source>
 +
|}
  
os update volume
+
==== volume-type ====
--display-description <display-description>
 
<volume-id>
 
<display-name>
 
</nowiki></pre>
 
  
 +
{| class="wikitable"
 +
|-
 +
! OSC Command !! Implemented !! !! Cinder command
 +
|-
 +
|
 +
<source lang="bash">
 +
os volume type create
 +
    [--property <key=value>]
 +
    <name>
 +
</source>
 +
|| yes
 +
|| ||
 +
<source lang="bash">
 +
cinder type-create
 +
    <type-name>
 +
</source>
 +
|-
 +
|
 +
<source lang="bash">
 +
os volume type delete
 +
    <volume-type>
 +
</source>
 +
|| yes
 +
|| ||
 +
<source lang="bash">
 +
cinder type-delete
 +
    <type-id>
 +
</source>
 +
|-
 +
|
 +
<source lang="bash">
 +
os volume type list
 +
    [--long]
 +
</source>
 +
|| yes
 +
|| ||
 +
<source lang="bash">
 +
cinder type-list
  
<pre><nowiki>#!bash
+
cinder extra-specs-list
cinder show <volume-id>
+
</source>
 
+
|-
os show volume <volume-id>
+
|
</nowiki></pre>
+
<source lang="bash">
 
+
os volume type set
 
+
    [--property <key=value>]
<pre><nowiki>#!bash
+
    <volume-type>
cinder force-delete <volume-id>
+
</source>
 
+
|| yes
os tbd
+
|| ||
</nowiki></pre>
+
<source lang="bash">
 
+
cinder type-key
 
+
    <type-id>
<pre><nowiki>#!bash
+
    <set>
cinder metadata
+
    <key=value>
<volume-id>
+
</source>
<action>
+
|-
<key=value>
+
|
 
+
<source lang="bash">
os tbd
+
os volume type unset
</nowiki></pre>
+
    [--property <key>]
 
+
    <volume-type>
 +
</source>
 +
|| yes
 +
|| ||
 +
<source lang="bash">
 +
cinder type-key
 +
    <type-id>
 +
    <unset>
 +
    <key>
 +
</source>
 +
|}
  
 
== Network ==
 
== Network ==
  
'''quantum'''
+
The Network commands in <code>quantum</code> have been in a bit of flux and are currently out of scope for OpenStackClient.
  
<pre><nowiki>#!csv ,
+
{| class="wikitable"
Command-line Option,Environment Variable
+
|-
-H HOST|--host=HOST
+
! Command-line Option !! Environment Variable
-p PORT|--port=PORT
+
|-
-s|--ssl
+
| -H HOST|--host=HOST
-v|--verbose
+
|-
-f LOGFILE|--logfile=LOGFILE
+
| -p PORT|--port=PORT
-t TOKEN|--token=TOKEN
+
|-
--version=VERSION,QUANTUM_VERSION
+
| -s|--ssl
</nowiki></pre>
+
|-
 +
| -v|--verbose
 +
|-
 +
| -f LOGFILE|--logfile=LOGFILE
 +
|-
 +
| -t TOKEN|--token=TOKEN
 +
|-
 +
| --version=VERSION || QUANTUM_VERSION
 +
|}
  
  
Line 2,135: Line 3,742:
 
'''iface'''
 
'''iface'''
  
<pre><nowiki>#!bash
+
<source lang="bash">
 
plug_iface <tenant-id> <net-id> <port-id> <iface-id>
 
plug_iface <tenant-id> <net-id> <port-id> <iface-id>
  
 
add interface <tenant> <network> <port> <interface>
 
add interface <tenant> <network> <port> <interface>
</nowiki></pre>
+
</source>
  
  
<pre><nowiki>#!bash
+
<source lang="bash">
 
show_iface <tenant-id> <net-id> <port-id>
 
show_iface <tenant-id> <net-id> <port-id>
  
 
show interface <tenant> <network> <port>
 
show interface <tenant> <network> <port>
</nowiki></pre>
+
</source>
  
  
<pre><nowiki>#!bash
+
<source lang="bash">
 
unplug_iface <tenant-id> <net-id> <port-id>
 
unplug_iface <tenant-id> <net-id> <port-id>
  
 
remove interface <tenant> <network> <port>
 
remove interface <tenant> <network> <port>
</nowiki></pre>
+
</source>
  
  
 
'''net'''
 
'''net'''
  
<pre><nowiki>#!bash
+
<source lang="bash">
 
create_net <tenant-id> <net-name>
 
create_net <tenant-id> <net-name>
  
 
create network <tenant> <network-name>
 
create network <tenant> <network-name>
</nowiki></pre>
+
</source>
  
  
<pre><nowiki>#!bash
+
<source lang="bash">
 
delete_net <tenant-id> <net-id>
 
delete_net <tenant-id> <net-id>
  
 
delete <tenant> <network>
 
delete <tenant> <network>
</nowiki></pre>
+
</source>
  
  
<pre><nowiki>#!bash
+
<source lang="bash">
 
list_nets <tenant-id>
 
list_nets <tenant-id>
  
 
list network <tenant>
 
list network <tenant>
</nowiki></pre>
+
</source>
  
  
<pre><nowiki>#!bash
+
<source lang="bash">
 
list_nets_detail <tenant-id>
 
list_nets_detail <tenant-id>
  
 
list network --detail <tenant>
 
list network --detail <tenant>
</nowiki></pre>
+
</source>
  
  
<pre><nowiki>#!bash
+
<source lang="bash">
 
show_net <tenant-id> <net-id>
 
show_net <tenant-id> <net-id>
  
 
show network <tenant> <network>
 
show network <tenant> <network>
</nowiki></pre>
+
</source>
  
  
<pre><nowiki>#!bash
+
<source lang="bash">
 
show_net_detail <tenant-id> <net-id>
 
show_net_detail <tenant-id> <net-id>
  
 
show network --detail <tenant> <network>
 
show network --detail <tenant> <network>
</nowiki></pre>
+
</source>
  
  
<pre><nowiki>#!bash
+
<source lang="bash">
 
update_net <tenant-id> <net-id> <new-name>
 
update_net <tenant-id> <net-id> <new-name>
  
 
set network <tenant> <network> --name <name>
 
set network <tenant> <network> --name <name>
</nowiki></pre>
+
</source>
  
  
 
'''port'''
 
'''port'''
  
<pre><nowiki>#!bash
+
<source lang="bash">
 
create_port <tenant-id> <net-id>
 
create_port <tenant-id> <net-id>
  
 
create port <tenant> <network>
 
create port <tenant> <network>
</nowiki></pre>
+
</source>
  
  
<pre><nowiki>#!bash
+
<source lang="bash">
 
delete_port <tenant-id> <net-id> <port-id>
 
delete_port <tenant-id> <net-id> <port-id>
  
 
delete port <tenant> <network> <port>
 
delete port <tenant> <network> <port>
</nowiki></pre>
+
</source>
  
  
<pre><nowiki>#!bash
+
<source lang="bash">
 
list_ports <tenant-id> <net-id>
 
list_ports <tenant-id> <net-id>
  
 
list port <tenant> <network>
 
list port <tenant> <network>
</nowiki></pre>
+
</source>
  
  
<pre><nowiki>#!bash
+
<source lang="bash">
 
list_ports_detail <tenant-id> <net-id>
 
list_ports_detail <tenant-id> <net-id>
  
 
list port --detail <tenant> <network>
 
list port --detail <tenant> <network>
</nowiki></pre>
+
</source>
  
  
<pre><nowiki>#!bash
+
<source lang="bash">
 
show_port <tenant-id> <net-id> <port-id>
 
show_port <tenant-id> <net-id> <port-id>
  
 
show port <tenant> <network> <port>
 
show port <tenant> <network> <port>
</nowiki></pre>
+
</source>
  
  
<pre><nowiki>#!bash
+
<source lang="bash">
 
show_port_detail <tenant-id> <net-id> <port-id>
 
show_port_detail <tenant-id> <net-id> <port-id>
  
 
show port --detail <tenant> <network> <port>
 
show port --detail <tenant> <network> <port>
</nowiki></pre>
+
</source>
  
  
<pre><nowiki>#!bash
+
<source lang="bash">
 
update_port <tenant-id> <net-id> <port-id> <params>
 
update_port <tenant-id> <net-id> <port-id> <params>
  
 
set port <tenant> <network> <port> <params>
 
set port <tenant> <network> <port> <params>
</nowiki></pre>
+
</source>
 
 
  
 
= Options =
 
= Options =

Latest revision as of 02:10, 19 July 2013

Note: this page is being deprecated in favor of a new OpenStackClient Commands page with the correct name.

OpenStackClient Commands

Part of the UnifiedCLI proposal

[Note that the use of the word object here is its generic meaning as the target of an action.]

Command Structure

The OpenStackClient has a consistent and predictable format for all of its commands.

  • The top level command name is openstack
  • Sub-commands take the form:
openstack [<global-options>] <object> <verb> [<second-object>] [<command-local-arguments>]

Note: The command format change was committed on 13May2013. This is the new format.


Command Arguments

  • All long options names shall use '-' as the interpolation character (--like-this)
  • Authentication options conform to a revised version of the original CLIAuth
  • Global arguments generally have a corresponding environment variable that may also be used to set the value. If both are present, the command-line option takes priority. The environment variable names can be derived from the option by dropping the leading '--', converting all embedded dashes ('-') to underscores ('_'), and converting to upper case.
  • Positional arguments trail command options.
  • Some commands require two objects be acted upon, both objects appear in the command and if both are positional arguments they appear in the same order as in the command. In words it can be expressed as "(given) object1 add object2 (to it)"
 * <object-1> <verb> <object-2>
   * group add user
   * access token list   (here, 'access token' is a two-word single object)
   * user list role (needs more thinking)

Other

  • Arguments that normally require an ID in the OS-API may also use the name or other short identifier where reasonable to support
  • Optional machine-parsable format is available with list and show commands. List has an option for CSV-formatted output (see --format, --quote options for a list command) while show has an option for shell-assignment formatted output (see --format option for a show command).

Verbs

The verbs used by the default OpenStack clients are defined below to provide a consistent meaning to each action. Many of them have logical opposite actions. Those verbs with an opposite action are noted in parens if applicable.

  • authorize - authorize a token (used in OAuth)
  • add (remove) - add some object to a container object; the command is built in the order of "container add object" (<container> <object>), the positional arguments appear in the same order
  • attach (detach) - connect two objects (is this different from add/remove? not really, use the same argument order as add)
  • create (delete) - create a new occurrance of the specified object
  • delete (create) - delete a specific occurrance of the specified object
  • detach (attach) - disconnect two objects (is this different from add/remove?)
  • list - display summary information about multiple objects
  • lock (unlock)
  • migrate - move a server to a different host; --live performs a live migration if possible
  • pause (unpause) - stop a server and leave it in memory
  • reboot - forcibly reboot a server
  • rebuild - rebuild a server using (most of) the same arguments as in the original create
  • remove (add) - remove an object from a group of objects
  • rescue (unrescue) - reboot a server in a special rescue mode allowing access to the original disks
  • resize - change a server's flavor
  • resume (suspend) - return a suspended server to running state
  • save - download an object locally
  • set (unset) - set an attribute of the object, often called metadata
  • show - display detailed information about the specifiec object
  • ssh
  • suspend (resume) - stop a server and save to disk freeing memory
  • unlock (lock)
  • unpause (pause) - return a paused server to running state
  • unrescue (rescue) - return a server to normal boot mode
  • unset (set) - remove an attribute of the object


Objects

Note: these need a review to sync up with the revised object names without dashes ('-') in them.


Global Options

The common global options from the default OpenStack clients have been mapped to the set of global options below.

OSC Option Environment Variable Option Environment Variable
--version --version
--help --help
--debug --debug
--quiet
--verbose
--log-file <filename>
--os-auth-url <url> OS_AUTH_URL --os-auth-url <url> OS_AUTH_URL
--os-tenant-name <name> OS_TENANT_NAME --os-tenant-name <name> OS_TENANT_NAME
--os-tenant-id <id> OS_TENANT_ID --os-tenant-id <id> OS_TENANT_ID
--os-username <name> OS_USERNAME --os-username <name> OS_USERNAME
--os-password <pw> OS_PASSWORD --os-password <pw> OS_PASSWORD
--os-region-name <region> OS_REGION_NAME --os-region-name <region> OS_REGION_NAME
--os-cacert <file> OS_CACERT --os-cacert <file> OS_CACERT
--insecure
--os-use-keyring


Common Options

A number of options will appear in many commands and should have the same form in all commands to the extent possible.

Option Description Usual Default
--description describes an object none
--enable Used for setting the enabled state for an object n/a
--disable Used for setting the enabled state for an object n/a


Command Mapping Summary

This is an example mapping of the existing commands from Keystone (Identity), Nova (Compute), Glance (Image) and Cinder (Volume) to the <verb> <object> form for the OpenStackClient cli tool. It reduces both the number of verbs and objects by handling some of the smaller differences with command line options.

Further consolidation could be achieved by additional options or by introduction secondary objects to the syntax. For example, the credentials and x509-cert (and x509-root-cert) objects could be combined:


nova x509-create-cert [<pk-file>] [<x509-cert>] os create credentials --x509 [<pk-file>] [<x509-cert>]
nova credentials os show credentials
nova x509-get-root-cert os show credentials --x509 --root


Cross API

Object names that appear in multiple APIs, like quota, are handled by putting their command handler classes in openstackclient.common. If the number of these becomes large they should be moved into a subdirectory.

credentials

[consider rolling the ec2 creds into this too]

OSC Command Implemented Keystone command
os credentials create
    --x509
    [<private-key-file>]
    [<certificate-file>]
no
nova x509-create-cert
    [<pk-file>]
    [<x509-cert>]
os credentials show
    [--token]
    [--user]
    [--x509 [--root]]
no
nova credentials
    [--wrap <integer>]

nova x509-get-root-cert
    [<filename>]

limits

OSC Command Implemented Keystone command
os limits show
    --absolute [--reserved] | --rate
yes
nova absolute-limits
    [--reserved]

nova rate-limits

cinder absolute-limits

cinder rate-limits

quota

OSC Command Implemented Keystone command
os quota set
    # Compute settings
    [--cores <num-cores>]
    [--fixed-ips <num-fixed-ips>]
    [--floating-ips <num-floating-ips>]
    [--injected-file-size <injected-file-bytes>]
    [--injected-files <num-injected-files>]
    [--instances <num-instances>] 
    [--key-pairs <num-key-pairs>]
    [--properties <num-properties>]
    [--ram <ram-mb>] 

    # Volume settings
    [--gigabytes <new-gigabytes>]
    [--snapshots <new-snapshots>]
    [--volumes <new-volumes>]

    <project>
yes
nova quota-update
    [--instances <instances>] 
    [--cores <cores>]
    [--ram <ram>] 
    [--volumes <volumes>]
    [--gigabytes <gigabytes>]
    [--floating-ips <floating_ips>]
    [--metadata-items <metadata_items>]
    [--injected-files <injected_files>]
    [--injected-file-content-bytes <injected_file_content_bytes>]
    <tenant_id>

cinder quota-update
    [--volumes <volumes>]
    [--snapshots <snapshots>]
    [--gigabytes <gigabytes>]
    <tenant_id>
os quota set
    --class
    # Compute settings
    [--cores <num-cores>]
    [--fixed-ips <num-fixed-ips>]
    [--floating-ips <num-floating-ips>]
    [--injected-file-size <injected-file-bytes>]
    [--injected-files <num-injected-files>]
    [--instances <num-instances>] 
    [--key-pairs <num-key-pairs>]
    [--properties <num-properties>]
    [--ram <ram-mb>] 

    # Volume settings
    [--gigabytes <new-gigabytes>]
    [--snapshots <new-snapshots>]
    [--volumes <new-volumes>]

    <class>
yes
nova quota-class-update 
    [--instances <instances>] 
    [--cores <cores>]
    [--ram <ram>] 
    [--volumes <volumes>]
    [--gigabytes <gigabytes>]
    [--floating-ips <floating_ips>]
    [--metadata-items <metadata_items>]
    [--injected-files <injected_files>]
    [--injected-file-content-bytes <injected_file_content_bytes>]
    <class>

cinder quota-class-update
    [--volumes <volumes>]
    [--snapshots <snapshots>]
    [--gigabytes <gigabytes>]
    <tenant_id>
os quota show
    [--default]
    <project>
yes
nova quota-show
    [--tenant <tenant-id>]

cinder quota-show
    <tenant_id>

nova quota-defaults
    <tenant_id>

cinder quota-defaults
    <tenant_id>
os quota show
    --class
    <class>
yes
nova quota-class-show
    <class>

cinder quota-class-show
    <class>

Identity

OSC Option Environment Variable Keystone Option Environment Variable
--os-identity-api-version <ver> OS_IDENTITY_API_VERSION --os-identity-api-version <ver> OS_IDENTITY_API_VERSION
--os-token <token> OS_TOKEN --os-token <token> OS_SERVICE_TOKEN
--os-url <url> OS_URL --os-endpoint <url> OS_SERVICE_ENDPOINT
--os-cert <file> OS_CERT
--os-key <key-file> OS_KEY
--os-cache OS_CACHE
--force-new-token
--stale-duration <seconds>

API v2.0

catalog

OSC Command Implemented Keystone command
os catalog show
    [--service <service>]
no
keystone catalog
    [--service <service-type>]

ec2 credentials

OSC Command Implemented Keystone command
os ec2 credentials create
    [--project <project>]
    [--user <user>]
yes
keystone ec2-credentials-create
    [--user <user-id>] 
    [--tenant_id <tenant-id>]
os ec2 credentials delete
    [--user <user>]
    <access-key>
yes
keystone ec2-credentials-delete
    [--user <user-id>] 
    --access <access-key>
os ec2 credentials list
    [--user <user>]
yes
keystone ec2-credentials-list
    [--user <user-id>]
os ec2 credentials show
    [--user <user>]
    <access-key>
yes
keystone ec2-credentials-get
    [--user <user-id>] 
    --access <access-key>

endpoint

OSC Command Implemented Keystone command
os endpoint create
    --publicurl <public-url>
    [--adminurl <admin-url>]
    [--internalurl <internal-url>]
    [--region <endpoint-region>]
    <service>
yes
keystone endpoint-create
    [--region <endpoint-region>]
    [--service_id <service-id>]
    [--publicurl <public-url>]
    [--adminurl <admin-url>]
    [--internalurl <internal-url>]
os endpoint delete
    <endpoint-id>
yes
keystone endpoint-delete
    <endpoint-id>
os endpoint list
    [--long]
yes
keystone endpoint-list
os endpoint show
    [--type <endpoint-type>]
    [--attr <endpoint-attribute>] 
    [--value <endpoint-value>]
    [--all]
    <service-type>
yes
keystone endpoint-get
    --service <service-type>
    [--endpoint_type <endpoint-type>]
    [--attr <service-attribute>] 
    [--value <value>]

role

OSC Command Implemented Keystone command
os role create
    <role-name>
yes
keystone role-create --name
    <role-name>
os role delete
    <role>
yes
keystone role-delete
    <role-id>
os role list
yes
keystone role-list
os role show
    <role>
yes
keystone role-get
    <role-id>

service

OSC Command Implemented Keystone command
os service create
    [--type <service-type>]
    [--description <service-description>]
    <service-name>
yes
keystone service-create
    --name <name> 
    --type <type>
    [--description <service-description>]
os service delete
    <service>
yes
keystone service-delete
    <service-id>
os service list
    [--long]
yes
keystone service-list
os service show
    [--catalog]
    <service>
yes
keystone service-get
    <service-id>

tenant

OSC Command Implemented Keystone command
os tenant create
    [--description <description>]
    [--enable | --disable]
    <tenant-name>
yes
keystone tenant-create
    --name <tenant-name>
    [--description <tenant-description>]
    [--enabled <true|false>]
os tenant delete
    <tenant>
yes
keystone tenant-delete
    <tenant>
os tenant list
    [--long]
yes
keystone tenant-list
os tenant set
    [--name <new-tenant-name>]
    [--description <new-tenant-description>]
    [--enable | --disable]
    <tenant>
yes
keystone tenant-update
    [--name <tenant_name>]
    [--description <tenant-description>]
    [--enabled <true|false>]
    <tenant-id>
os tenant show
    <tenant>
yes
keystone tenant-get
    <tenant-id>

token

OSC Command Implemented Keystone command
os token show
    [--width <token-display-width>]
 ??
keystone token-get [--wrap <integer>]

user

OSC Command Implemented Keystone command
os user create
    [--password <user-password>]
    [--email <user-email>]
    [--tenant <tenant>]
    [--enable | --disable]
    <user-name>
yes
keystone user-create
    --name <user-name> 
    [--tenant_id <tenant-id>]
    [--pass <pass>] 
    [--email <email>]
    [--enabled <true|false>]
os user delete
    <user>
yes
keystone user-delete
    <user-id>
os user list
    [--tenant <tenant>]
    [--long]
yes
keystone user-list
    [<tenant-id>]
os user set
    [--name <new-user-name>]
    [--password <user-password>]
    [--email <user-email>]
    [--tenant <tenant>]
    [--enable|--disable]
    <user>
yes
keystone user-password-update
    --pass <password>
    <user-id>
os user show
    <user>
yes
keystone user-get
    <user-id>

user role

OSC Command Implemented Keystone command
os user role add
    [--tenant <tenant>]
    <user>
    <role>
yes
keystone user-role-add
    --user <user-id>
    --role <role-id>
    [--tenant_id <tenant-id>]
os user role list
    [--tenant <tenant>]
    [<user>]
yes
keystone user-role-list
    [--user <user-id>]
    [--tenant_id <tenant-id>]
os user role remove
    [--tenant <tenant>]
    <user>
    <role>
yes
keystone user-role-remove
    --user <user-id>
    --role <role-id>
    [--tenant_id <tenant-id>]

<other>

These keystone commands are not planned for re-implementation in OpenStackClient

keystone bootstrap
        --pass <password>
        [--user-name <user-name>]
        [--role-name <role-name>]
        [--tenant-name <tenant-name>]
keystone discover

API v3

credential

OSC Command Implemented Keystone command
os credential create
    [--project <project>]
    [--type ec2|cert]
    <user>
    <data>
yes
keystone credential-create
    --user_id <user-id>
    --type <credential-type>
    --data <credential-data>
    [--project_id <project-id>]
os credential delete
    <credential-id>
yes
keystone credential-delete
    <credential-id>
os credential list
yes
keystone credential-list
os credential set
    [--user <user>]
    [--type ec2|cert]
    [--data <data>]
    [--project <project>]
    <credential-id>
yes
keystone credential-update
    [--user <user>]
    [--type <type>]
    [--data <data>]
    [--project <project>]
    <credential-id>
os credential show
    <credential-id>
yes
keystone credential-get
    <credential-id>

domain

OSC Command Implemented Keystone command
os domain create
    [--description <domain-description>]
    [--enable | --disable]
    <domain-name>
yes
keystone domain-create
    --name <domain-name>
    [--description <domain-description>]
    [--enabled <true|false>]
    [--private_project_names <true|false>]
    [--private_user_names <true|false>]
os domain delete
    <domain>
yes
keystone domain-delete
    <domain-id>
os domain list
yes
keystone domain-list
os domain set
    [--name <new-domain-name>]
    [--description <new-domain-description>]
    [--enable | --disable]
    <domain>
yes
keystone domain-update
    [--name <domain_name>]
    [--description <domain-description>]
    [--enabled <true|false>]
    [--private_project_names <true|false>]
    [--private_user_names <true|false>]
    <domain-id>
os domain show
    <domain>
yes
keystone domain-get
    <domain-id>

endpoint

OSC Command Implemented Keystone command
os endpoint create
    [--region <endpoint-region>
    [--enable | --disable]
    <service>
    <interface admin|public|internal>
    <url>
yes
keystone endpoint-create 
    [--region <endpoint-region>
    [--enable | --disable]
    <service_id>
    <interface admin|public|internal>
    <url>
os endpoint delete
    <endpoint-id>
yes
os endpoint list
    [--long]
yes
keystone endpoint-list
os endpoint set
    [--interface <endpoint-interface>]
    [--url <endpoint-url>]
    [--service <service-id>]
    [--region <endpoint-region>]
    [--enable | --disable]
    <endpoint>
yes
keystone endpoint-set
    [--interface <endpoint-interface>]
    [--url <endpoint-url>]
    [--service <service-id>]
    [--region <endpoint-region>]
    [--enable | --disable]
    <endpoint>
os endpoint show
    <endpoint>
yes
keystone endpoint-get 
    <endpoint>

group

OSC Command Implemented Keystone command
os group create
    [--domain <domain>]
    [--description <group-description>]
    <group-name>
yes
keystone group-create
    --name <group-name>
    [--domain_id <domain-id>]
    [--description <group-description>]
os group delete
    <group>
yes
keystone group-delete
    <group-id>
os group list
    [--long]
yes
keystone group-list
os group set
    [--name <new-group-name>]
    [--domain <domain>]
    [--description <new-group-description>]
    <group>
yes
keystone group-update
    [--name <group_name>]
    [--domain_id <domain-id>]
    [--description <group-description>]
    <group-id>
os group show
    <group>
yes
keystone group-get
    <group-id>

oauth

OSC Command Implemented Keystone command
os access token create
    --consumer-key <consumer-key>
    --consumer-secret <consumer-secret>
    --request-key <request-key>
    --request-secret <request-secret>
    --verifier <pin>
yes
n/a
look at some alternatives:
os oauth token create
    --consumer-key <consumer-key>
    --consumer-secret <consumer-secret>
    --request-key <request-key>
    --request-secret <request-secret>
    --verifier <pin>
nyet
* makes the token specific to oauth
* add [--oauth-ver X] if versioning for oauth2 is an issue?
os oauth token create
    --access
    --consumer-key <consumer-key>
    --consumer-secret <consumer-secret>
    --request-key <request-key>
    --request-secret <request-secret>
    --verifier <pin>

os oauth token create
    --request
    --consumer-key <consumer-key>
    --roles <roles>
nyet
* collapse 'access token' and 'request token' into 'oauth token'?

policy

OSC Command Implemented Keystone command
os policy create
    [--type <policy-type>]
    --blob-file <blob-file>
yes
keystone policy-create
    --type <policy-type>
    --blob <policy-blob>
os policy delete
    <policy-id>
yes
keystone policy-delete
    <policy-id>
os policy list
    [--include-blob]
yes
keystone policy-list
os policy set
    [--type <policy-type>]
    [--blob-file<blob-file>]
    <policy-id>
yes
keystone policy-update
    [--type <policy-type>]
    [--blob <policy-blob>]
    <policy-id>
os policy show
    <policy-id>
yes
keystone policy-get
    <policy-id>

project

OSC Command Implemented Keystone command
os project create
    [--domain <project-domain>]
    [--description <project-description>]
    [--enable | --disable]
    <project-name>
yes
keystone project-create
    [--domain_id <domain_id>]
    [--description <description>]
    [--enable | --disable]
    <name>
os project delete
    <project>
yes
os project-delete
    <project_id>
os project list
    [--long]
yes
keystone project-list
os project set
    [--name <new-project-name>]
    [--domain <project-domain>]
    [--description <new-project-description>]
    [--enable | --disable]
    <project>
yes
keystone project-set
    [--name <new-project-name>]
    [--domain <project-domain>]
    [--description <new-project-description>]
    [--enable | --disable]
    <project_id>
os project show
    <project>
yes
keystone project-get
    <project_id>

role

OSC Command Implemented Keystone command
os role add
    [--user <user> | --group <group>]
    [--domain <domain> | --project <project>]
    <role>
yes
os role create
    <role-name>
yes
os role delete
    <role>
yes
os role list
yes
os role remove
    [--user <user> | --group <group>]
    [--domain <domain> | --project <project>]
    <role>
yes
os role set
    [--name <new-role-name>]
    <role>
yes
os role show
    <role>
yes

service

OSC Command Implemented Keystone command
os service create
	[--name <name>]
        [--enabled <true|false>]
        <type>
yes
keystone service-create
	[--name <name>]
        [--enabled <true|false>]
        <type>
os service delete
    <service>
yes
keystone service-delete
    <service_id>
os list service
yes
keystone service-list
os service set
    [--type <service-type>]
    [--name <new-name>]
    [--enable | --disable]
    <service>
yes
keystone service-set
    [--type <service-type>]
    [--name <new-name>]
    [--enable | --disable]
    <service>
os service show
    <service>
yes
keystone service-get 
    <service_id>

user

OSC Command Implemented Keystone command
os user create
    [--password <password>] 
    [--project <project>]
    [--email <user-email>]
    [--enable | --disable]
    <name>
yes
keystone user-create
    --name <user-name> 
    [--domain_id <domain-id>]
    [--default_project_id <project-id>]
    [--description <description>]
    [--enabled <true|false>]
    [--password <password>]
os user delete
    <user>
yes
keystone user-delete
    <user-id>
os user list
    [--project <project>]
    [--long]
yes
keystone user-list
os user set
    [--name <new-name>]
    [--password <password>] 
    [--project <project>]
    [--email <user-email>]
    [--enable | --disable]
    <user>
yes
keystone user-update
    --user_id <user-id>
    [--name <user-name>]
    [--domain_id <domain-id>]
    [--default_project_id <project-id>]
    [--description <description>]
    [--enabled <true|false>]
    [--password <password>]
os user show
    <user>
yes
keystone user-get
    <user-id>

Compute

OSC Option Environment Variable Nova Option Environment Variable
--os-auth-system <auth-system> OS_AUTH_SYSTEM
--service-type <type>
--service-name <name> NOVA_SERVICE_NAME
--volume-service-name <name> NOVA_VOLUME_SERVICE_NAME
--endpoint-type <type> NOVA_ENDPOINT_TYPE
--os-compute-api-version <ver> OS_COMPUTE_API_VERSION --os-compute-api-version <ver> OS_COMPUTE_API_VERSION
--bypass-url <bypass-url>


API v2 (1.1)

agent

OSC Command Implemented Nova command
os agent create
    <os>
    <architecture>
    <version>
    <url>
    <md5hash>
    <hypervisor>
yes
os agent delete
    <id>
yes
os agent list 
    [--hypervisor <hypervisor>]
yes
os agent set
    <id>
    <version>
    <url>
    <md5hash>
yes


aggregate

OSC Command Implemented Nova command
os aggregate add host
    <aggregate>
    <host>
yes
nova aggregate-add-host
    <id>
    <host>
os aggregate create
    [--zone <availability-zone>]
    [--property <key=value>]
    <name>
yes
nova aggregate-create
    <name>
    [<availability_zone>]
os aggregate delete
    <aggregate>
yes
nova aggregate-delete
    <id>
os aggregate list
    [--long]
yes
nova aggregate-list
os aggregate remove host
    <aggregate>
    <host>
yes
nova aggregate-remove-host
    <id>
    <host>
os aggregate set
    [--name <new-name>]
    [--zone <availability-zone>]
    [--property <key=value>]
    <aggregate>
yes
nova aggregate-update
    <id>
    <name>
    [<availability_zone>]

nova aggregate-set-metadata
    <id>
    <key=value>
    [<key=value> ...]
os aggregate show
    <aggregate>
yes
nova aggregate-details
    <id>

bash-completion

OSC Command Implemented Nova command

TBD

no
nova bash-completion

cloudpipe

OSC Command Implemented Nova command
os create cloudpipe
    <project>
no
nova cloudpipe-create
    <project>
os list cloudpipe
no
nova cloudpipe-list

console

OSC Command Implemented Nova command
os console log show
    [--lines <num-lines>]
    <server>
yes
nova console-log
    [--length <length>]
    <server>
os console url show
    [--novnc | --xvpvnc | --spice]
    <server>
yes
nova get-vnc-console
    <server>
    <console_type>

credentials

See credentials in the cross API section.

diagnostics

Consider implementing this as: show server --diagnostics <server>

OSC Command Implemented Nova command
os diagnostics show
    <server>
no
nova diagnostics
    <server>

dns

These commands need some attention...an IP shouldn't be required for all record types. They need to be more DNS-y. Zone anyone?

OSC Command Implemented Nova command
os create dns
    [--type <type>]
    <ip>
    <name>
    <domain>
no
nova dns-create
    [--type <type>]
    <ip>
    <name>
    <domain>
os delete dns
    <domain>
    <name>
no
nova dns-delete
    <domain>
    <name>
os list dns
    [--ip <ip>]
    [--name <name>]
    <domain>
no
nova dns-list
    [--ip <ip>]
    [--name <name>]
    <domain>
os create dns-domain
    [--project <project>]
    [--availability-zone <availability-zone>]
    [--public | --private]
    <domain>
no
nova dns-create-private-domain
    [--availability_zone <availability_zone>]
    <domain>

nova dns-create-public-domain
    [--project <project>]
    <domain>
os delete dns-domain
    <domain>
no
nova dns-delete-domain
    <domain>
os list dns-domains
no
nova dns-domains

endpoints

Totally duplicates Identity catalog command

OSC Command Implemented Nova command
os endpoint list
no
nova endpoints

fixed-ip

OSC Command Implemented Nova command
os ip fixed add
    <network>
    <server>
yes
nova add-fixed-ip
    <server>
    <network_id>
os ip fixed remove
    <ip-address>
    <server>
yes
nova remove-fixed-ip
    <server>
    <address>


flavor

OSC Command Implemented Nova command
os flavor create
    [--id <id>]
    [--ram <size-mb>]
    [--disk <size-gb>]
    [--ephemeral-disk <size-gb>]
    [--swap <size-mb>]
    [--vcpus <num-cpu>]
    [--rxtx-factor <factor>]
    [--public | --private]
    <name>
(partial)
default: auto
default: 256M
default: 0G
default: 0G
default: 0G
default: 1
default: 1
default: public
nova flavor-create
    [--ephemeral <ephemeral>] 
    [--swap <swap>]
    [--rxtx-factor <factor>]
    <name>
    <id>
    <ram>
    <disk>
    <vcpus>
os flavor delete
    <flavor>
yes
nova flavor-delete 
    <id>
os flavor list
yes
nova flavor-list
os flavor show
    <flavor>
yes


floating-ip

OSC Command Implemented Nova command
os ip floating add
    <ip-address>
    <server>
yes
nova add-floating-ip
    <server>
    <address>
os ip floating create
    [<pool>]
yes
nova floating-ip-create
    [<floating_ip_pool>]
os ip floating delete
    <ip-address>
yes
nova floating-ip-delete
    <address>
os ip floating list
yes
nova floating-ip-list
os ip floating remove
    <ip-address>
    <server>
yes
nova remove-floating-ip
    <server>
    <address>


floating-ip-pool

OSC Command Implemented Nova command
os ip floating pool list
yes
nova floating-ip-pool-list


host

OSC Command Implemented Nova command
os host list
    [--zone <availability-zone>]
yes
nova host-action
    [--action <action>]
    <hostname>
os host set
    ...
no
nova host-update
    [--status <status>] 
    [--maintenance <maintenance_mode>]
    <hostname>
os host show
    <host>
yes


hypervisor

OSC Command Implemented Nova command
os hypervisor list
    [--matching <hostname>]
yes
os hypervisor show
    <id>
yes


keypair

OSC Command Implemented Nova command
os keypair create
    [--public-key <file>]
    <name>
yes
nova keypair-add
    [--pub_key <pub_key>]
    <name>
os keypair delete
    <name>
yes
nova keypair-delete
    <name>
os keypair list
yes
nova keypair-list
os keypair show
    [--public-key]
    <name>
yes


limits

See limits in the cross API section.

quota

See quota in the cross API section.


resource

OSC Command Implemented Nova command
os show resource
    <hostname>
no
nova describe-resource
    <hostname>

secgroup

OSC Command Implemented Nova command
os secgroup add

(see server add secgroup)
no
nova add-secgroup
    <server>
    <secgroup>
os secgroup create
    [--description <description>]
    <name>
yes
nova secgroup-create
    <name>
    <description>
os secgroup delete
    <group>
yes
nova secgroup-delete
    <secgroup>
os secgroup list
    [--all-projects]
yes
nova secgroup-list
     [--all-tenants [<0|1>]]
os secgroup remove

(see server remove secgroup)
no
nova remove-secgroup
    <server>
    <secgroup>
os secgroup set
    [--name <new-name>]
    [--description [<new-description>]
    <group>
yes
nova secgroup-update
    <secgroup>
    <name>
    <description>
os secgroup show
    <group>
yes
n/a

secgroup-group-rule

OSC Command Implemented Nova command
os secgroup group rule create
    [--proto <protocol>]
    [--port <port>:<port>]
    <source-group>
    <secgroup>
no
nova secgroup-add-group-rule
    [--ip_proto <ip_proto>]
    [--from_port <from_port>]
    [--to_port <to_port>]
    <secgroup>
    <source_group>
os secgroup group rule delete
    [--proto <protocol>]
    [--port <port>:<port>]
    <source-group>
    <secgroup>
no
nova secgroup-delete-group-rule
    [--ip_proto <ip_proto>]
    [--from_port <from_port>]
    [--to_port <to_port>]
    <secgroup>
    <source_group>

secgroup-rule

OSC Command Implemented Nova command
os secgroup rule create
    [--proto <proto>]
    [--src-ip <ip-address>]
    [--dst-port <port-range>]
    <group>
no
nova secgroup-add-rule
    <secgroup>
    <ip_proto>
    <from_port>
    <to_port>
    <cidr>
os secgroup rule delete
    [--proto <proto>]
    [--src-ip <ip-address>]
    [--dst-port <port-range>]
    <group>
no
nova secgroup-delete-rule
    <secgroup>
    <ip_proto>
    <from_port>
    <to_port>
    <cidr>
os secgroup rule list
    <group>
no
nova secgroup-list-rules
    <secgroup>

server

OSC Command Implemented Nova command
os server add secgroup
    <server>
    <group>
no
nova add-secgroup
    <server>
    <secgroup>
os server create
    --image <image>
    --flavor <flavor>
    [--security-group <security-group-list> [...] ]
    [--key-name <key-name>]
    [--meta-data <key=value> [...] ]
    [--file <dest-filename=source-filename>] [...] ]
    [--user-data <user-data>]
    [--availability-zone <zone-name>]
    [--block-device-mapping <dev-name=mapping> [...] ]
    [--nic <net-id=net-uuid,v4-fixed-ip=ip-addr> [...] ]
    [--hint <key=value> [...] ]
    [--config-drive <value>|True ]
    [--min <count>]
    [--max <count>]
    [--wait]
    <server-name>
yes
nova boot
    [--flavor <flavor>]
    [--image <image>]
    [--meta <key=value>]
    [--file <dst-path=src-path>]
    [--key_name <key_name>]
    [--user_data <user-data>]
    [--availability_zone <availability-zone>]
    [--security_groups <security_groups>]
    [--block_device_mapping <dev_name=mapping>]
    [--hint <key=value>]
    [--nic <net-id=net-uuid,v4-fixed-ip=ip-addr>]
    [--config-drive <value>]
    [--poll]
    <name>
os server delete
    <server>
yes
nova delete
    <server>
os server list
    [--reservation-id <reservation-id>] 
    [--ip <ip-regex>]
    [--ip6 <ip6-regex>] 
    [--name <name-regex>]
    [--instance-name <instance-name-regex>] 
    [--status <status>]
    [--flavor <flavor>]
    [--image <image>] 
    [--host <hostname>]
    [--all-tenants]
yes
nova list
    [--reservation_id <reservation_id>] 
    [--ip <ip_regexp>]
    [--ip6 <ip6_regexp>] 
    [--name <name_regexp>]
    [--instance_name <name_regexp>] 
    [--status <status>]
    [--flavor <flavor>] [--image <image>] 
    [--host <hostname>]
    [--all_tenants [<0|1>]]
os server lock
    <server>
no
nova lock
    <server>
os server migrate
    --live
    [--block_migrate]
    [--disk_over_commit]
    <server>
    <host>

os server migrate
    [--wait]
    <server>
no
nova live-migration
    [--block_migrate] 
    [--disk_over_commit]
    <server>
<host>

nova migrate
    [--poll]
    <server>
os server pause
    <server>
yes
nova pause
    <server>
os server reboot
    [--hard | --soft]
    [--wait]
    <server>
yes
nova reboot
    [--hard]
    [--poll]
    <server>
os server rebuild
    --image <image>
    [--password <password>] 
    [--wait]
    <server>
yes
nova rebuild
    [--rebuild_password <rebuild_password>] 
    [--poll]
    <server>
    <image>
os server remove secgroup
    <server>
    <group>
no
nova remove-secgroup
    <server>
    <secgroup>
os server rename
    <server>
    <new-name>
no
nova rename
    <server>
    <name>
os server rescue
    <server>
no
nova rescue
    <server>
os server resize
    --flavor <flavor>
    [--wait]
    <server>
no
nova resize
    [--poll]
    <server>
    <flavor>
os server resize
    --confirm
    <server>
no
nova resize-confirm
    <server>
os server resume
    <server>
yes
nova resume
    <server>
os server set
    --meta-data <key=value>
    [--meta-data <key=value>] ...
    <server>
os unset server
    --meta-data <key>
    [--meta-data <key>] ...
    <server>
no
nova meta
    <server>
    <action>
    <key=value>
    [<key=value> ...]
os server set
    --root-password
    <server>
no
nova root-password
    <server>
os server show
    <server>
yes
nova show
    <server>
os server ssh
    [--port PORT]
    --private]
    [--ipv6]
    [--login <login>]
    <server>
no
nova ssh
    [--port PORT]
    [--private]
    [--ipv6]
    [--login <login>]
    <server>
os server suspend
    <server>
yes
nova suspend
    <server>
os server unlock
    <server>
no
nova unlock
    <server>
os server unpause
    <server>
yes
nova unpause
    <server>
os server unrescue
    <server>
no
nova unrescue
    <server>

usage

OSC Command Implemented Keystone command
os usage list
    [--start <start>]
    [--end <end>]
no
nova usage-list
    [--start <start>]
    [--end <end>]


volume

OSC Command Implemented Keystone command
os volume attach
    <volume>
    <server>
    <device>
no
nova volume-attach
    <server>
    <volume>
    <device>
os volume detach
    <server>
    <volume>
no
nova volume-detach
    <server>
    <volume>


x509-cert

See credentials in the cross API section.

x509-root-cert

See credentials in the cross API section.

Image

OSC Option Environment Variable Glance Option Environment Variable
--os-image-api-version <ver> OS_IMAGE_API_VERSION --os-image-api-version <ver> OS_IMAGE_API_VERSION
--os-service-type <type> OS_SERVICE_TYPE
--os-endpoint-type <type> OS_ENDPOINT_TYPE
--os-token <token> OS_TOKEN --os-auth-token <token> OS_AUTH_TOKEN
--os-url <url> OS_URL --os-image-url <url> OS_IMAGE_URL
--os-cacert <file> OS_CACERT
--cert-file <file> CERT_FILE
--key-file <key-file> KEY_FILE
--no-ssl-compression


API v1

image

OSC Command Implemented Glance command
os image create
    [--id <id>]
    [--store <store>]
    [--container-format <format>]
    [--disk-format <format>]
    [--owner <tenant>]
    [--size <size-bytes>]
    [--min-disk <disk-gb>]
    [--min-ram <ram-mg>]
    [--location <image-url>]
    [--copy-from <image-url>]
    [--file <local-filename>]
    [--checksum <checksum>]
    [--protected | --unprotected]
    [--public | --private]
    [--property <key=value>]
    <name>
yes
glance image-create
    [--id <IMAGE_ID>]
    [--name <NAME>]
    [--disk-format <DISK_FORMAT>]
    [--container-format <CONTAINER_FORMAT>]
    [--owner <TENANT_ID>]
    [--size <SIZE>]
    [--min-disk <DISK_GB>]
    [--min-ram <DISK_RAM>]
    [--location <IMAGE_URL>]
    [--checksum <CHECKSUM>]
    [--copy-from <IMAGE_URL>]
    [--is-public [True|False]]
    [--is-protected [True|False]]
    [--property <key=value>]
    [--human-readable]
os image delete
    <image>
yes
glance image-delete
    <IMAGE_ID>
os image list
    [--page-size <size>]
yes
glance image-list
os image save
    [--file <filename>]
    <image>
yes
glance image-download
    [--file <FILE>]
    <IMAGE>
os image set
    [--name <name>]
    [--owner <tenant>]
    [--min-disk <disk-gb>]
    [--min-ram <ram-mg>]
    [--protected | --unprotected]
    [--public | --private]
    [--property <key=value>]
    <image>
yes
glance image-update
    [--name <NAME>]
    [--disk-format <DISK_FORMAT>]
    [--container-format <CONTAINER_FORMAT>]
    [--owner <TENANT_ID>]
    [--size <SIZE>]
    [--min-disk <DISK_GB>]
    [--min-ram <DISK_RAM>]
    [--location <IMAGE_URL>]
    [--file <FILE>]
    [--checksum <CHECKSUM>]
    [--copy-from <IMAGE_URL>]
    [--is-public [True|False]]
    [--is-protected [True|False]]
    [--property <key=value>]
    [--purge-props]
    [--human-readable]
    <IMAGE>
os image show
    <image>
yes
glance image-show
    [--human-readable]
    <IMAGE>

API v2

image

OSC Command Implemented Glance command
os image delete
    <image>
yes
glance image-delete
    <IMAGE_ID>
os image list
    [--page-size <size>]
yes
glance image-list
no
glance member-images
    [options]
    <MEMBER>
os image save
    [--file <filename>]
    <image>
yes
glance image-download
    [--file <FILE>]
    <IMAGE>
os image set
    [--id <id>]
    [--store <store>]
    [--container-format <format>]
    [--disk-format <format>]
    [--owner <tenant>]
    [--size <size-bytes>]
    [--min-disk <disk-gb>]
    [--min-ram <ram-mg>]
    [--location <image-url>]
    [--copy-from <image-url>]
    [--file <local-filename>]
    [--checksum <checksum>]
    [--protected | --unprotected]
    [--public | --private]
    [--property <key=value>]
    <name>
no
glance image-update
    [--name <NAME>]
    [--disk-format <DISK_FORMAT>]
    [--container-format <CONTAINER_FORMAT>]
    [--owner <TENANT_ID>]
    [--size <SIZE>]
    [--min-disk <DISK_GB>]
    [--min-ram <DISK_RAM>]
    [--location <IMAGE_URL>]
    [--file <FILE>]
    [--checksum <CHECKSUM>]
    [--copy-from <IMAGE_URL>]
    [--is-public [True|False]]
    [--is-protected [True|False]]
    [--property <key=value>]
    [--purge-props]
    [--human-readable]
    <IMAGE>
os image show
    <image>
yes
glance image-show
    [--human-readable]
    <IMAGE>


image-member

Need to discuss the future of these commands with markwash...

glance member-create [--can-share] <IMAGE_ID> <TENANT_ID>

os create image-member ...


glance member-delete <IMAGE_ID> <TENANT_ID>

os list image-member <image> [options]


glance member-delete [options] <ID> <MEMBER>

os delete image-member ...


glance member-list [--image-id <IMAGE_ID>] [--tenant-id <TENANT_ID>]

os list image-member ...

Volume

Cinder Option Environment Variable OSC Option Environment Variable
--os-volume-api-version <ver> OS_VOLUME_API_VERSION --os-volume-api-version <ver> OS_VOLUME_API_VERSION
--service-type <type>
--service-name <name> CINDER_SERVICE_NAME
--volume-service-name <name> CINDER_VOLUME_SERVICE_NAME
--endpoint-type <type> CINDER_ENDPOINT_TYPE
--retries <int>


API v1.0

limits

See limits in the cross API section.

quota

See quota in the cross API section.

snapshot

OSC Command Implemented Cinder command
os snapshot create
    --name <name>
    [--description <description>]
    [--force]
    <volume>
yes
cinder snapshot-create
    --force <True|False>
    --display-name <display-name>
    --display-description <display-description>
    <volume-id>
os snapshot delete
    <snapshot>
yes
cinder snapshot-delete
    <snapshot-id>
os snapshot list
yes (no opts yet)
cinder snapshot-list 
    --all-tenants [<0|1>]
    --display-name <display-name>
    --status <status>
    --volume-id <volume-id>
os snapshot set
    [--name <new-name>]
    [--description <new-description>]
    <snapshot>
yes
cinder snapshot-rename
    --display-description <display-description>
    --display-name <display-name>
    <snapshot-id>
os snapshot show
    <snapshot>
yes
cinder snapshot-show
    <snapshot-id>

volume

OSC Command Implemented Cinder command
os volume create
    --size <size>
    [--description <description>]
    [--volume-type <volume-type>]
    [--snapshot-id <snapshot-id>]
    [--source <volid>]
    [--image <image-id>]
    [--availability-zone <availability-zone>]
    [--property <key=value>]
    [--user <user>]           # admin only
    [--project <project>]     # admin only
    <name>
yes
cinder create
    [--snapshot-id <snapshot-id>]
    [--source-volid <source-volid>]
    [--image-id <image-id>]
    [--display-name <display-name>]
    [--display-description <display-description>]
    [--volume-type <volume-type>]
    [--availability-zone <availability-zone>]
    [--metadata <key=value>]
    <size>
os volume delete
    [--force]
    <volume>
yes
cinder delete
    <volume-id>

cinder force-delete
    <volume-id>
os volume list
    [--name <name>]
    [--status <status>]
    [--long]
    [--all-tenants]           # admin only
yes
cinder list 
    --all-tenants [<0|1>]
    --display-name <display-name>
    --status <status>
os volume set
    [--name <new-name>]
    [--description <new-description>]
    [--property <key=value>]
    <volume>
yes
cinder metadata
    <volume-id>
    <action>
    <key=value>

cinder rename
    --display-description <display-description>
    <volume-id>
    <display-name>
os volume show
    <volume>
yes
cinder show
    <volume-id>
os volume unset
    [--property <key=value>]
    <volume>
yes

volume-type

OSC Command Implemented Cinder command
os volume type create
    [--property <key=value>]
    <name>
yes
cinder type-create
    <type-name>
os volume type delete
    <volume-type>
yes
cinder type-delete
    <type-id>
os volume type list
    [--long]
yes
cinder type-list 

cinder extra-specs-list
os volume type set
    [--property <key=value>]
    <volume-type>
yes
cinder type-key
    <type-id>
    <set>
    <key=value>
os volume type unset
    [--property <key>]
    <volume-type>
yes
cinder type-key
    <type-id>
    <unset>
    <key>

Network

The Network commands in quantum have been in a bit of flux and are currently out of scope for OpenStackClient.

Command-line Option Environment Variable
--host=HOST
--port=PORT
--ssl
--verbose
--logfile=LOGFILE
--token=TOKEN
--version=VERSION QUANTUM_VERSION


API v2.0

  • Verbs:
    • quantum: create, delete, list, plug, show, update, unplug
    • os: add, create, delete, list, remove, set, show
  • Objects:
    • quantum: iface, net, port
    • os: interface, network, port

iface

plug_iface <tenant-id> <net-id> <port-id> <iface-id>

add interface <tenant> <network> <port> <interface>


show_iface <tenant-id> <net-id> <port-id>

show interface <tenant> <network> <port>


unplug_iface <tenant-id> <net-id> <port-id>

remove interface <tenant> <network> <port>


net

create_net <tenant-id> <net-name>

create network <tenant> <network-name>


delete_net <tenant-id> <net-id>

delete <tenant> <network>


list_nets <tenant-id>

list network <tenant>


list_nets_detail <tenant-id>

list network --detail <tenant>


show_net <tenant-id> <net-id>

show network <tenant> <network>


show_net_detail <tenant-id> <net-id>

show network --detail <tenant> <network>


update_net <tenant-id> <net-id> <new-name>

set network <tenant> <network> --name <name>


port

create_port <tenant-id> <net-id>

create port <tenant> <network>


delete_port <tenant-id> <net-id> <port-id>

delete port <tenant> <network> <port>


list_ports <tenant-id> <net-id>

list port <tenant> <network>


list_ports_detail <tenant-id> <net-id>

list port --detail <tenant> <network>


show_port <tenant-id> <net-id> <port-id>

show port <tenant> <network> <port>


show_port_detail <tenant-id> <net-id> <port-id>

show port --detail <tenant> <network> <port>


update_port <tenant-id> <net-id> <port-id> <params>

set port <tenant> <network> <port> <params>

Options

In general, options will be transformed into more UNIX-like usage

  • --enable true|false becomes --enable|--disable

(dhellmann) Not all boolean options have natural antonyms like enable/disable. It may be more consistent to use a --flag --no-flag style naming convention to indicate the opposites of flags.

"(dtroyer) Yup, except i really don't like --no-enable. I'm going to work through the switch mapping to see how many others we really have to deal with."