Jump to: navigation, search

Difference between revisions of "UnifiedCLI/Mapping"

(Format agent and server commands (server incomplete))
(Redirected page to OpenStackClient/Commands)
 
(158 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 +
#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 ==
  
 
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"
 
{| class="wikitable"
 
|-
 
|-
! Option !! Environment Variable !!  !! OSC Option !! Environment Variable
+
! OSC Option !! Environment Variable !!  !! Option !! Environment Variable
 
|-
 
|-
| --version ||  ||   || --version ||  
+
| --version ||  || || --version ||  
 
|-
 
|-
| --help ||  ||   || --help ||  
+
| --help ||  || || --help ||  
 
|-
 
|-
| --debug ||  ||   || --debug ||  
+
| --debug ||  || || --debug ||  
 
|-
 
|-
| ||  ||   || --quiet ||  
+
| --quiet ||  || || ||
 
|-
 
|-
| ||  ||   || --verbose
+
| --verbose ||  || || ||
 
|-
 
|-
| ||  ||  || --log-file <filename> ||  
+
| --log-file <filename> ||  || ||  ||
 
|-
 
|-
| --os-auth-url <url> || OS_AUTH_URL ||  || --os-auth-url || OS_AUTH_URL
+
| --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-name <name> || OS_TENANT_NAME ||  || --os-tenant-name <name> || OS_TENANT_NAME
Line 74: Line 152:
 
| --os-cacert <file> || OS_CACERT ||  || --os-cacert <file> || OS_CACERT
 
| --os-cacert <file> || OS_CACERT ||  || --os-cacert <file> || OS_CACERT
 
|-
 
|-
| --insecure ||  ||   || ||  
+
| ||  || || --insecure ||  
 
|-
 
|-
| ||  ||   || --os-use-keyring ||  
+
| --os-use-keyring ||  || || ||
 
|}
 
|}
 +
  
 
== Common Options ==
 
== Common Options ==
Line 93: Line 172:
 
| --disable || 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 =
 
= Command Mapping Summary =
Line 111: Line 191:
  
  
== 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.
  
{| class="wikitable"
+
==== 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> ||  ||  ||  ||
 
|-
 
|}
 
  
 +
''[consider rolling the ec2 creds into this too]''
  
=== API v2.0 ===
+
{| class="wikitable"
 
+
|-
'''token'''
+
! OSC Command !! Implemented !! !! Keystone command
 
+
|-
 +
|
 +
<source lang="bash">
 +
os credentials create
 +
    --x509
 +
    [<private-key-file>]
 +
    [<certificate-file>]
 +
</source>
 +
|| no
 +
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone token-get [--wrap <integer>]
+
nova x509-create-cert
 
+
    [<pk-file>]
os show token [--width <pki-token-display-width>]
+
    [<x509-cert>]
 
</source>
 
</source>
 
{| class="wikitable"
 
|-
 
! OS Command !! !! Keystone Command
 
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os show token
+
os credentials show
     [--width <token-display-width>]
+
    [--token]
 +
    [--user]
 +
     [--x509 [--root]]
 
</source>
 
</source>
 +
|| no
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone token-get [--wrap <integer>]
+
nova credentials
 +
    [--wrap <integer>]
 +
 
 +
nova x509-get-root-cert
 +
    [<filename>]
 
</source>
 
</source>
 
|}
 
|}
  
 +
==== limits ====
  
'''catalog'''
+
{| class="wikitable"
 
+
|-
 +
! OSC Command !! Implemented !! !! Keystone command
 +
|-
 +
|
 
<source lang="bash">
 
<source lang="bash">
keystone catalog [--service <service-type>]
+
os limits show
 
+
    --absolute [--reserved] | --rate
os show service [--catalog <service-type>]
 
 
</source>
 
</source>
 +
|| yes
 +
|| ||
 +
<source lang="bash">
 +
nova absolute-limits
 +
    [--reserved]
  
 +
nova rate-limits
  
'''ec2-credentials'''
+
cinder absolute-limits
  
<source lang="bash">
+
cinder rate-limits
keystone ec2-credentials-create [--user <user-id>]
 
                      [--tenant_id <tenant-id>]
 
 
 
os create ec2-credentials --tenant_id <tenant-id> [--user <user-id>]
 
 
 
## are both args really optional?
 
 
</source>
 
</source>
 +
|}
  
 +
==== quota ====
  
 +
{| class="wikitable"
 +
|-
 +
! OSC Command !! Implemented !! !! Keystone command
 +
|-
 +
|
 
<source lang="bash">
 
<source lang="bash">
keystone ec2-credentials-delete [--user <user-id>]  
+
os quota set
                      --access <access-key>
+
    # 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>]
  
os delete ec2-credentials <access-key>
+
    # Volume settings
 +
    [--gigabytes <new-gigabytes>]
 +
    [--snapshots <new-snapshots>]
 +
    [--volumes <new-volumes>]
  
## what changes if --user is not provided?
+
    <project>
 
</source>
 
</source>
 +
|| 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>
  
 
+
cinder quota-update
 +
    [--volumes <volumes>]
 +
    [--snapshots <snapshots>]
 +
    [--gigabytes <gigabytes>]
 +
    <tenant_id>
 +
</source>
 +
|-
 +
|
 
<source lang="bash">
 
<source lang="bash">
keystone ec2-credentials-get [--user <user-id>]  
+
os quota set
                            --access <access-key>
+
    --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>]
  
os show ec2-credentials <access-key>
+
    # Volume settings
 +
    [--gigabytes <new-gigabytes>]
 +
    [--snapshots <new-snapshots>]
 +
    [--volumes <new-volumes>]
  
## what changes if --user is not provided?
+
    <class>
 
</source>
 
</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>
  
 
+
cinder quota-class-update
 +
    [--volumes <volumes>]
 +
    [--snapshots <snapshots>]
 +
    [--gigabytes <gigabytes>]
 +
    <tenant_id>
 +
</source>
 +
|-
 +
|
 
<source lang="bash">
 
<source lang="bash">
keystone ec2-credentials-list [--user <user-id>]
+
os quota show
 
+
    [--default]
os list ec2-credentials [--user <user-id>]
+
    <project>
 
</source>
 
</source>
 +
|| yes
 +
|| ||
 +
<source lang="bash">
 +
nova quota-show
 +
    [--tenant <tenant-id>]
  
 +
cinder quota-show
 +
    <tenant_id>
  
==== endpoint ====
+
nova quota-defaults
 +
    <tenant_id>
  
{| class="wikitable"
+
cinder quota-defaults
|-
+
    <tenant_id>
! OS Command  !! !! Keystone Command
+
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os create endpoint
+
os quota show
     [--region <endpoint-region>
+
     --class
    [--publicurl <public-url>]
+
     <class>
    [--adminurl <admin-url>]
 
    [--internalurl <internal-url>]
 
     <service>
 
 
</source>
 
</source>
 +
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone endpoint-create
+
nova quota-class-show
    [--region <endpoint-region>]
+
     <class>
     [--service_id <service-id>]
+
 
    [--publicurl <public-url>]
+
cinder quota-class-show
    [--adminurl <admin-url>]
+
     <class>
     [--internalurl <internal-url>]
 
 
</source>
 
</source>
|-
+
|}
|
+
 
<source lang="bash">
+
== Identity ==
os delete endpoint <endpoint-id>
+
 
</source>
+
{| class="wikitable"
|| ||
+
|-  
<source lang="bash">
+
! OSC Option !!  Environment Variable !!  !!  Keystone Option !!  Environment Variable
keystone endpoint-delete <endpoint-id>
+
|-
</source>
+
| --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 ====
 +
 
 +
{| class="wikitable"
 +
|-
 +
! OSC Command !! Implemented !! !! Keystone command
 +
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os list endpoint [--long]
+
os catalog show
 +
    [--service <service>]
 
</source>
 
</source>
 +
|| no
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone endpoint-list
+
keystone catalog
 +
    [--service <service-type>]
 
</source>
 
</source>
 +
|}
 +
 +
==== ec2 credentials ====
 +
 +
{| class="wikitable"
 +
|-
 +
! OSC Command !! Implemented !! !! Keystone command
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os show endpoint
+
os ec2 credentials create
        [--type <endpoint-type>]
+
    [--project <project>]
        [--attr <endpoint-attribute>]  
+
    [--user <user>]
        [--value <endpoint-value>]
 
        <service>
 
 
</source>
 
</source>
 +
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone endpoint-get
+
keystone ec2-credentials-create
    --service <service-type>
+
     [--user <user-id>]  
     [--endpoint_type <endpoint-type>]
+
     [--tenant_id <tenant-id>]
     [--attr <service-attribute>]
 
    [--value <value>]
 
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os show endpoint
+
os ec2 credentials delete
     [--all]
+
     [--user <user>]
     <service>
+
     <access-key>
 
</source>
 
</source>
 +
|| yes
 
|| ||
 
|| ||
|}
 
 
 
'''role'''
 
 
 
<source lang="bash">
 
<source lang="bash">
keystone role-create --name <role-name>
+
keystone ec2-credentials-delete
 
+
    [--user <user-id>]
os create role <role-name>
+
    --access <access-key>
 
</source>
 
</source>
 
+
|-
 
+
|
 
<source lang="bash">
 
<source lang="bash">
keystone role-delete <role-id>
+
os ec2 credentials list
 
+
    [--user <user>]
os delete role <role>
 
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone role-get <role-id>
+
keystone ec2-credentials-list
 
+
    [--user <user-id>]
os show role <role>
 
 
</source>
 
</source>
 
+
|-
 
+
|
 
<source lang="bash">
 
<source lang="bash">
keystone role-list
+
os ec2 credentials show
 
+
    [--user <user>]
os list role
+
    <access-key>
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
'''service'''
 
 
 
 
<source lang="bash">
 
<source lang="bash">
keystone service-create --name <name>
+
keystone ec2-credentials-get
                        --type <type>
+
    [--user <user-id>]  
                        [--description <service-description>]
+
    --access <access-key>
 
 
os create service
 
        [--type <service-type>]
 
        [--description <service-description>]
 
        <service-name>
 
</source>
 
 
 
 
 
<source lang="bash">
 
keystone service-delete <service-id>
 
 
 
os delete service <service>
 
 
</source>
 
</source>
 +
|}
  
 +
==== endpoint ====
  
 +
{| class="wikitable"
 +
|-
 +
! OSC Command !! Implemented !! !! Keystone command
 +
|-
 +
|
 
<source lang="bash">
 
<source lang="bash">
keystone service-get <service-id>
+
os endpoint create
 
+
    --publicurl <public-url>
os show service <service>
+
    [--adminurl <admin-url>]
 +
    [--internalurl <internal-url>]
 +
    [--region <endpoint-region>]
 +
    <service>
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone service-list
+
keystone endpoint-create
 
+
    [--region <endpoint-region>]
os list service [--long]
+
    [--service_id <service-id>]
 +
    [--publicurl <public-url>]
 +
    [--adminurl <admin-url>]
 +
    [--internalurl <internal-url>]
 
</source>
 
</source>
 
+
|-
 
+
|
'''tenant'''
 
 
 
 
<source lang="bash">
 
<source lang="bash">
keystone tenant-create --name <tenant-name>
+
os endpoint delete
                      [--description <tenant-description>]
+
    <endpoint-id>
                      [--enabled <true|false>]
 
 
 
os create tenant
 
        [--description <tenant-description>]
 
        [--enable | --disable]
 
        <tenant-name>
 
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone tenant-delete <tenant-id>
+
keystone endpoint-delete
 
+
    <endpoint-id>
os delete tenant <tenant>
 
 
</source>
 
</source>
 
+
|-
 
+
|
 
<source lang="bash">
 
<source lang="bash">
keystone tenant-get <tenant-id>
+
os endpoint list
 
+
    [--long]
os show tenant <tenant>
 
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone tenant-list
+
keystone endpoint-list
 
 
os list tenant [--long]
 
 
</source>
 
</source>
 
+
|-
 
+
|
 
<source lang="bash">
 
<source lang="bash">
keystone tenant-update
+
os endpoint show
        [--name <tenant_name>]
+
    [--type <endpoint-type>]
        [--description <tenant-description>]
+
    [--attr <endpoint-attribute>]  
        [--enabled <true|false>]
+
    [--value <endpoint-value>]
        <tenant-id>
+
    [--all]
 
+
    <service-type>
os set tenant
 
        [--name <new-tenant-name>]
 
        [--description <new-tenant-description>]
 
        [--enable | --disable]
 
        <tenant>
 
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
'''user'''
 
 
 
 
<source lang="bash">
 
<source lang="bash">
keystone user-create --name <user-name>
+
keystone endpoint-get
                    [--tenant_id <tenant-id>]
+
    --service <service-type>
                    [--pass <pass>]
+
    [--endpoint_type <endpoint-type>]
                    [--email <email>]
+
    [--attr <service-attribute>]  
                    [--enabled <true|false>]
+
    [--value <value>]
 
 
os create user
 
        [--password <user-password>]
 
        [--email <user-email>]
 
        [--tenant <tenant>]
 
        [--enable | --disable]
 
        <user-name>
 
 
</source>
 
</source>
 +
|}
  
 +
==== role ====
  
 +
{| class="wikitable"
 +
|-
 +
! OSC Command !! Implemented !! !! Keystone command
 +
|-
 +
|
 
<source lang="bash">
 
<source lang="bash">
keystone user-delete <user-id>
+
os role create
 
+
    <role-name>
os delete user <user>
 
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone user-get <user-id>
+
keystone role-create --name
 
+
    <role-name>
os show user <user>
 
 
</source>
 
</source>
 
+
|-
 
+
|
 
<source lang="bash">
 
<source lang="bash">
keystone user-list [<tenant-id>]
+
os role delete
 
+
    <role>
os list user [--tenant <tenant>] [--long]
 
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone user-password-update --pass <password> <user-id>
+
keystone role-delete
 
+
    <role-id>
os set user
 
        [--name <new-user-name>]
 
        [--password <user-password>]
 
        [--email <user-email>]
 
        [--tenant <tenant>]
 
        [--enable|--disable]
 
        <user>
 
 
</source>
 
</source>
 
+
|-
 
+
|
'''user-role'''
 
 
 
 
<source lang="bash">
 
<source lang="bash">
keystone user-role-add --user <user-id>
+
os role list
                      --role <role-id>
 
                      [--tenant_id <tenant-id>]
 
 
 
os add role-user
 
        [--tenant <tenant>]
 
        <role> <user>
 
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone user-role-list [--user <user-id>]
+
keystone role-list
                  [--tenant_id <tenant-id>]
 
 
 
os list role-user
 
        [--tenant <tenant>]
 
        [<user>]
 
 
</source>
 
</source>
 
+
|-
 
+
|
 
<source lang="bash">
 
<source lang="bash">
keystone user-role-remove --user <user-id>
+
os role show
                          --role <role-id>
+
    <role>
                          [--tenant_id <tenant-id>]
 
 
 
os remove role-user
 
        [--tenant <tenant>]
 
        <role> <user>
 
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
'''<other>'''
 
 
 
 
<source lang="bash">
 
<source lang="bash">
keystone bootstrap
+
keystone role-get
        --pass <password>
+
    <role-id>
        [--user-name <user-name>]
 
        [--role-name <role-name>]
 
        [--tenant-name <tenant-name>]
 
 
 
##TBD
 
 
</source>
 
</source>
 +
|}
  
 +
==== service ====
  
 
+
{| class="wikitable"
 +
|-
 +
! OSC Command !! Implemented !! !! Keystone command
 +
|-
 +
|
 
<source lang="bash">
 
<source lang="bash">
keystone discover
+
os service create
 
+
    [--type <service-type>]
##TBD
+
    [--description <service-description>]
 +
    <service-name>
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
=== API v3 ===
 
 
 
'''credential'''
 
 
 
 
<source lang="bash">
 
<source lang="bash">
keystone credential-create --user_id <user-id>
+
keystone service-create
                      --type <credential-type>
+
    --name <name>  
                      --data <credential-data>
+
    --type <type>
                      [--project_id <project-id>]
+
    [--description <service-description>]
 
 
os create credential
 
        [--project <project>]
 
        <user>
 
        <type>
 
        <data>
 
 
</source>
 
</source>
 
+
|-
 
+
|
 
<source lang="bash">
 
<source lang="bash">
keystone credential-delete <credential-id>
+
os service delete
 
+
    <service>
os delete credential <credential-id>
 
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone credential-get <credential-id>
+
keystone service-delete
 
+
    <service-id>
os show credential <credential-id>
 
 
</source>
 
</source>
 
+
|-
 
+
|
 
<source lang="bash">
 
<source lang="bash">
keystone credential-list
+
os service list
 
+
    [--long]
os list credential [--long]
 
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone credential-update
+
keystone service-list
        [--user <user>]
 
        [--type <type>]
 
        [--data <data>]
 
        [--project <project>]
 
        <credential-id>
 
 
 
os set credential
 
        [--user <user>]
 
        [--type <type>]
 
        [--data <data>]
 
        [--project <project>]
 
        <credential-id>
 
 
</source>
 
</source>
 
+
|-
 
+
|
'''domain'''
 
 
 
 
<source lang="bash">
 
<source lang="bash">
keystone domain-create --name <domain-name>
+
os service show
                      [--description <domain-description>]
+
    [--catalog]
                      [--enabled <true|false>]
+
    <service>
                      [--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>
 
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone domain-delete <domain-id>
+
keystone service-get
 
+
    <service-id>
os delete domain <domain>
 
 
</source>
 
</source>
 +
|}
  
 +
==== tenant ====
  
 +
{| class="wikitable"
 +
|-
 +
! OSC Command !! Implemented !! !! Keystone command
 +
|-
 +
|
 
<source lang="bash">
 
<source lang="bash">
keystone domain-get <domain-id>
+
os tenant create
 
+
    [--description <description>]
os show domain <domain>
+
    [--enable | --disable]
 +
    <tenant-name>
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone domain-list
+
keystone tenant-create
 
+
    --name <tenant-name>
os list domain [--long]
+
    [--description <tenant-description>]
 +
    [--enabled <true|false>]
 
</source>
 
</source>
 
+
|-
 
+
|
 
<source lang="bash">
 
<source lang="bash">
keystone domain-update
+
os tenant delete
        [--name <domain_name>]
+
    <tenant>
        [--description <domain-description>]
+
</source>
        [--enabled <true|false>]
+
|| yes
        [--private_project_names <true|false>]
+
|| ||
        [--private_user_names <true|false>]
+
<source lang="bash">
        <domain-id>
+
keystone tenant-delete
 
+
    <tenant>
os set domain
 
        [--name <new-domain-name>]
 
        [--description <new-domain-description>]
 
        [--private_project_names]
 
        [--private_user_names]
 
        [--enable | --disable]
 
        <domain>
 
 
</source>
 
</source>
 
+
|-
 
+
|
'''endpoint'''
 
 
 
 
<source lang="bash">
 
<source lang="bash">
keystone endpoint-create --service_id <service-id>
+
os tenant list
--interface <endpoint-interface>
+
    [--long]
--url <endpoint-url>
 
[--region <endpoint-region>]
 
                        [--enabled <true|false>]
 
 
 
os create endpoint
 
[--region <endpoint-region>]
 
        [--enabled <true|false>]
 
<service-id>
 
<endpoint-interface>
 
<endpoint-url>
 
       
 
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone endpoint-delete <endpoint-id>
+
keystone tenant-list
 
 
os delete endpoint <endpoint-id>
 
 
</source>
 
</source>
 
+
|-
 
+
|
 
<source lang="bash">
 
<source lang="bash">
keystone endpoint-list
+
os tenant set
 
+
    [--name <new-tenant-name>]
os list endpoint [--long]
+
    [--description <new-tenant-description>]
 +
    [--enable | --disable]
 +
    <tenant>
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone enpoint-get <endpoint-id>
+
keystone tenant-update
 
+
    [--name <tenant_name>]
os show endpoint <endpoint-id>
+
    [--description <tenant-description>]
 +
    [--enabled <true|false>]
 +
    <tenant-id>
 
</source>
 
</source>
 
+
|-
 
+
|
 
<source lang="bash">
 
<source lang="bash">
keystone endpoint-update --endpoint_id <endpoint-id>
+
os tenant show
[--region <endpoint-region>]
+
    <tenant>
        [--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>
 
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
'''group'''
 
 
 
 
<source lang="bash">
 
<source lang="bash">
keystone group-create --name <group-name>
+
keystone tenant-get
                      [--domain_id <domain-id>]
+
    <tenant-id>
                      [--description <group-description>]
 
 
 
os create group
 
        [--domain <domain>]
 
        [--description <group-description>]
 
        <group-name>
 
 
</source>
 
</source>
 +
|}
  
 +
==== token ====
  
 +
{| class="wikitable"
 +
|-
 +
! OSC Command !! Implemented !! !! Keystone command
 +
|-
 +
|
 
<source lang="bash">
 
<source lang="bash">
keystone group-delete <group-id>
+
os token show
 
+
    [--width <token-display-width>]
os delete group <group>
 
 
</source>
 
</source>
 
+
|| ??
 
+
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone group-get <group-id>
+
keystone token-get [--wrap <integer>]
 
 
os show group <group>
 
 
</source>
 
</source>
 +
|}
  
 +
==== user ====
  
 +
{| class="wikitable"
 +
|-
 +
! OSC Command !! Implemented !! !! Keystone command
 +
|-
 +
|
 
<source lang="bash">
 
<source lang="bash">
keystone group-list
+
os user create
 
+
    [--password <user-password>]
os list group [--long]
+
    [--email <user-email>]
 +
    [--tenant <tenant>]
 +
    [--enable | --disable]
 +
    <user-name>
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone group-update
+
keystone user-create
        [--name <group_name>]
+
    --name <user-name>  
        [--domain_id <domain-id>]
+
    [--tenant_id <tenant-id>]
        [--description <group-description>]
+
    [--pass <pass>]  
        <group-id>
+
    [--email <email>]
 
+
    [--enabled <true|false>]
os set group
 
        [--name <new-group-name>]
 
        [--domain <domain>]
 
        [--description <new-group-description>]
 
        <group>
 
 
</source>
 
</source>
 
+
|-
 
+
|
'''policy'''
 
 
 
 
<source lang="bash">
 
<source lang="bash">
keystone policy-create --type <policy-type>
+
os user delete
                      --blob <policy-blob>
+
    <user>
 
 
os create policy
 
        --type <policy-type>
 
        --blob <policy-blob>
 
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone policy-delete <policy-id>
+
keystone user-delete
 
+
    <user-id>
os delete policy <policy-id>
 
 
</source>
 
</source>
 
+
|-
 
+
|
 
<source lang="bash">
 
<source lang="bash">
keystone policy-get <policy-id>
+
os user list
 
+
    [--tenant <tenant>]
os show policy <policy-id>
+
    [--long]
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone policy-list
+
keystone user-list
 
+
    [<tenant-id>]
os list policy [--long]
 
 
</source>
 
</source>
 
+
|-
 
+
|
 
<source lang="bash">
 
<source lang="bash">
keystone policy-update
+
os user set
        [--type <policy-type>]
+
    [--name <new-user-name>]
        [--blob <policy-blob>]
+
    [--password <user-password>]
        <policy-id>
+
    [--email <user-email>]
 
+
    [--tenant <tenant>]
os set policy
+
    [--enable|--disable]
        [--type <policy-type>]
+
    <user>
        [--blob <policy-blob>]
 
        <policy-id>
 
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
'''project'''
 
 
 
 
<source lang="bash">
 
<source lang="bash">
keystone project-create --name <project-name>
+
keystone user-password-update
                      [--domain_id <project-domain-id>]
+
    --pass <password>
                      [--description <project-description>]
+
    <user-id>
                      [--enabled <true|false>]
 
 
 
os create project
 
        [--domain <project-domain>]
 
        [--description <project-description>]
 
        [--enable | --disable]
 
        <project-name>
 
 
</source>
 
</source>
 
+
|-
 
+
|
 
<source lang="bash">
 
<source lang="bash">
keystone project-delete <project-id>
+
os user show
 
+
    <user>
os delete project <project>
 
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone project-get <project-id>
+
keystone user-get
 
+
    <user-id>
os show project <project>
 
 
</source>
 
</source>
 +
|}
  
 +
==== user role ====
  
 +
{| class="wikitable"
 +
|-
 +
! OSC Command !! Implemented !! !! Keystone command
 +
|-
 +
|
 
<source lang="bash">
 
<source lang="bash">
keystone project-list
+
os user role add
 
+
    [--tenant <tenant>]
os list project [--long]
+
    <user>
 +
    <role>
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone project-update
+
keystone user-role-add
        [--name <project_name>]
+
    --user <user-id>
        [--domain_id <project-domain-id>]
+
    --role <role-id>
        [--description <project-description>]
+
    [--tenant_id <tenant-id>]
        [--enabled <true|false>]
 
        <project-id>
 
 
 
os set project
 
        [--name <new-project-name>]
 
        [--domain <project-domain>]
 
        [--description <new-project-description>]
 
        [--enable | --disable]
 
        <project>
 
 
</source>
 
</source>
 
+
|-
 
+
|
'''role'''
+
<source lang="bash">
 
+
os user role list
 +
    [--tenant <tenant>]
 +
    [<user>]
 +
</source>
 +
|| yes
 +
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone role-create --name <role-name>
+
keystone user-role-list
 
+
    [--user <user-id>]
os create role <role-name>
+
    [--tenant_id <tenant-id>]
 
</source>
 
</source>
 
+
|-
 
+
|
 
<source lang="bash">
 
<source lang="bash">
keystone role-delete <role-id>
+
os user role remove
 
+
    [--tenant <tenant>]
os delete role <role>
+
    <user>
 +
    <role>
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone role-get <role-id>
+
keystone user-role-remove
 +
    --user <user-id>
 +
    --role <role-id>
 +
    [--tenant_id <tenant-id>]
 +
</source>
 +
|}
  
os show role <role>
+
==== <other> ====
</source>
 
  
 +
These keystone commands are not planned for re-implementation in OpenStackClient
  
 
<source lang="bash">
 
<source lang="bash">
keystone role-list
+
keystone bootstrap
 
+
        --pass <password>
os list role
+
        [--user-name <user-name>]
 +
        [--role-name <role-name>]
 +
        [--tenant-name <tenant-name>]
 
</source>
 
</source>
 
  
 
<source lang="bash">
 
<source lang="bash">
keystone role-update <role-id>
+
keystone discover
 
 
os update role <role>
 
 
</source>
 
</source>
  
 +
=== API v3 ===
  
'''service'''
+
==== credential ====
  
 +
{| class="wikitable"
 +
|-
 +
! OSC Command !! Implemented !! !! Keystone command
 +
|-
 +
|
 
<source lang="bash">
 
<source lang="bash">
keystone service-create --type <type>
+
os credential create
[--name <name>]
+
    [--project <project>]
                        [--enabled <true|false>]
+
    [--type ec2|cert]
 
+
    <user>
os create service
+
    <data>
[--name <name>]
 
        [--enabled <true|false>]
 
        <type>
 
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone service-delete <service-id>
+
keystone credential-create
 
+
    --user_id <user-id>
os delete service <service>
+
    --type <credential-type>
 +
    --data <credential-data>
 +
    [--project_id <project-id>]
 
</source>
 
</source>
 
+
|-
 
+
|
 
<source lang="bash">
 
<source lang="bash">
keystone service-get <service-id>
+
os credential delete
 
+
    <credential-id>
os show service <service>
 
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone service-list
+
keystone credential-delete
 
+
    <credential-id>
os list service [--long]
 
 
</source>
 
</source>
 
+
|-
 
+
|
 
<source lang="bash">
 
<source lang="bash">
keystone service-update --service_id <service-id>
+
os credential list
[--type <type>]
 
[--name <name>]
 
                        [--enabled <true|false>]
 
 
 
os update service
 
[--type <type>]
 
[--name <name>]
 
        [--enabled <true|false>]
 
        <service>
 
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
'''user'''
+
<source lang="bash">
 
+
keystone credential-list
 +
</source>
 +
|-
 +
|
 
<source lang="bash">
 
<source lang="bash">
keystone user-create --name <user-name>
+
os credential set
                    [--domain_id <domain-id>]
+
    [--user <user>]
                    [--default_project_id <project-id>]
+
    [--type ec2|cert]
                    [--description <description>]
+
    [--data <data>]
                    [--enabled <true|false>]
+
    [--project <project>]
                    [--password <password>]  
+
    <credential-id>
 
 
os create user
 
        [--domain_id <domain-id>]
 
        [--default_project_id <project-id>]
 
        [--description <description>]
 
        [--enabled <true|false>]
 
        [--password <password>]
 
        <user-name>
 
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone user-delete <user-id>
+
keystone credential-update
 
+
    [--user <user>]
os delete user <user>
+
    [--type <type>]
 +
    [--data <data>]
 +
    [--project <project>]
 +
    <credential-id>
 
</source>
 
</source>
 
+
|-
 
+
|
 
<source lang="bash">
 
<source lang="bash">
keystone user-get <user-id>
+
os credential show
 
+
    <credential-id>
os show user <user>
 
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone user-list
+
keystone credential-get
 
+
    <credential-id>
os list user [--long]
 
 
</source>
 
</source>
 +
|}
  
 
+
==== domain ====
<source lang="bash">
 
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 set user
 
        [--domain_id <domain-id>]
 
        [--default_project_id <project-id>]
 
        [--description <description>]
 
        [--enabled <true|false>]
 
        [--password <password>]
 
        [--user_name <user-name>]
 
        <user>
 
</source>
 
 
 
 
 
== Compute ==
 
 
 
 
 
{| class="wikitable"
 
|-
 
! Nova Option !!  Environment Variable !!  !!  OSC 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====
 
 
 
====flavor====
 
  
 
{| class="wikitable"
 
{| class="wikitable"
 
|-
 
|-
! OSC Command !! Implemented !! !! Nova command
+
! OSC Command !! Implemented !! !! Keystone command
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os create agent
+
os domain create
     <os>
+
     [--description <domain-description>]
     <architecture>
+
    [--enable | --disable]
     <version>
+
    <domain-name>
     <url>
+
</source>
     <md5hash>
+
|| yes
     <hypervisor>
+
|| ||
 +
<source lang="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>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 +
<source lang="bash">
 +
keystone domain-delete
 +
    <domain-id>
 +
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os delete agent
+
os domain list
    <id>
 
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 +
<source lang="bash">
 +
keystone domain-list
 +
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os list agent
+
os domain set
     [--hypervisor <hypervisor>]
+
     [--name <new-domain-name>]
 +
    [--description <new-domain-description>]
 +
    [--enable | --disable]
 +
    <domain>
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 +
<source lang="bash">
 +
keystone domain-update
 +
    [--name <domain_name>]
 +
    [--description <domain-description>]
 +
    [--enabled <true|false>]
 +
    [--private_project_names <true|false>]
 +
    [--private_user_names <true|false>]
 +
    <domain-id>
 +
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os set agent
+
os domain show
     <id>
+
     <domain>
    <version>
 
    <url>
 
    <md5hash>
 
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
|}
 
 
 
'''aggregate'''
 
 
 
<source lang="bash">
 
<source lang="bash">
nova aggregate-create <name> <availability_zone>
+
keystone domain-get
 
+
    <domain-id>
os create aggregate ...
 
 
</source>
 
</source>
 +
|}
  
 +
==== endpoint ====
  
 +
{| class="wikitable"
 +
|-
 +
! OSC Command !! Implemented !! !! Keystone command
 +
|-
 +
|
 
<source lang="bash">
 
<source lang="bash">
nova aggregate-delete <id>
+
os endpoint create
 
+
    [--region <endpoint-region>
os delete aggregate ...
+
    [--enable | --disable]
 +
    <service>
 +
    <interface admin|public|internal>
 +
    <url>
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova aggregate-details <id>
+
keystone endpoint-create
 
+
    [--region <endpoint-region>
os show aggregate ...
+
    [--enable | --disable]
 +
    <service_id>
 +
    <interface admin|public|internal>
 +
    <url>
 
</source>
 
</source>
 
+
|-
 
+
|
 
<source lang="bash">
 
<source lang="bash">
nova aggregate-list
+
os endpoint delete
 
+
    <endpoint-id>
os list aggregate
 
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova aggregate-update <id> <name> [<availability_zone>]
 
 
os set aggregate ...
 
 
</source>
 
</source>
 
+
|-
 
+
|
 
<source lang="bash">
 
<source lang="bash">
nova aggregate-set-metadata <id> <key=value> [<key=value> ...]
+
os endpoint list
 
+
    [--long]
os set aggregate --metadata ...
 
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
'''aggregate-host'''
+
<source lang="bash">
 
+
keystone endpoint-list
 +
</source>
 +
|-
 +
|
 
<source lang="bash">
 
<source lang="bash">
nova aggregate-add-host <id> <host>
+
os endpoint set
 
+
    [--interface <endpoint-interface>]
os add aggregate-host ...
+
    [--url <endpoint-url>]
 +
    [--service <service-id>]
 +
    [--region <endpoint-region>]
 +
    [--enable | --disable]
 +
    <endpoint>
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova aggregate-remove-host <id> <host>
+
keystone endpoint-set
 
+
    [--interface <endpoint-interface>]
os remove aggregate-host ...
+
    [--url <endpoint-url>]
 +
    [--service <service-id>]
 +
    [--region <endpoint-region>]
 +
    [--enable | --disable]
 +
    <endpoint>
 
</source>
 
</source>
 
+
|-
 
+
|
'''bash-completion'''
 
 
 
 
<source lang="bash">
 
<source lang="bash">
nova bash-completion
+
os endpoint show
 
+
    <endpoint>
os show bash-completion
 
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
'''cloudpipe'''
 
 
 
 
<source lang="bash">
 
<source lang="bash">
nova cloudpipe-create <project>
+
keystone endpoint-get
 
+
    <endpoint>
os create cloudpipe ...
 
 
</source>
 
</source>
 +
|}
  
 +
==== group ====
  
 +
{| class="wikitable"
 +
|-
 +
! OSC Command !! Implemented !! !! Keystone command
 +
|-
 +
|
 
<source lang="bash">
 
<source lang="bash">
nova cloudpipe-list
+
os group create
 
+
    [--domain <domain>]
os list cloudpipe
+
    [--description <group-description>]
 +
    <group-name>
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
'''console'''
 
 
 
 
<source lang="bash">
 
<source lang="bash">
nova console-log [--length <length>] <server>
+
keystone group-create
 
+
    --name <group-name>
os show console ...
+
    [--domain_id <domain-id>]
 +
    [--description <group-description>]
 
</source>
 
</source>
 
+
|-
 
+
|
 
<source lang="bash">
 
<source lang="bash">
nova get-vnc-console <server> <console_type>
+
os group delete
 
+
    <group>
os show console [--vnc] ...
 
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
'''credentials'''
 
 
 
 
<source lang="bash">
 
<source lang="bash">
nova credentials
+
keystone group-delete
 
+
    <group-id>
os show credentials
 
 
</source>
 
</source>
 
+
|-
 
+
|
'''diagnostics'''
 
 
 
 
<source lang="bash">
 
<source lang="bash">
nova diagnostics <server>
+
os group list
 
+
    [--long]
os show diagnostics ...
 
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
'''dns'''
 
 
 
 
<source lang="bash">
 
<source lang="bash">
nova dns-create [--type <type>] <ip> <name> <domain>
+
keystone group-list
 
 
os create dns ...
 
 
</source>
 
</source>
 
+
|-
 
+
|
 
<source lang="bash">
 
<source lang="bash">
nova dns-delete <domain> <name>
+
os group set
 
+
    [--name <new-group-name>]
os delete dns ...
+
    [--domain <domain>]
 +
    [--description <new-group-description>]
 +
    <group>
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova dns-list [--ip <ip>] [--name <name>] <domain>
+
keystone group-update
 
+
    [--name <group_name>]
os list dns ...
+
    [--domain_id <domain-id>]
 +
    [--description <group-description>]
 +
    <group-id>
 
</source>
 
</source>
 
+
|-
 
+
|
'''dns-domain'''
 
 
 
 
<source lang="bash">
 
<source lang="bash">
nova dns-create-private-domain [--availability_zone <availability_zone>]
+
os group show
                              <domain>
+
    <group>
 
 
os create dns-domain [--private] ...
 
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
'''dns-public-domain'''
 
 
 
 
<source lang="bash">
 
<source lang="bash">
nova dns-create-public-domain [--project <project>] <domain>
+
keystone group-get
 
+
    <group-id>
os create dns-domain [--public] ...
 
 
</source>
 
</source>
 +
|}
  
 +
==== oauth ====
  
 +
{| class="wikitable"
 +
|-
 +
! OSC Command !! Implemented !! !! Keystone command
 +
|-
 +
|
 
<source lang="bash">
 
<source lang="bash">
nova dns-delete-domain <domain>
+
os access token create
 
+
    --consumer-key <consumer-key>
os delete dns-domain ...
+
    --consumer-secret <consumer-secret>
 +
    --request-key <request-key>
 +
    --request-secret <request-secret>
 +
    --verifier <pin>
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova dns-domains
+
n/a
 
 
os list dns-domains
 
 
</source>
 
</source>
 
+
|-
 
+
| look at some alternatives: || || ||
'''endpoints'''
+
|-
 
+
|
 
<source lang="bash">
 
<source lang="bash">
nova endpoints
+
os oauth token create
 
+
    --consumer-key <consumer-key>
os list endpoints
+
    --consumer-secret <consumer-secret>
 
+
    --request-key <request-key>
# does this overlap with keystone?
+
    --request-secret <request-secret>
 +
    --verifier <pin>
 
</source>
 
</source>
 
+
|| nyet
 
+
|| ||
'''fixed-ip'''
 
 
 
 
<source lang="bash">
 
<source lang="bash">
nova add-fixed-ip <server> <network_id>
+
* makes the token specific to oauth
 
+
* add [--oauth-ver X] if versioning for oauth2 is an issue?
os add fixed-ip ...
 
 
</source>
 
</source>
 
+
|-
 
+
|
 
<source lang="bash">
 
<source lang="bash">
nova remove-fixed-ip <server> <address>
+
os oauth token create
 +
    --access
 +
    --consumer-key <consumer-key>
 +
    --consumer-secret <consumer-secret>
 +
    --request-key <request-key>
 +
    --request-secret <request-secret>
 +
    --verifier <pin>
  
os remove fixed-ip ...
+
os oauth token create
 +
    --request
 +
    --consumer-key <consumer-key>
 +
    --roles <roles>
 
</source>
 
</source>
 +
|| nyet
 +
|| ||
 +
<source lang="bash">
 +
* collapse 'access token' and 'request token' into 'oauth token'?
 +
</source>
 +
|}
  
 
+
==== policy ====
====flavor====
 
  
 
{| class="wikitable"
 
{| class="wikitable"
 
|-
 
|-
! OSC Command !! Implemented !! !! Nova command
+
! OSC Command !! Implemented !! !! Keystone command
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os create flavor
+
os policy create
     [--disk <size-gb>]
+
     [--type <policy-type>]
     [--ephemeral-disk <size-gb>]
+
     --blob-file <blob-file>
    [--id <id>]
 
    [--ram <size-mb>]
 
    [--swap <size-mb>]
 
    [--rxtx-factor <factor>]
 
    [--vcpus <num-cpu>]
 
    <name>
 
 
</source>
 
</source>
|| (partial)
+
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova flavor-create
+
keystone policy-create
     [--ephemeral <ephemeral>]
+
     --type <policy-type>
     [--swap <swap>]
+
     --blob <policy-blob>
    [--rxtx-factor <factor>]
 
    <name>
 
    <id>
 
    <ram>
 
    <disk>
 
    <vcpus>
 
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os delete flavor
+
os policy delete
     <flavor>
+
     <policy-id>
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova flavor-delete  
+
keystone policy-delete
     <id>
+
     <policy-id>
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os list flavor
+
os policy list
 +
    [--include-blob]
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova flavor-list
+
keystone policy-list
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os show flavor
+
os policy set
     <flavor>
+
     [--type <policy-type>]
 +
    [--blob-file<blob-file>]
 +
    <policy-id>
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
|}
 
 
 
'''floating-ip'''
 
 
 
<source lang="bash">
 
<source lang="bash">
nova add-floating-ip <server> <address>
+
keystone policy-update
 
+
    [--type <policy-type>]
os add floating-ip ...
+
    [--blob <policy-blob>]
 +
    <policy-id>
 +
</source>
 +
|-
 +
|
 +
<source lang="bash">
 +
os policy show
 +
    <policy-id>
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova floating-ip-create [<floating_ip_pool>]
+
keystone policy-get
 
+
    <policy-id>
os create floating-ip ...
 
 
</source>
 
</source>
 +
|}
  
 +
==== project ====
  
 +
{| class="wikitable"
 +
|-
 +
! OSC Command !! Implemented !! !! Keystone command
 +
|-
 +
|
 
<source lang="bash">
 
<source lang="bash">
nova floating-ip-delete <address>
+
os project create
 
+
    [--domain <project-domain>]
os delete floating-ip
+
    [--description <project-description>]
 +
    [--enable | --disable]
 +
    <project-name>
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova floating-ip-list
+
keystone project-create
 
+
    [--domain_id <domain_id>]
os list floating-ip
+
    [--description <description>]
 +
    [--enable | --disable]
 +
    <name>
 
</source>
 
</source>
 
+
|-
 
+
|
 
<source lang="bash">
 
<source lang="bash">
nova remove-floating-ip <server> <address>
+
os project delete
 
+
    <project>
os remove floating-ip ...
 
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
'''floating-ip-pool'''
 
 
 
 
<source lang="bash">
 
<source lang="bash">
nova floating-ip-pool-list
+
os project-delete
 
+
    <project_id>
os list floating-ip-pool
 
 
</source>
 
</source>
 
+
|-
 
+
|
'''host'''
 
 
 
 
<source lang="bash">
 
<source lang="bash">
nova host-action [--action <action>] <hostname>
+
os project list
 
+
    [--long]
os ?? host ...
 
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova host-update [--status <status>]
+
keystone project-list
                [--maintenance <maintenance_mode>]
 
                <hostname>
 
 
 
os set host ...
 
 
</source>
 
</source>
 
+
|-
 
+
|
'''image'''
 
 
 
 
<source lang="bash">
 
<source lang="bash">
nova image-create [--poll] <server> <name>
+
os project set
 
+
    [--name <new-project-name>]
os create image ...
+
    [--domain <project-domain>]
 +
    [--description <new-project-description>]
 +
    [--enable | --disable]
 +
    <project>
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova image-delete <image>
+
keystone project-set
 
+
    [--name <new-project-name>]
os delete image ...
+
    [--domain <project-domain>]
 +
    [--description <new-project-description>]
 +
    [--enable | --disable]
 +
    <project_id>
 
</source>
 
</source>
 
+
|-
 
+
|
 
<source lang="bash">
 
<source lang="bash">
nova image-list
+
os project show
 
+
    <project>
os list image
 
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova image-meta <image> <action> <key=value> [<key=value> ...]
+
keystone project-get
 
+
    <project_id>
os set image ...
 
 
</source>
 
</source>
 +
|}
  
 +
==== role ====
  
 +
{| class="wikitable"
 +
|-
 +
! OSC Command !! Implemented !! !! Keystone command
 +
|-
 +
|
 
<source lang="bash">
 
<source lang="bash">
nova image-show <image>
+
os role add
 
+
    [--user <user> | --group <group>]
os show image ...
+
    [--domain <domain> | --project <project>]
 +
    <role>
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
'''keypair'''
 
 
 
 
<source lang="bash">
 
<source lang="bash">
nova keypair-add [--pub_key <pub_key>] <name>
 
 
os create keypair ...
 
 
</source>
 
</source>
 
+
|-
 
+
|
 
<source lang="bash">
 
<source lang="bash">
nova keypair-delete <name>
+
os role create
 
+
    <role-name>
os delete keypair
 
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova keypair-list
 
 
os list keypair
 
 
</source>
 
</source>
 
+
|-
 
+
|
'''limits'''
+
<source lang="bash">
 
+
os role delete
 +
    <role>
 +
</source>
 +
|| yes
 +
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova absolute-limits
 
 
os show limits --absolute
 
## is there any other kind?
 
 
</source>
 
</source>
 
+
|-
 
+
|
'''quota'''
 
 
 
 
<source lang="bash">
 
<source lang="bash">
nova quota-defaults <tenant_id>
+
os role list
nova quota-show <tenant_id>
 
 
 
os show quota <tenant> [--defaults]
 
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
 
<source lang="bash">
 
<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 set quota ...
 
 
</source>
 
</source>
 
+
|-
 
+
|
'''quota-class'''
 
 
 
 
<source lang="bash">
 
<source lang="bash">
nova quota-class-show <class>
+
os role remove
 
+
    [--user <user> | --group <group>]
os show quota-class ...
+
    [--domain <domain> | --project <project>]
 +
    <role>
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
 
<source lang="bash">
 
<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>
 
 
os set quota-class ...
 
 
</source>
 
</source>
 
+
|-
 
+
|
'''rate-limits'''
 
 
 
 
<source lang="bash">
 
<source lang="bash">
nova rate-limits
+
os role set
 
+
    [--name <new-role-name>]
os show rate-limits
+
    <role>
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
'''resource'''
 
 
 
 
<source lang="bash">
 
<source lang="bash">
nova describe-resource <hostname>
 
 
os show resource ...
 
 
</source>
 
</source>
 
+
|-
 
+
|
'''secgroup'''
 
 
 
 
<source lang="bash">
 
<source lang="bash">
nova secgroup-create <name> <description>
+
os role show
 
+
    <role>
os create secgroup ...
 
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova secgroup-delete <secgroup>
 
 
os delete secgroup ...
 
 
</source>
 
</source>
 +
|}
  
 +
==== service ====
  
<source lang="bash">
+
{| class="wikitable"
nova secgroup-list
+
|-
 
+
! OSC Command !! Implemented !! !! Keystone command
os list secgroup
+
|-
 +
|
 +
<source lang="bash">
 +
os service create
 +
[--name <name>]
 +
        [--enabled <true|false>]
 +
        <type>
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
'''secgroup-group-rule'''
 
 
 
 
<source lang="bash">
 
<source lang="bash">
nova secgroup-add-group-rule [--ip_proto <ip_proto>]
+
keystone service-create
                            [--from_port <from_port>]
+
[--name <name>]
                            [--to_port <to_port>]
+
        [--enabled <true|false>]
                            <secgroup> <source_group>
+
        <type>
 
 
os create secgroup-group-rule
 
 
</source>
 
</source>
 
+
|-
 
+
|
 
<source lang="bash">
 
<source lang="bash">
nova secgroup-delete-group-rule [--ip_proto <ip_proto>]
+
os service delete
                                [--from_port <from_port>]
+
    <service>
                                [--to_port <to_port>]
 
                                <secgroup> <source_group>
 
 
 
os delete secgroup-group-rule ...
 
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
'''secgroup-rule'''
 
 
 
 
<source lang="bash">
 
<source lang="bash">
nova secgroup-add-rule <secgroup> <ip_proto> <from_port> <to_port> <cidr>
+
keystone service-delete
 
+
    <service_id>
os create secgroup-rule
 
 
</source>
 
</source>
 
+
|-
 
+
|
 
<source lang="bash">
 
<source lang="bash">
nova secgroup-delete-rule <secgroup> <ip_proto> <from_port> <to_port> <cidr>
+
os list service
 
 
os delete secgroup-rule
 
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova secgroup-list-rules <secgroup>
+
keystone service-list
 
 
os list secgroup-rule ...
 
 
</source>
 
</source>
 
 
====server====
 
 
{| class="wikitable"
 
|-
 
! OSC Command !! Implemented !! !! Nova command
 
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os create server
+
os service set
    --image <image>
+
     [--type <service-type>]
    --flavor <flavor>
+
     [--name <new-name>]
    [--security-group <security-group-list> [...] ]
+
     [--enable | --disable]
    [--key-name <key-name>]
+
     <service>
    [--meta-data <key=value> [--meta-data <key=value] [...] ]
 
    [--file <dest-filename=source-filename> [--file <dest-filename=source-filename>] [...] ]
 
     [--user-data <user-data>]
 
    [--reservation-id <uuid>]
 
     [--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>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova boot
+
keystone service-set
    [--flavor <flavor>]
+
     [--type <service-type>]
     [--image <image>]
+
     [--name <new-name>]
    [--meta <key=value>]
+
     [--enable | --disable]
     [--file <dst-path=src-path>]
+
     <service>
    [--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>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os delete server
+
os service show
     <server>
+
     <service>
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova delete
+
keystone service-get
     <server>
+
     <service_id>
 
</source>
 
</source>
 +
|}
 +
 +
==== user ====
 +
 +
{| class="wikitable"
 +
|-
 +
! OSC Command !! Implemented !! !! Keystone command
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os list server
+
os user create
     [--reservation-id <reservation-id>]  
+
     [--password <password>]  
     [--ip <ip-regex>]
+
     [--project <project>]
     [--ip6 <ip6-regex>]  
+
     [--email <user-email>]
     [--name <name-regex>]
+
     [--enable | --disable]
     [--instance-name <instance-name-regex>]
+
    <name>
     [--status <status>]
+
</source>
     [--flavor <flavor>]
+
|| yes
     [--image <image>]  
+
|| ||
     [--host <hostname>]
+
<source lang="bash">
     [--all-tenants]
+
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>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova list
+
keystone user-delete
    [--reservation_id <reservation_id>]
+
     <user-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>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os lock server
+
os user list
     <server>
+
     [--project <project>]
 +
    [--long]
 
</source>
 
</source>
|| no
+
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova lock
+
keystone user-list
    <server>
 
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os migrate server
+
os user set
     --live
+
     [--name <new-name>]
     [--block_migrate]
+
     [--password <password>]  
     [--disk_over_commit]
+
     [--project <project>]
    <server>
+
     [--email <user-email>]
     <host>
+
     [--enable | --disable]
 
+
     <user>
os migrate server
+
</source>
     [--wait]
+
|| yes
     <server>
 
</source>
 
|| no
 
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova live-migration
+
keystone user-update
     [--block_migrate]  
+
    --user_id <user-id>
     [--disk_over_commit]
+
     [--name <user-name>]
     <server>
+
     [--domain_id <domain-id>]
<host>
+
     [--default_project_id <project-id>]
 
+
    [--description <description>]
nova migrate
+
     [--enabled <true|false>]
     [--poll]
+
     [--password <password>]
     <server>
 
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os pause server
+
os user show
     <server>
+
     <user>
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova pause
+
keystone user-get
     <server>
+
     <user-id>
 
</source>
 
</source>
|-
+
|}
|
+
 
<source lang="bash">
+
== Compute ==
os reboot server
+
 
     [--hard | --soft]
+
 
     [--wait]
+
{| class="wikitable"
     <server>
+
|-
 +
! 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 ====
 +
 
 +
{| class="wikitable"
 +
|-
 +
! OSC Command !! Implemented !! !! Nova command
 +
|-
 +
|
 +
<source lang="bash">
 +
os agent create
 +
    <os>
 +
     <architecture>
 +
    <version>
 +
    <url>
 +
     <md5hash>
 +
     <hypervisor>
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 +
|-
 +
|
 
<source lang="bash">
 
<source lang="bash">
nova reboot
+
os agent delete
    [--hard]
+
     <id>
    [--poll]
 
     <server>
 
 
</source>
 
</source>
 +
|| yes
 +
|| ||
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os rebuild server
+
os agent list
    --image <image>
+
     [--hypervisor <hypervisor>]
     [--rebuild-password <rebuild-password>]  
 
    [--wait]
 
    <server>
 
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
<source lang="bash">
 
nova rebuild
 
    [--rebuild_password <rebuild_password>]
 
    [--poll]
 
    <server>
 
    <image>
 
</source>
 
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os rename server
+
os agent set
     <server>
+
     <id>
     <new-name>
+
     <version>
 +
    <url>
 +
    <md5hash>
 
</source>
 
</source>
|| no
+
|| yes
 
|| ||
 
|| ||
<source lang="bash">
+
|}
nova rename
+
 
    <server>
+
 
    <name>
+
==== aggregate ====
</source>
+
 
 +
{| class="wikitable"
 +
|-
 +
! OSC Command !! Implemented !! !! Nova command
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os rescue server
+
os aggregate add host
     <server>
+
     <aggregate>
 +
    <host>
 
</source>
 
</source>
|| no
+
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova rescue
+
nova aggregate-add-host
     <server>
+
     <id>
 +
    <host>
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os resize server --flavor <flavor> [--wait] <server>
+
os aggregate create
 +
    [--zone <availability-zone>]
 +
    [--property <key=value>]
 +
    <name>
 
</source>
 
</source>
|| no
+
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova resize [--poll] <server> <flavor>
+
nova aggregate-create
 +
    <name>
 +
    [<availability_zone>]
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os resize server
+
os aggregate delete
    --confirm
+
     <aggregate>
     <server>
 
 
</source>
 
</source>
|| no
+
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova resize-confirm
+
nova aggregate-delete
     <server>
+
     <id>
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os resume server <server>
+
os aggregate list
 +
    [--long]
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova resume <server>
+
nova aggregate-list
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
|]
 
 
<source lang="bash">
 
<source lang="bash">
nova resize-revert <server>
+
os aggregate remove host
 
+
    <aggregate>
os resize server --revert <server>
+
    <host>
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova meta <server> <action> <key=value> [<key=value> ...]
+
nova aggregate-remove-host
 
+
    <id>
os set server
+
    <host>
          --meta-data <key=value>
 
          [--meta-data <key=value>] ...
 
          <server>
 
os unset server
 
          --meta-data <key>
 
          [--meta-data <key>] ...
 
          <server>
 
 
</source>
 
</source>
 
+
|-
 
+
|
 
<source lang="bash">
 
<source lang="bash">
nova root-password <server>
+
os aggregate set
 
+
    [--name <new-name>]
os set server --root-password <server>
+
    [--zone <availability-zone>]
 +
    [--property <key=value>]
 +
    <aggregate>
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova show <server>
+
nova aggregate-update
 +
    <id>
 +
    <name>
 +
    [<availability_zone>]
  
os show server <server>
+
nova aggregate-set-metadata
 +
    <id>
 +
    <key=value>
 +
    [<key=value> ...]
 
</source>
 
</source>
 
+
|-
 
+
|
 
<source lang="bash">
 
<source lang="bash">
nova ssh [--port PORT] [--private] [--ipv6] [--login <login>] <server>
+
os aggregate show
 
+
    <aggregate>
os ssh server
 
          [--port PORT]
 
          [--private]
 
          [--ipv6]
 
          [--login <login>]
 
          <server>
 
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova suspend <server>
+
nova aggregate-details
 
+
    <id>
os suspend server <server>
 
 
</source>
 
</source>
 +
|}
  
 +
==== bash-completion ====
  
 +
{| class="wikitable"
 +
|-
 +
! OSC Command !! Implemented !! !! Nova command
 +
|-
 +
|
 +
TBD
 +
|| no
 +
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova unlock <server>
+
nova bash-completion
 
 
os unlock server <server>
 
 
</source>
 
</source>
 +
|}
  
 +
==== cloudpipe ====
  
 +
{| class="wikitable"
 +
|-
 +
! OSC Command !! Implemented !! !! Nova command
 +
|-
 +
|
 
<source lang="bash">
 
<source lang="bash">
nova unpause <server>
+
os create cloudpipe
 
+
    <project>
os unpause server <server>
 
 
</source>
 
</source>
 
+
|| no
 
+
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova unrescue <server>
+
nova cloudpipe-create
 
+
    <project>
os unrescue server <server>
 
 
</source>
 
</source>
 
+
|-
 
+
|
'''usage'''
 
 
 
 
<source lang="bash">
 
<source lang="bash">
nova usage-list [--start <start>] [--end <end>]
+
os list cloudpipe
 
 
os list usage ...
 
 
</source>
 
</source>
 
+
|| no
 
+
|| ||
'''volume'''
 
 
 
 
<source lang="bash">
 
<source lang="bash">
nova volume-attach <server> <volume> <device>
+
nova cloudpipe-list
 
 
os attach volume ...
 
 
</source>
 
</source>
 +
|}
  
 +
==== console ====
  
 +
{| class="wikitable"
 +
|-
 +
! OSC Command !! Implemented !! !! Nova command
 +
|-
 +
|
 
<source lang="bash">
 
<source lang="bash">
nova volume-create [--snapshot_id <snapshot_id>]
+
os console log show
                  [--display_name <display_name>]
+
    [--lines <num-lines>]
                  [--display_description <display_description>]
+
    <server>
                  [--volume_type <volume_type>]
 
                  <size>
 
 
 
os create volume ...
 
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova volume-delete <volume>
+
nova console-log
 
+
    [--length <length>]
os delete volume ...
+
    <server>
 
</source>
 
</source>
 
+
|-
 
+
|
 
<source lang="bash">
 
<source lang="bash">
nova volume-detach <server> <volume>
+
os console url show
 
+
    [--novnc | --xvpvnc | --spice]
os detach volume ...
+
    <server>
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova nova volume-list
+
nova get-vnc-console
 
+
    <server>
os list volume
+
    <console_type>
 
</source>
 
</source>
 +
|}
  
 +
==== credentials ====
  
<source lang="bash">
+
See [[#credentials|credentials]] in the [[#Cross_API|cross API section]].
nova volume-show <volume>
 
  
os show volume ...
+
==== diagnostics ====
</source>
 
 
 
 
 
'''volume-snapshot'''
 
  
 +
''Consider implementing this as: show server --diagnostics <server>''
 +
{| class="wikitable"
 +
|-
 +
! OSC Command !! Implemented !! !! Nova command
 +
|-
 +
|
 
<source lang="bash">
 
<source lang="bash">
nova volume-snapshot-create [--force <True|False>]
+
os diagnostics show
                            [--display_name <display_name>]
+
    <server>
                            [--display_description <display_description>]
 
                            <volume_id>
 
 
 
os create volume-snapshot ...
 
 
</source>
 
</source>
 
+
|| no
 
+
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova volume-snapshot-delete <snapshot_id>
+
nova diagnostics
 
+
    <server>
os delete volume-snapshot ...
 
 
</source>
 
</source>
 +
|}
  
 +
==== 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?''
 +
{| class="wikitable"
 +
|-
 +
! OSC Command !! Implemented !! !! Nova command
 +
|-
 +
|
 
<source lang="bash">
 
<source lang="bash">
nova volume-snapshot-list
+
os create dns
 
+
    [--type <type>]
os list volume-snapshot
+
    <ip>
 +
    <name>
 +
    <domain>
 
</source>
 
</source>
 
+
|| no
 
+
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova volume-snapshot-show <snapshot>
+
nova dns-create
 
+
    [--type <type>]
os show volume-snapshot
+
    <ip>
 +
    <name>
 +
    <domain>
 
</source>
 
</source>
 
+
|-
 
+
|
'''volume-type'''
 
 
 
 
<source lang="bash">
 
<source lang="bash">
nova volume-type-create <name>
+
os delete dns
 
+
    <domain>
os create volume-type ...
+
    <name>
 
</source>
 
</source>
 
+
|| no
 
+
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova volume-type-delete <id>
+
nova dns-delete
 
+
    <domain>
os delete volume-type ...
+
    <name>
 
</source>
 
</source>
 
+
|-
 
+
|
 
<source lang="bash">
 
<source lang="bash">
nova volume-type-list
+
os list dns
 
+
    [--ip <ip>]
os list volume-type
+
    [--name <name>]
 +
    <domain>
 
</source>
 
</source>
 
+
|| no
 
+
|| ||
'''x509-cert'''
 
 
 
 
<source lang="bash">
 
<source lang="bash">
nova x509-create-cert [<private_key_file>] [<x509_cert>]
+
nova dns-list
 
+
    [--ip <ip>]
os create x509-cert ...
+
    [--name <name>]
 +
    <domain>
 
</source>
 
</source>
 
+
|-
 
+
|
'''x509-root-cert'''
 
 
 
 
<source lang="bash">
 
<source lang="bash">
nova x509-get-root-cert [<filename>]
+
os create dns-domain
 
+
    [--project <project>]
os show x509-root-cert ...
+
    [--availability-zone <availability-zone>]
 +
    [--public | --private]
 +
    <domain>
 
</source>
 
</source>
 
+
|| no
 
+
|| ||
== Image ==
 
 
 
 
 
{| class="wikitable"
 
|-
 
! Nova Option !!  Environment Variable !!  !!  OSC Option !!  Environment Variable
 
|-
 
| --force ||  ||  ||  ||
 
|-
 
| --dry-run ||  ||  ||  ||
 
|-
 
| --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-endpoint-type <type> || OS_ENDPOINT_TYPE ||  ||  ||
 
|-
 
| --cert-file <file> ||  ||  ||  ||
 
|-
 
| --key-file <file> ||  ||  ||  ||  
 
|-
 
| --timeout <seconds> || ||   ||  ||
 
|-
 
| --no-ssl-compression ||  ||  ||  ||
 
|}
 
 
 
 
 
=== API v2.0 ===
 
 
 
'''image'''
 
 
 
 
<source lang="bash">
 
<source lang="bash">
glance image-create [--id <IMAGE_ID>] [--name <NAME>]
+
nova dns-create-private-domain
                                  [--disk-format <CONTAINER_FORMAT>]
+
    [--availability_zone <availability_zone>]
                                  [--container-format <DISK_FORMAT>]
+
    <domain>
                                  [--owner <TENANT_ID>] [--size <SIZE>]
 
                                  [--min-disk <DISK_GB>] [--min-ram <DISK_RAM>]
 
                                  [--location <IMAGE_URL>] [--checksum <CHECKSUM>]
 
                                  [--copy-from <IMAGE_URL>] [--public] [--protected]
 
                                  [--property <key=value>]
 
  
os create image ...
+
nova dns-create-public-domain
 +
    [--project <project>]
 +
    <domain>
 
</source>
 
</source>
 
+
|-
 
+
|
 
<source lang="bash">
 
<source lang="bash">
glance image-delete <IMAGE_ID>
+
os delete dns-domain
 
+
    <domain>
os delete image ...
 
 
</source>
 
</source>
 
+
|| no
 
+
|| ||
 
<source lang="bash">
 
<source lang="bash">
glance image-list
+
nova dns-delete-domain
 
+
    <domain>
os list image ...
 
 
</source>
 
</source>
 
+
|-
 
+
|
 
<source lang="bash">
 
<source lang="bash">
glance image-show <IMAGE_ID>
+
os list dns-domains
 
 
os show image ...
 
 
</source>
 
</source>
 
+
|| no
 
+
|| ||
 
<source lang="bash">
 
<source lang="bash">
glance member-images [options] <MEMBER>
+
nova dns-domains
 
 
os list image --member <member> [options]
 
 
</source>
 
</source>
 +
|}
  
 +
==== endpoints ====
  
 +
''Totally duplicates Identity catalog command''
 +
{| class="wikitable"
 +
|-
 +
! OSC Command !! Implemented !! !! Nova command
 +
|-
 +
|
 
<source lang="bash">
 
<source lang="bash">
glance show [options] <ID>
+
os endpoint list
 
 
os show image ...
 
 
</source>
 
</source>
 
+
|| no
 
+
|| ||
 
<source lang="bash">
 
<source lang="bash">
glance update [options] <ID> <field1=value1 field2=value2 ...>
+
nova endpoints
 
 
os set image ...
 
 
</source>
 
</source>
 +
|}
  
 +
==== fixed-ip ====
  
'''image-member'''
+
{| class="wikitable"
 
+
|-
 +
! OSC Command !! Implemented !! !! Nova command
 +
|-
 +
|
 
<source lang="bash">
 
<source lang="bash">
glance member-create [--can-share] <IMAGE_ID> <TENANT_ID>
+
os ip fixed add
 
+
    <network>
os create image-member ...
+
    <server>
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
 
<source lang="bash">
 
<source lang="bash">
glance member-delete <IMAGE_ID> <TENANT_ID>
+
nova add-fixed-ip
 
+
    <server>
os list image-member <image> [options]
+
    <network_id>
 
</source>
 
</source>
 
+
|-
 
+
|
 
<source lang="bash">
 
<source lang="bash">
glance member-delete [options] <ID> <MEMBER>
+
os ip fixed remove
 
+
    <ip-address>
os delete image-member ...
+
    <server>
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
 
<source lang="bash">
 
<source lang="bash">
glance member-list [--image-id <IMAGE_ID>] [--tenant-id <TENANT_ID>]
+
nova remove-fixed-ip
 
+
    <server>
os list image-member ...
+
    <address>
 
</source>
 
</source>
 +
|}
  
  
== Volume ==
+
==== flavor ====
 
 
  
 
{| class="wikitable"
 
{| class="wikitable"
|-  
+
|-
! Cinder Option !!  Environment Variable !!   !! OSC Option !! Environment Variable
+
! OSC Command !! Implemented !! !! Nova command
|-  
+
|-
| --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 ===
 
 
 
'''credentials'''
 
 
 
 
<source lang="bash">
 
<source lang="bash">
cinder credentials
+
os flavor create
 
+
    [--id <id>]
os list credential
+
    [--ram <size-mb>]
 +
    [--disk <size-gb>]
 +
    [--ephemeral-disk <size-gb>]
 +
    [--swap <size-mb>]
 +
    [--vcpus <num-cpu>]
 +
    [--rxtx-factor <factor>]
 +
    [--public | --private]
 +
    <name>
 
</source>
 
</source>
 
+
||
'''limits'''
 
 
 
 
<source lang="bash">
 
<source lang="bash">
cinder rate-limits
+
(partial)
 +
default: auto
 +
default: 256M
 +
default: 0G
 +
default: 0G
 +
default: 0G
 +
default: 1
 +
default: 1
 +
default: public
  
os list limit --rate
 
 
</source>
 
</source>
 
+
|| ||
 
 
 
<source lang="bash">
 
<source lang="bash">
cinder absolute-limits
+
nova flavor-create
 
+
    [--ephemeral <ephemeral>]
os list limit --absolute
+
    [--swap <swap>]
 +
    [--rxtx-factor <factor>]
 +
    <name>
 +
    <id>
 +
    <ram>
 +
    <disk>
 +
    <vcpus>
 
</source>
 
</source>
 
+
|-
'''snapshot'''
+
|
 
 
 
<source lang="bash">
 
<source lang="bash">
cinder snapshot-create
+
os flavor delete
<volume-id>
+
    <flavor>
--force <True|False>
 
--display-name <display-name>
 
--display-description <display-description>
 
 
 
os create snapshot
 
--force
 
--display-name <display-name>
 
--display-description <display-description>
 
<volume-id>
 
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
 
<source lang="bash">
 
<source lang="bash">
cinder snapshot-delete <snapshot-id>
+
nova flavor-delete  
 
+
    <id>
os delete snapshot <snapshot-id>
 
 
</source>
 
</source>
 
+
|-
 
+
|
 
<source lang="bash">
 
<source lang="bash">
cinder snapshot-list
+
os flavor list
--all-tenants [<0|1>]
 
--display-name <display-name>
 
--status <status>
 
--volume-id <volume-id>
 
 
 
os list snapshot
 
--all-tenants [<0|1>]
 
--display-name <display-name>
 
--status <status>
 
--volume-id <volume-id>
 
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
 
<source lang="bash">
 
<source lang="bash">
cinder snapshot-rename
+
nova flavor-list
--display-description <display-description>
 
<snapshot-id>
 
<display-name>
 
 
 
os update snapshot
 
--display-description <display-description>
 
<snapshot-id>
 
<display-name>
 
 
</source>
 
</source>
 
+
|-
 
+
|
 
<source lang="bash">
 
<source lang="bash">
cinder snapshot-show <snapshot-id>
+
os flavor show
 
+
    <flavor>
os show snapshot <snapshot-id>
 
 
</source>
 
</source>
 +
|| yes
 +
|| ||
 +
|}
  
'''type'''
 
  
<source lang="bash">
+
==== floating-ip ====
cinder type-create <type-name>
 
  
os create type <type-name>
+
{| class="wikitable"
 +
|-
 +
! OSC Command !! Implemented !! !! Nova command
 +
|-
 +
|
 +
<source lang="bash">
 +
os ip floating add
 +
    <ip-address>
 +
    <server>
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
 
<source lang="bash">
 
<source lang="bash">
cinder type-delete <type-id>
+
nova add-floating-ip
 
+
    <server>
os delete type <type>
+
    <address>
 
</source>
 
</source>
 
+
|-
 
+
|
 
<source lang="bash">
 
<source lang="bash">
cinder type-list
+
os ip floating create
 
+
    [<pool>]
os list type
 
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
 
<source lang="bash">
 
<source lang="bash">
cinder extra-specs-list
+
nova floating-ip-create
 
+
    [<floating_ip_pool>]
os tbd
 
 
</source>
 
</source>
 
+
|-
 
+
|
 
<source lang="bash">
 
<source lang="bash">
cinder type-key <type-name-or-id> <action (set|unset)> <key=value>
+
os ip floating delete
 
+
    <ip-address>
os tbd
 
 
</source>
 
</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
 +
</source>
 +
|-
 +
|
 +
<source lang="bash">
 +
os ip floating remove
 +
    <ip-address>
 +
    <server>
 +
</source>
 +
|| yes
 +
|| ||
 +
<source lang="bash">
 +
nova remove-floating-ip
 +
    <server>
 +
    <address>
 +
</source>
 +
|}
  
'''volume'''
 
 
<source lang="bash">
 
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 create volume
+
==== floating-ip-pool ====
[--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>
 
</source>
 
  
  
 +
{| class="wikitable"
 +
|-
 +
! OSC Command !! Implemented !! !! Nova command
 +
|-
 +
|
 
<source lang="bash">
 
<source lang="bash">
cinder delete <volume-id>
+
os ip floating pool list
 
+
</source>
os delete volume <volume-id>
+
|| yes
</source>
+
|| ||
 
+
<source lang="bash">
 
+
nova floating-ip-pool-list
<source lang="bash">
+
</source>
cinder list
+
|}
--all-tenants [<0|1>]
+
 
--display-name <display-name>
+
 
--status <status>
+
==== host ====
 
 
os list volume
 
--long
 
</source>
 
 
 
 
 
<source lang="bash">
 
cinder rename
 
--display-description <display-description>
 
<volume-id>
 
<display-name>
 
 
 
os update volume
 
--display-description <display-description>
 
<volume-id>
 
<display-name>
 
</source>
 
 
 
 
 
<source lang="bash">
 
cinder show <volume-id>
 
 
 
os show volume <volume-id>
 
</source>
 
 
 
 
 
<source lang="bash">
 
cinder force-delete <volume-id>
 
 
 
os tbd
 
</source>
 
 
 
 
 
<source lang="bash">
 
cinder metadata
 
<volume-id>
 
<action>
 
<key=value>
 
 
 
os tbd
 
</source>
 
  
 +
{| 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
 +
|| ||
 +
|}
 +
 +
 +
==== hypervisor ====
 +
 +
{| 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
 +
|| ||
 +
|}
 +
 +
 +
==== keypair ====
 +
 +
{| class="wikitable"
 +
|-
 +
! OSC Command !! Implemented !! !! Nova command
 +
|-
 +
|
 +
<source lang="bash">
 +
os keypair create
 +
    [--public-key <file>]
 +
    <name>
 +
</source>
 +
|| yes
 +
|| ||
 +
<source lang="bash">
 +
nova keypair-add
 +
    [--pub_key <pub_key>]
 +
    <name>
 +
</source>
 +
|-
 +
|
 +
<source lang="bash">
 +
os keypair delete
 +
    <name>
 +
</source>
 +
|| yes
 +
|| ||
 +
<source lang="bash">
 +
nova keypair-delete
 +
    <name>
 +
</source>
 +
|-
 +
|
 +
<source lang="bash">
 +
os keypair list
 +
</source>
 +
|| yes
 +
|| ||
 +
<source lang="bash">
 +
nova keypair-list
 +
</source>
 +
|-
 +
|
 +
<source lang="bash">
 +
os keypair show
 +
    [--public-key]
 +
    <name>
 +
</source>
 +
|| yes
 +
|| ||
 +
|}
 +
 +
 +
==== limits ====
 +
 +
See [[#limits|limits]] in the [[#Cross_API|cross API section]].
 +
 +
==== quota ====
 +
 +
See [[#quota|quota]] in the [[#Cross_API|cross API section]].
 +
 +
 +
==== resource ====
 +
 +
{| class="wikitable"
 +
|-
 +
! OSC Command !! Implemented !! !! Nova command
 +
|-
 +
|
 +
<source lang="bash">
 +
os show resource
 +
    <hostname>
 +
</source>
 +
|| no
 +
|| ||
 +
<source lang="bash">
 +
nova describe-resource
 +
    <hostname>
 +
</source>
 +
|}
 +
 +
==== secgroup ====
 +
 +
{| class="wikitable"
 +
|-
 +
! OSC Command !! Implemented !! !! Nova command
 +
|-
 +
|
 +
<source lang="bash">
 +
os secgroup add
 +
 +
(see server add secgroup)
 +
</source>
 +
|| no
 +
|| ||
 +
<source lang="bash">
 +
nova add-secgroup
 +
    <server>
 +
    <secgroup>
 +
</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
 +
    [--all-tenants [<0|1>]]
 +
</source>
 +
|-
 +
|
 +
<source lang="bash">
 +
os secgroup remove
 +
 +
(see server remove secgroup)
 +
</source>
 +
|| no
 +
|| ||
 +
<source lang="bash">
 +
nova remove-secgroup
 +
    <server>
 +
    <secgroup>
 +
</source>
 +
|-
 +
|
 +
<source lang="bash">
 +
os secgroup set
 +
    [--name <new-name>]
 +
    [--description [<new-description>]
 +
    <group>
 +
</source>
 +
|| yes
 +
|| ||
 +
<source lang="bash">
 +
nova secgroup-update
 +
    <secgroup>
 +
    <name>
 +
    <description>
 +
</source>
 +
|-
 +
|
 +
<source lang="bash">
 +
os secgroup show
 +
    <group>
 +
</source>
 +
|| yes
 +
|| ||
 +
<source lang="bash">
 +
n/a
 +
</source>
 +
|}
 +
 +
==== secgroup-group-rule ====
 +
 +
{| 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>
 +
|}
 +
 +
==== secgroup-rule ====
 +
 +
{| class="wikitable"
 +
|-
 +
! 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====
 +
 +
{| 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>
 +
 +
os server migrate
 +
    [--wait]
 +
    <server>
 +
</source>
 +
|| no
 +
|| ||
 +
<source lang="bash">
 +
nova live-migration
 +
    [--block_migrate]
 +
    [--disk_over_commit]
 +
    <server>
 +
<host>
 +
 +
nova migrate
 +
    [--poll]
 +
    <server>
 +
</source>
 +
|-
 +
|
 +
<source lang="bash">
 +
os server pause
 +
    <server>
 +
</source>
 +
|| yes
 +
|| ||
 +
<source lang="bash">
 +
nova pause
 +
    <server>
 +
</source>
 +
|-
 +
|
 +
<source lang="bash">
 +
os server reboot
 +
    [--hard | --soft]
 +
    [--wait]
 +
    <server>
 +
</source>
 +
|| yes
 +
|| ||
 +
<source lang="bash">
 +
nova reboot
 +
    [--hard]
 +
    [--poll]
 +
    <server>
 +
</source>
 +
|-
 +
|
 +
<source lang="bash">
 +
os server rebuild
 +
    --image <image>
 +
    [--password <password>]
 +
    [--wait]
 +
    <server>
 +
</source>
 +
|| yes
 +
|| ||
 +
<source lang="bash">
 +
nova rebuild
 +
    [--rebuild_password <rebuild_password>]
 +
    [--poll]
 +
    <server>
 +
    <image>
 +
</source>
 +
|-
 +
|
 +
<source lang="bash">
 +
os server remove secgroup
 +
    <server>
 +
    <group>
 +
</source>
 +
|| no
 +
|| ||
 +
<source lang="bash">
 +
nova remove-secgroup
 +
    <server>
 +
    <secgroup>
 +
</source>
 +
|-
 +
|
 +
<source lang="bash">
 +
os server rename
 +
    <server>
 +
    <new-name>
 +
</source>
 +
|| no
 +
|| ||
 +
<source lang="bash">
 +
nova rename
 +
    <server>
 +
    <name>
 +
</source>
 +
|-
 +
|
 +
<source lang="bash">
 +
os server rescue
 +
    <server>
 +
</source>
 +
|| no
 +
|| ||
 +
<source lang="bash">
 +
nova rescue
 +
    <server>
 +
</source>
 +
|-
 +
|
 +
<source lang="bash">
 +
os server resize
 +
    --flavor <flavor>
 +
    [--wait]
 +
    <server>
 +
</source>
 +
|| no
 +
|| ||
 +
<source lang="bash">
 +
nova resize
 +
    [--poll]
 +
    <server>
 +
    <flavor>
 +
</source>
 +
|-
 +
|
 +
<source lang="bash">
 +
os server resize
 +
    --confirm
 +
    <server>
 +
</source>
 +
|| no
 +
|| ||
 +
<source lang="bash">
 +
nova resize-confirm
 +
    <server>
 +
</source>
 +
|-
 +
|
 +
<source lang="bash">
 +
os server resume
 +
    <server>
 +
</source>
 +
|| yes
 +
|| ||
 +
<source lang="bash">
 +
nova resume
 +
    <server>
 +
</source>
 +
|-
 +
|
 +
<source lang="bash">
 +
os server set
 +
    --meta-data <key=value>
 +
    [--meta-data <key=value>] ...
 +
    <server>
 +
os unset server
 +
    --meta-data <key>
 +
    [--meta-data <key>] ...
 +
    <server>
 +
</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 ====
 +
 +
{| class="wikitable"
 +
|-
 +
! 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>
 +
|}
 +
 +
 +
==== volume ====
 +
 +
{| class="wikitable"
 +
|-
 +
! 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>
 +
|}
 +
 +
 +
==== x509-cert ====
 +
 +
See [[#credentials|credentials]] in the [[#Cross_API|cross API section]].
 +
 +
==== x509-root-cert ====
 +
 +
See [[#credentials|credentials]] in the [[#Cross_API|cross API section]].
 +
 +
== Image ==
 +
 +
{| class="wikitable"
 +
|-
 +
! 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 ====
 +
 +
{| class="wikitable"
 +
|-
 +
! OSC Command !! Implemented !! !! Glance command
 +
|-
 +
|
 +
<source lang="bash">
 +
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>
 +
</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 ===
 +
 +
==== image ====
 +
 +
{| class="wikitable"
 +
|-
 +
! OSC Command !! Implemented !! !! Glance command
 +
|-
 +
|
 +
<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">
 +
</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>
 +
|}
 +
 +
 +
==== image-member ====
 +
 +
Need to discuss the future of these commands with markwash...
 +
 +
<source lang="bash">
 +
glance member-create [--can-share] <IMAGE_ID> <TENANT_ID>
 +
 +
os create image-member ...
 +
</source>
 +
 +
 +
<source lang="bash">
 +
glance member-delete <IMAGE_ID> <TENANT_ID>
 +
 +
os list image-member <image> [options]
 +
</source>
 +
 +
 +
<source lang="bash">
 +
glance member-delete [options] <ID> <MEMBER>
 +
 +
os delete image-member ...
 +
</source>
 +
 +
 +
<source lang="bash">
 +
glance member-list [--image-id <IMAGE_ID>] [--tenant-id <TENANT_ID>]
 +
 +
os list image-member ...
 +
</source>
 +
 +
== Volume ==
 +
 +
{| class="wikitable"
 +
|-
 +
! 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|limits]] in the [[#Cross_API|cross API section]].
 +
 +
==== quota ====
 +
 +
See [[#quota|quota]] in the [[#Cross_API|cross API section]].
 +
 +
==== snapshot ====
 +
 +
{| class="wikitable"
 +
|-
 +
! OSC Command !! Implemented !! !! Cinder command
 +
|-
 +
|
 +
<source lang="bash">
 +
os snapshot create
 +
    --name <name>
 +
    [--description <description>]
 +
    [--force]
 +
    <volume>
 +
</source>
 +
|| yes
 +
|| ||
 +
<source lang="bash">
 +
cinder snapshot-create
 +
    --force <True|False>
 +
    --display-name <display-name>
 +
    --display-description <display-description>
 +
    <volume-id>
 +
</source>
 +
|-
 +
|
 +
<source lang="bash">
 +
os snapshot delete
 +
    <snapshot>
 +
</source>
 +
|| yes
 +
|| ||
 +
<source lang="bash">
 +
cinder snapshot-delete
 +
    <snapshot-id>
 +
</source>
 +
|-
 +
|
 +
<source lang="bash">
 +
os snapshot list
 +
</source>
 +
|| yes (no opts yet)
 +
|| ||
 +
<source lang="bash">
 +
cinder snapshot-list
 +
    --all-tenants [<0|1>]
 +
    --display-name <display-name>
 +
    --status <status>
 +
    --volume-id <volume-id>
 +
</source>
 +
|-
 +
|
 +
<source lang="bash">
 +
os snapshot set
 +
    [--name <new-name>]
 +
    [--description <new-description>]
 +
    <snapshot>
 +
</source>
 +
|| yes
 +
|| ||
 +
<source lang="bash">
 +
cinder snapshot-rename
 +
    --display-description <display-description>
 +
    --display-name <display-name>
 +
    <snapshot-id>
 +
</source>
 +
|-
 +
|
 +
<source lang="bash">
 +
os snapshot show
 +
    <snapshot>
 +
</source>
 +
|| yes
 +
|| ||
 +
<source lang="bash">
 +
cinder snapshot-show
 +
    <snapshot-id>
 +
</source>
 +
|}
 +
 +
==== volume ====
 +
 +
{| class="wikitable"
 +
|-
 +
! OSC Command !! Implemented !! !! Cinder command
 +
|-
 +
|
 +
<source lang="bash">
 +
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>
 +
</source>
 +
|| yes
 +
|| ||
 +
<source lang="bash">
 +
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>
 +
</source>
 +
|-
 +
|
 +
<source lang="bash">
 +
os volume delete
 +
    [--force]
 +
    <volume>
 +
</source>
 +
|| yes
 +
|| ||
 +
<source lang="bash">
 +
cinder delete
 +
    <volume-id>
 +
 +
cinder force-delete
 +
    <volume-id>
 +
</source>
 +
|-
 +
|
 +
<source lang="bash">
 +
os volume list
 +
    [--name <name>]
 +
    [--status <status>]
 +
    [--long]
 +
    [--all-tenants]          # admin only
 +
</source>
 +
|| yes
 +
|| ||
 +
<source lang="bash">
 +
cinder list
 +
    --all-tenants [<0|1>]
 +
    --display-name <display-name>
 +
    --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>
 +
 +
cinder rename
 +
    --display-description <display-description>
 +
    <volume-id>
 +
    <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>
 +
|}
 +
 +
==== volume-type ====
 +
 +
{| 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
 +
 +
cinder extra-specs-list
 +
</source>
 +
|-
 +
|
 +
<source lang="bash">
 +
os volume type set
 +
    [--property <key=value>]
 +
    <volume-type>
 +
</source>
 +
|| yes
 +
|| ||
 +
<source lang="bash">
 +
cinder type-key
 +
    <type-id>
 +
    <set>
 +
    <key=value>
 +
</source>
 +
|-
 +
|
 +
<source lang="bash">
 +
os volume type unset
 +
    [--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.
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 2,523: Line 3,863:
 
set port <tenant> <network> <port> <params>
 
set port <tenant> <network> <port> <params>
 
</source>
 
</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."