Jump to: navigation, search

Difference between revisions of "UnifiedCLI/Mapping"

(endpoint)
(Redirected page to OpenStackClient/Commands)
 
(154 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 ====
 
 
 
{| class="wikitable"
 
 
|-
 
|-
 
! OSC Command !! Implemented !! !! Keystone command
 
! OSC Command !! Implemented !! !! Keystone command
Line 147: Line 205:
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os show token
+
os credentials create
     [--width <token-display-width>]
+
    --x509
 +
     [<private-key-file>]
 +
    [<certificate-file>]
 
</source>
 
</source>
|| ??
+
|| no
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone token-get [--wrap <integer>]
+
nova x509-create-cert
 +
    [<pk-file>]
 +
    [<x509-cert>]
 
</source>
 
</source>
|}
+
|-
 
+
|
 
 
'''catalog'''
 
 
 
 
<source lang="bash">
 
<source lang="bash">
keystone catalog [--service <service-type>]
+
os credentials show
 
+
    [--token]
os show service [--catalog <service-type>]
+
    [--user]
 +
    [--x509 [--root]]
 
</source>
 
</source>
 
+
|| no
 
+
|| ||
'''ec2-credentials'''
 
 
 
 
<source lang="bash">
 
<source lang="bash">
keystone ec2-credentials-create [--user <user-id>]
+
nova credentials
                      [--tenant_id <tenant-id>]
+
    [--wrap <integer>]
 
 
os create ec2-credentials --tenant_id <tenant-id> [--user <user-id>]
 
  
## are both args really optional?
+
nova x509-get-root-cert
 +
    [<filename>]
 
</source>
 
</source>
 +
|}
  
 +
==== limits ====
  
 +
{| class="wikitable"
 +
|-
 +
! OSC Command !! Implemented !! !! Keystone command
 +
|-
 +
|
 
<source lang="bash">
 
<source lang="bash">
keystone ec2-credentials-delete [--user <user-id>]  
+
os limits show
                      --access <access-key>
+
    --absolute [--reserved] | --rate
 
 
os delete ec2-credentials <access-key>
 
 
 
## what changes if --user is not provided?
 
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone ec2-credentials-get [--user <user-id>]  
+
nova absolute-limits
                            --access <access-key>
+
    [--reserved]
  
os show ec2-credentials <access-key>
+
nova rate-limits
  
## what changes if --user is not provided?
+
cinder absolute-limits
</source>
 
  
 
+
cinder rate-limits
<source lang="bash">
 
keystone ec2-credentials-list [--user <user-id>]
 
 
 
os list ec2-credentials [--user <user-id>]
 
 
</source>
 
</source>
 +
|}
  
==== endpoint ====
+
==== quota ====
  
 
{| class="wikitable"
 
{| class="wikitable"
 
|-
 
|-
 
! OSC Command !! Implemented !! !! Keystone command
 
! OSC Command !! Implemented !! !! Keystone command
|-
+
|-  
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os create endpoint
+
os quota set
     [--region <endpoint-region>
+
    # Compute settings
     [--publicurl <public-url>]
+
    [--cores <num-cores>]
     [--adminurl <admin-url>]
+
    [--fixed-ips <num-fixed-ips>]
     [--internalurl <internal-url>]
+
    [--floating-ips <num-floating-ips>]
     <service>
+
    [--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>
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone endpoint-create
+
nova quota-update
     [--region <endpoint-region>]
+
     [--instances <instances>]
     [--service_id <service-id>]
+
    [--cores <cores>]
     [--publicurl <public-url>]
+
    [--ram <ram>]
     [--adminurl <admin-url>]
+
    [--volumes <volumes>]
     [--internalurl <internal-url>]
+
     [--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>
|-
+
|-  
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os delete endpoint
+
os quota set
     <endpoint-id>
+
     --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>
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone endpoint-delete
+
nova quota-class-update
     <endpoint-id>
+
    [--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>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os list endpoint
+
os quota show
     [--long]
+
     [--default]
 +
    <project>
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone endpoint-list
+
nova quota-show
 +
    [--tenant <tenant-id>]
 +
 
 +
cinder quota-show
 +
    <tenant_id>
 +
 
 +
nova quota-defaults
 +
    <tenant_id>
 +
 
 +
cinder quota-defaults
 +
    <tenant_id>
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os show endpoint
+
os quota show
     [--type <endpoint-type>]
+
     --class
    [--attr <endpoint-attribute>]
+
     <class>
    [--value <endpoint-value>]
 
    [--all]
 
     <service>
 
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone endpoint-get
+
nova quota-class-show
     --service <service-type>
+
     <class>
    [--endpoint_type <endpoint-type>]
+
 
    [--attr <service-attribute>]
+
cinder quota-class-show
     [--value <value>]
+
     <class>
 
</source>
 
</source>
 
|}
 
|}
  
 +
== Identity ==
  
'''role'''
+
{| class="wikitable"
 
+
|-
<source lang="bash">
+
! OSC Option !!  Environment Variable !!  !!  Keystone Option !!  Environment Variable
keystone role-create --name <role-name>
+
|-
 
+
| --os-identity-api-version <ver> || OS_IDENTITY_API_VERSION ||  || --os-identity-api-version <ver> || OS_IDENTITY_API_VERSION
os create role <role-name>
+
|-
</source>
+
| --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> ||
 +
|-
 +
|}
  
<source lang="bash">
+
=== API v2.0 ===
keystone role-delete <role-id>
 
 
 
os delete role <role>
 
</source>
 
  
 +
==== catalog ====
  
 +
{| class="wikitable"
 +
|-
 +
! OSC Command !! Implemented !! !! Keystone command
 +
|-
 +
|
 
<source lang="bash">
 
<source lang="bash">
keystone role-get <role-id>
+
os catalog show
 
+
    [--service <service>]
os show role <role>
 
 
</source>
 
</source>
 
+
|| no
 
+
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone role-list
+
keystone catalog
 
+
    [--service <service-type>]
os list role
 
 
</source>
 
</source>
 +
|}
  
 +
==== ec2 credentials ====
  
'''service'''
+
{| class="wikitable"
 
+
|-
 +
! OSC Command !! Implemented !! !! Keystone command
 +
|-
 +
|
 
<source lang="bash">
 
<source lang="bash">
keystone service-create --name <name>
+
os ec2 credentials create
                        --type <type>
+
    [--project <project>]
                        [--description <service-description>]
+
    [--user <user>]
 
 
os create service
 
        [--type <service-type>]
 
        [--description <service-description>]
 
        <service-name>
 
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone service-delete <service-id>
+
keystone ec2-credentials-create
 
+
    [--user <user-id>]
os delete service <service>
+
    [--tenant_id <tenant-id>]
 
</source>
 
</source>
 
+
|-
 
+
|
 
<source lang="bash">
 
<source lang="bash">
keystone service-get <service-id>
+
os ec2 credentials delete
 
+
    [--user <user>]
os show service <service>
+
    <access-key>
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone service-list
+
keystone ec2-credentials-delete
 
+
    [--user <user-id>]  
os list service [--long]
+
    --access <access-key>
 
</source>
 
</source>
 
+
|-
 
+
|
'''tenant'''
 
 
 
 
<source lang="bash">
 
<source lang="bash">
keystone tenant-create --name <tenant-name>
+
os ec2 credentials list
                      [--description <tenant-description>]
+
    [--user <user>]
                      [--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 ec2-credentials-list
 
+
    [--user <user-id>]
os delete tenant <tenant>
 
 
</source>
 
</source>
 
+
|-
 
+
|
 
<source lang="bash">
 
<source lang="bash">
keystone tenant-get <tenant-id>
+
os ec2 credentials show
 
+
    [--user <user>]
os show tenant <tenant>
+
    <access-key>
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone tenant-list
+
keystone ec2-credentials-get
 
+
    [--user <user-id>]  
os list tenant [--long]
+
    --access <access-key>
 
</source>
 
</source>
 +
|}
  
 +
==== endpoint ====
  
 +
{| class="wikitable"
 +
|-
 +
! OSC Command !! Implemented !! !! Keystone command
 +
|-
 +
|
 
<source lang="bash">
 
<source lang="bash">
keystone tenant-update
+
os endpoint create
        [--name <tenant_name>]
+
    --publicurl <public-url>
        [--description <tenant-description>]
+
    [--adminurl <admin-url>]
        [--enabled <true|false>]
+
    [--internalurl <internal-url>]
        <tenant-id>
+
    [--region <endpoint-region>]
 
+
    <service>
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-create
                    [--tenant_id <tenant-id>]
+
    [--region <endpoint-region>]
                    [--pass <pass>]  
+
    [--service_id <service-id>]
                    [--email <email>]
+
    [--publicurl <public-url>]
                    [--enabled <true|false>]
+
    [--adminurl <admin-url>]
 
+
    [--internalurl <internal-url>]
os create user
 
        [--password <user-password>]
 
        [--email <user-email>]
 
        [--tenant <tenant>]
 
        [--enable | --disable]
 
        <user-name>
 
 
</source>
 
</source>
 
+
|-
 
+
|
 
<source lang="bash">
 
<source lang="bash">
keystone user-delete <user-id>
+
os endpoint delete
 
+
    <endpoint-id>
os delete user <user>
 
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone user-get <user-id>
+
keystone endpoint-delete
 
+
    <endpoint-id>
os show user <user>
 
 
</source>
 
</source>
 
+
|-
 
+
|
 
<source lang="bash">
 
<source lang="bash">
keystone user-list [<tenant-id>]
+
os endpoint list
 
+
    [--long]
os list user [--tenant <tenant>] [--long]
 
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone user-password-update --pass <password> <user-id>
+
keystone endpoint-list
 
 
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 endpoint show
                      --role <role-id>
+
    [--type <endpoint-type>]
                      [--tenant_id <tenant-id>]
+
    [--attr <endpoint-attribute>]
 
+
    [--value <endpoint-value>]
os add role-user
+
    [--all]
        [--tenant <tenant>]
+
    <service-type>
        <role> <user>
 
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone user-role-list [--user <user-id>]
+
keystone endpoint-get
                  [--tenant_id <tenant-id>]
+
    --service <service-type>
 
+
    [--endpoint_type <endpoint-type>]
os list role-user
+
    [--attr <service-attribute>]  
        [--tenant <tenant>]
+
    [--value <value>]
        [<user>]
 
 
</source>
 
</source>
 +
|}
  
 +
==== role ====
  
 +
{| class="wikitable"
 +
|-
 +
! OSC Command !! Implemented !! !! Keystone command
 +
|-
 +
|
 
<source lang="bash">
 
<source lang="bash">
keystone user-role-remove --user <user-id>
+
os role create
                          --role <role-id>
+
    <role-name>
                          [--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-create --name
        --pass <password>
+
    <role-name>
        [--user-name <user-name>]
 
        [--role-name <role-name>]
 
        [--tenant-name <tenant-name>]
 
 
 
##TBD
 
 
</source>
 
</source>
 
+
|-
 
+
|
 
 
 
<source lang="bash">
 
<source lang="bash">
keystone discover
+
os role delete
 
+
    <role>
##TBD
 
 
</source>
 
</source>
 
+
|| yes
=== API v3 ===
+
|| ||
 
 
'''credential'''
 
 
 
 
<source lang="bash">
 
<source lang="bash">
keystone credential-create --user_id <user-id>
+
keystone role-delete
                      --type <credential-type>
+
    <role-id>
                      --data <credential-data>
 
                      [--project_id <project-id>]
 
 
 
os create credential
 
        [--project <project>]
 
        <user>
 
        <type>
 
        <data>
 
 
</source>
 
</source>
 
+
|-
 
+
|
 
<source lang="bash">
 
<source lang="bash">
keystone credential-delete <credential-id>
+
os role list
 
 
os delete credential <credential-id>
 
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone credential-get <credential-id>
+
keystone role-list
 
 
os show credential <credential-id>
 
 
</source>
 
</source>
 
+
|-
 
+
|
 
<source lang="bash">
 
<source lang="bash">
keystone credential-list
+
os role show
 
+
    <role>
os list credential [--long]
 
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone credential-update
+
keystone role-get
        [--user <user>]
+
    <role-id>
        [--type <type>]
 
        [--data <data>]
 
        [--project <project>]
 
        <credential-id>
 
 
 
os set credential
 
        [--user <user>]
 
        [--type <type>]
 
        [--data <data>]
 
        [--project <project>]
 
        <credential-id>
 
 
</source>
 
</source>
 +
|}
  
 +
==== service ====
  
'''domain'''
+
{| class="wikitable"
 
+
|-
 +
! OSC Command !! Implemented !! !! Keystone command
 +
|-
 +
|
 
<source lang="bash">
 
<source lang="bash">
keystone domain-create --name <domain-name>
+
os service create
                      [--description <domain-description>]
+
    [--type <service-type>]
                      [--enabled <true|false>]
+
    [--description <service-description>]
                      [--private_project_names <true|false>]
+
    <service-name>
                      [--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-create
 
+
    --name <name>
os delete domain <domain>
+
    --type <type>
 +
    [--description <service-description>]
 
</source>
 
</source>
 
+
|-
 
+
|
 
<source lang="bash">
 
<source lang="bash">
keystone domain-get <domain-id>
+
os service delete
 
+
    <service>
os show domain <domain>
 
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone domain-list
+
keystone service-delete
 
+
    <service-id>
os list domain [--long]
 
 
</source>
 
</source>
 
+
|-
 
+
|
 
<source lang="bash">
 
<source lang="bash">
keystone domain-update
+
os service list
        [--name <domain_name>]
+
    [--long]
        [--description <domain-description>]
 
        [--enabled <true|false>]
 
        [--private_project_names <true|false>]
 
        [--private_user_names <true|false>]
 
        <domain-id>
 
 
 
os set domain
 
        [--name <new-domain-name>]
 
        [--description <new-domain-description>]
 
        [--private_project_names]
 
        [--private_user_names]
 
        [--enable | --disable]
 
        <domain>
 
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
'''endpoint'''
 
 
 
 
<source lang="bash">
 
<source lang="bash">
keystone endpoint-create --service_id <service-id>
+
keystone service-list
--interface <endpoint-interface>
 
--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>
 
+
|-
 
+
|
 
<source lang="bash">
 
<source lang="bash">
keystone endpoint-delete <endpoint-id>
+
os service show
 
+
    [--catalog]
os delete endpoint <endpoint-id>
+
    <service>
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone endpoint-list
+
keystone service-get
 
+
    <service-id>
os list endpoint [--long]
 
 
</source>
 
</source>
 +
|}
  
 +
==== tenant ====
  
 +
{| class="wikitable"
 +
|-
 +
! OSC Command !! Implemented !! !! Keystone command
 +
|-
 +
|
 
<source lang="bash">
 
<source lang="bash">
keystone enpoint-get <endpoint-id>
+
os tenant create
 
+
    [--description <description>]
os show endpoint <endpoint-id>
+
    [--enable | --disable]
 +
    <tenant-name>
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone endpoint-update --endpoint_id <endpoint-id>
+
keystone tenant-create
[--region <endpoint-region>]
+
    --name <tenant-name>
        [--enabled <true|false>]
+
    [--description <tenant-description>]
[<service-id>]
+
    [--enabled <true|false>]
[<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>
 
+
|-
 
+
|
'''group'''
 
 
 
 
<source lang="bash">
 
<source lang="bash">
keystone group-create --name <group-name>
+
os tenant delete
                      [--domain_id <domain-id>]
+
    <tenant>
                      [--description <group-description>]
 
 
 
os create group
 
        [--domain <domain>]
 
        [--description <group-description>]
 
        <group-name>
 
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone group-delete <group-id>
+
keystone tenant-delete
 
+
    <tenant>
os delete group <group>
 
 
</source>
 
</source>
 
+
|-
 
+
|
 
<source lang="bash">
 
<source lang="bash">
keystone group-get <group-id>
+
os tenant list
 
+
    [--long]
os show group <group>
 
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone group-list
+
keystone tenant-list
 
 
os list group [--long]
 
 
</source>
 
</source>
 
+
|-
 
+
|
 
<source lang="bash">
 
<source lang="bash">
keystone group-update
+
os tenant set
        [--name <group_name>]
+
    [--name <new-tenant-name>]
        [--domain_id <domain-id>]
+
    [--description <new-tenant-description>]
        [--description <group-description>]
+
    [--enable | --disable]
        <group-id>
+
    <tenant>
 
 
os set group
 
        [--name <new-group-name>]
 
        [--domain <domain>]
 
        [--description <new-group-description>]
 
        <group>
 
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
'''policy'''
 
 
 
 
<source lang="bash">
 
<source lang="bash">
keystone policy-create --type <policy-type>
+
keystone tenant-update
                      --blob <policy-blob>
+
    [--name <tenant_name>]
 
+
    [--description <tenant-description>]
os create policy
+
    [--enabled <true|false>]
        --type <policy-type>
+
    <tenant-id>
        --blob <policy-blob>
 
 
</source>
 
</source>
 
+
|-
 
+
|
 
<source lang="bash">
 
<source lang="bash">
keystone policy-delete <policy-id>
+
os tenant show
 
+
    <tenant>
os delete policy <policy-id>
 
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone policy-get <policy-id>
+
keystone tenant-get
 
+
    <tenant-id>
os show policy <policy-id>
 
 
</source>
 
</source>
 +
|}
  
 +
==== token ====
  
 +
{| class="wikitable"
 +
|-
 +
! OSC Command !! Implemented !! !! Keystone command
 +
|-
 +
|
 
<source lang="bash">
 
<source lang="bash">
keystone policy-list
+
os token show
 
+
    [--width <token-display-width>]
os list policy [--long]
 
 
</source>
 
</source>
 
+
|| ??
 
+
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone policy-update
+
keystone token-get [--wrap <integer>]
        [--type <policy-type>]
 
        [--blob <policy-blob>]
 
        <policy-id>
 
 
 
os set policy
 
        [--type <policy-type>]
 
        [--blob <policy-blob>]
 
        <policy-id>
 
 
</source>
 
</source>
 +
|}
  
 +
==== user ====
  
'''project'''
+
{| class="wikitable"
 
+
|-
 +
! OSC Command !! Implemented !! !! Keystone command
 +
|-
 +
|
 
<source lang="bash">
 
<source lang="bash">
keystone project-create --name <project-name>
+
os user create
                      [--domain_id <project-domain-id>]
+
    [--password <user-password>]
                      [--description <project-description>]
+
    [--email <user-email>]
                      [--enabled <true|false>]
+
    [--tenant <tenant>]
 
+
    [--enable | --disable]
os create project
+
    <user-name>
        [--domain <project-domain>]
 
        [--description <project-description>]
 
        [--enable | --disable]
 
        <project-name>
 
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone project-delete <project-id>
+
keystone user-create
 
+
    --name <user-name>
os delete project <project>
+
    [--tenant_id <tenant-id>]
 +
    [--pass <pass>]
 +
    [--email <email>]
 +
    [--enabled <true|false>]
 
</source>
 
</source>
 
+
|-
 
+
|
 
<source lang="bash">
 
<source lang="bash">
keystone project-get <project-id>
+
os user delete
 
+
    <user>
os show project <project>
 
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone project-list
+
keystone user-delete
 
+
    <user-id>
os list project [--long]
 
 
</source>
 
</source>
 
+
|-
 
+
|
 
<source lang="bash">
 
<source lang="bash">
keystone project-update
+
os user list
        [--name <project_name>]
+
    [--tenant <tenant>]
        [--domain_id <project-domain-id>]
+
    [--long]
        [--description <project-description>]
 
        [--enabled <true|false>]
 
        <project-id>
 
 
 
os set project
 
        [--name <new-project-name>]
 
        [--domain <project-domain>]
 
        [--description <new-project-description>]
 
        [--enable | --disable]
 
        <project>
 
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
'''role'''
 
 
 
 
<source lang="bash">
 
<source lang="bash">
keystone role-create --name <role-name>
+
keystone user-list
 
+
    [<tenant-id>]
os create role <role-name>
 
 
</source>
 
</source>
 
+
|-
 
+
|
 
<source lang="bash">
 
<source lang="bash">
keystone role-delete <role-id>
+
os user set
 
+
    [--name <new-user-name>]
os delete role <role>
+
    [--password <user-password>]
 +
    [--email <user-email>]
 +
    [--tenant <tenant>]
 +
    [--enable|--disable]
 +
    <user>
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone role-get <role-id>
+
keystone user-password-update
 
+
    --pass <password>
os show role <role>
+
    <user-id>
 
</source>
 
</source>
 
+
|-
 
+
|
 
<source lang="bash">
 
<source lang="bash">
keystone role-list
+
os user show
 
+
    <user>
os list role
 
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone role-update <role-id>
+
keystone user-get
 
+
    <user-id>
os update role <role>
 
 
</source>
 
</source>
 +
|}
  
 +
==== user role ====
  
'''service'''
+
{| class="wikitable"
 
+
|-
 +
! OSC Command !! Implemented !! !! Keystone command
 +
|-
 +
|
 
<source lang="bash">
 
<source lang="bash">
keystone service-create --type <type>
+
os user role add
[--name <name>]
+
    [--tenant <tenant>]
                        [--enabled <true|false>]
+
    <user>
 
+
    <role>
os create service
 
[--name <name>]
 
        [--enabled <true|false>]
 
        <type>
 
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone service-delete <service-id>
+
keystone user-role-add
 
+
    --user <user-id>
os delete service <service>
+
    --role <role-id>
 +
    [--tenant_id <tenant-id>]
 
</source>
 
</source>
 
+
|-
 
+
|
 
<source lang="bash">
 
<source lang="bash">
keystone service-get <service-id>
+
os user role list
 
+
    [--tenant <tenant>]
os show service <service>
+
    [<user>]
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone service-list
+
keystone user-role-list
 
+
    [--user <user-id>]
os list service [--long]
+
    [--tenant_id <tenant-id>]
 
</source>
 
</source>
 
+
|-
 
+
|
 
<source lang="bash">
 
<source lang="bash">
keystone service-update --service_id <service-id>
+
os user role remove
[--type <type>]
+
    [--tenant <tenant>]
[--name <name>]
+
    <user>
                        [--enabled <true|false>]
+
    <role>
 
+
</source>
os update service
+
|| yes
[--type <type>]
+
|| ||
[--name <name>]
+
<source lang="bash">
        [--enabled <true|false>]
+
keystone user-role-remove
        <service>
+
    --user <user-id>
 +
    --role <role-id>
 +
    [--tenant_id <tenant-id>]
 
</source>
 
</source>
 +
|}
  
 +
==== <other> ====
  
'''user'''
+
These keystone commands are not planned for re-implementation in OpenStackClient
  
 
<source lang="bash">
 
<source lang="bash">
keystone user-create --name <user-name>
+
keystone bootstrap
                    [--domain_id <domain-id>]
+
        --pass <password>
                    [--default_project_id <project-id>]
+
        [--user-name <user-name>]
                    [--description <description>]
+
         [--role-name <role-name>]
                    [--enabled <true|false>]
+
         [--tenant-name <tenant-name>]
                    [--password <password>]  
 
 
 
os create user
 
         [--domain_id <domain-id>]
 
        [--default_project_id <project-id>]
 
        [--description <description>]
 
         [--enabled <true|false>]
 
        [--password <password>]
 
        <user-name>
 
 
</source>
 
</source>
 
  
 
<source lang="bash">
 
<source lang="bash">
keystone user-delete <user-id>
+
keystone discover
 +
</source>
  
os delete user <user>
+
=== API v3 ===
</source>
 
  
 +
==== credential ====
  
 +
{| class="wikitable"
 +
|-
 +
! OSC Command !! Implemented !! !! Keystone command
 +
|-
 +
|
 
<source lang="bash">
 
<source lang="bash">
keystone user-get <user-id>
+
os credential create
 
+
    [--project <project>]
os show user <user>
+
    [--type ec2|cert]
 +
    <user>
 +
    <data>
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone user-list
+
keystone credential-create
 
+
    --user_id <user-id>
os list user [--long]
+
    --type <credential-type>
 +
    --data <credential-data>
 +
    [--project_id <project-id>]
 
</source>
 
</source>
 
+
|-
 
+
|
 +
<source lang="bash">
 +
os credential delete
 +
    <credential-id>
 +
</source>
 +
|| yes
 +
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone user-update --user_id <user-id>
+
keystone credential-delete
    [--name <user-name>]
+
    <credential-id>
                    [--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>
 
</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 ====
 
 
{| class="wikitable"
 
 
|-
 
|-
! OSC Command !! Implemented !! !! Nova command
+
|
|-
 
|
 
 
<source lang="bash">
 
<source lang="bash">
os create agent
+
os credential list
    <os>
 
    <architecture>
 
    <version>
 
    <url>
 
    <md5hash>
 
    <hypervisor>
 
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 +
<source lang="bash">
 +
keystone credential-list
 +
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os delete agent
+
os credential set
     <id>
+
     [--user <user>]
 +
    [--type ec2|cert]
 +
    [--data <data>]
 +
    [--project <project>]
 +
    <credential-id>
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 +
<source lang="bash">
 +
keystone credential-update
 +
    [--user <user>]
 +
    [--type <type>]
 +
    [--data <data>]
 +
    [--project <project>]
 +
    <credential-id>
 +
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os list agent
+
os credential show
     [--hypervisor <hypervisor>]
+
     <credential-id>
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
|-
 
|
 
 
<source lang="bash">
 
<source lang="bash">
os set agent
+
keystone credential-get
     <id>
+
     <credential-id>
    <version>
 
    <url>
 
    <md5hash>
 
 
</source>
 
</source>
|| yes
 
|| ||
 
 
|}
 
|}
  
 +
==== domain ====
  
'''aggregate'''
+
{| class="wikitable"
 
+
|-
 +
! OSC Command !! Implemented !! !! Keystone command
 +
|-
 +
|
 
<source lang="bash">
 
<source lang="bash">
nova aggregate-create <name> <availability_zone>
+
os domain create
 
+
    [--description <domain-description>]
os create aggregate ...
+
    [--enable | --disable]
 +
    <domain-name>
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova aggregate-delete <id>
+
keystone domain-create
 
+
    --name <domain-name>
os delete aggregate ...
+
    [--description <domain-description>]
 +
    [--enabled <true|false>]
 +
    [--private_project_names <true|false>]
 +
    [--private_user_names <true|false>]
 
</source>
 
</source>
 
+
|-
 
+
|
 
<source lang="bash">
 
<source lang="bash">
nova aggregate-details <id>
+
os domain delete
 
+
    <domain>
os show aggregate ...
 
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova aggregate-list
+
keystone domain-delete
 
+
    <domain-id>
os list aggregate
 
 
</source>
 
</source>
 
+
|-
 
+
|
 
<source lang="bash">
 
<source lang="bash">
nova aggregate-update <id> <name> [<availability_zone>]
+
os domain list
 
 
os set aggregate ...
 
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova aggregate-set-metadata <id> <key=value> [<key=value> ...]
+
keystone domain-list
 
 
os set aggregate --metadata ...
 
 
</source>
 
</source>
 
+
|-
 
+
|
'''aggregate-host'''
 
 
 
 
<source lang="bash">
 
<source lang="bash">
nova aggregate-add-host <id> <host>
+
os domain set
 
+
    [--name <new-domain-name>]
os add aggregate-host ...
+
    [--description <new-domain-description>]
 +
    [--enable | --disable]
 +
    <domain>
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova aggregate-remove-host <id> <host>
+
keystone domain-update
 
+
    [--name <domain_name>]
os remove aggregate-host ...
+
    [--description <domain-description>]
 +
    [--enabled <true|false>]
 +
    [--private_project_names <true|false>]
 +
    [--private_user_names <true|false>]
 +
    <domain-id>
 
</source>
 
</source>
 
+
|-
 
+
|
'''bash-completion'''
 
 
 
 
<source lang="bash">
 
<source lang="bash">
nova bash-completion
+
os domain show
 
+
    <domain>
os show bash-completion
 
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
'''cloudpipe'''
 
 
 
 
<source lang="bash">
 
<source lang="bash">
nova cloudpipe-create <project>
+
keystone domain-get
 
+
    <domain-id>
os create cloudpipe ...
 
 
</source>
 
</source>
 +
|}
  
 +
==== endpoint ====
  
 +
{| class="wikitable"
 +
|-
 +
! OSC Command !! Implemented !! !! Keystone command
 +
|-
 +
|
 
<source lang="bash">
 
<source lang="bash">
nova cloudpipe-list
+
os endpoint create
 
+
    [--region <endpoint-region>
os list cloudpipe
+
    [--enable | --disable]
 +
    <service>
 +
    <interface admin|public|internal>
 +
    <url>
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
'''console'''
 
 
 
 
<source lang="bash">
 
<source lang="bash">
nova console-log [--length <length>] <server>
+
keystone endpoint-create
 
+
    [--region <endpoint-region>
os show console ...
+
    [--enable | --disable]
 +
    <service_id>
 +
    <interface admin|public|internal>
 +
    <url>
 
</source>
 
</source>
 
+
|-
 
+
|
 
<source lang="bash">
 
<source lang="bash">
nova get-vnc-console <server> <console_type>
+
os endpoint delete
 
+
    <endpoint-id>
os show console [--vnc] ...
 
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
'''credentials'''
 
 
 
 
<source lang="bash">
 
<source lang="bash">
nova credentials
 
 
os show credentials
 
 
</source>
 
</source>
 
+
|-
 
+
|
'''diagnostics'''
 
 
 
 
<source lang="bash">
 
<source lang="bash">
nova diagnostics <server>
+
os endpoint list
 
+
    [--long]
os show diagnostics ...
 
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
'''dns'''
 
 
 
 
<source lang="bash">
 
<source lang="bash">
nova dns-create [--type <type>] <ip> <name> <domain>
+
keystone endpoint-list
 
 
os create dns ...
 
 
</source>
 
</source>
 
+
|-
 
+
|
 
<source lang="bash">
 
<source lang="bash">
nova dns-delete <domain> <name>
+
os endpoint set
 
+
    [--interface <endpoint-interface>]
os delete dns ...
+
    [--url <endpoint-url>]
 +
    [--service <service-id>]
 +
    [--region <endpoint-region>]
 +
    [--enable | --disable]
 +
    <endpoint>
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova dns-list [--ip <ip>] [--name <name>] <domain>
+
keystone endpoint-set
 
+
    [--interface <endpoint-interface>]
os list dns ...
+
    [--url <endpoint-url>]
 +
    [--service <service-id>]
 +
    [--region <endpoint-region>]
 +
    [--enable | --disable]
 +
    <endpoint>
 
</source>
 
</source>
 
+
|-
 
+
|
'''dns-domain'''
 
 
 
 
<source lang="bash">
 
<source lang="bash">
nova dns-create-private-domain [--availability_zone <availability_zone>]
+
os endpoint show
                              <domain>
+
    <endpoint>
 
 
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 endpoint-get
 
+
    <endpoint>
os create dns-domain [--public] ...
 
 
</source>
 
</source>
 +
|}
  
 +
==== group ====
  
<source lang="bash">
+
{| class="wikitable"
nova dns-delete-domain <domain>
+
|-
 
+
! OSC Command !! Implemented !! !! Keystone command
os delete dns-domain ...
+
|-
 +
|
 +
<source lang="bash">
 +
os group create
 +
    [--domain <domain>]
 +
    [--description <group-description>]
 +
    <group-name>
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova dns-domains
+
keystone group-create
 
+
    --name <group-name>
os list dns-domains
+
    [--domain_id <domain-id>]
 +
    [--description <group-description>]
 
</source>
 
</source>
 
+
|-
 
+
|
'''endpoints'''
 
 
 
 
<source lang="bash">
 
<source lang="bash">
nova endpoints
+
os group delete
 
+
    <group>
os list endpoints
 
 
 
# does this overlap with keystone?
 
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
'''fixed-ip'''
 
 
 
 
<source lang="bash">
 
<source lang="bash">
nova add-fixed-ip <server> <network_id>
+
keystone group-delete
 
+
    <group-id>
os add fixed-ip ...
 
 
</source>
 
</source>
 
+
|-
 
+
|
 
<source lang="bash">
 
<source lang="bash">
nova remove-fixed-ip <server> <address>
+
os group list
 
+
    [--long]
os remove fixed-ip ...
 
 
</source>
 
</source>
 +
|| yes
 +
|| ||
 +
<source lang="bash">
 +
keystone group-list
 +
</source>
 +
|-
 +
|
 +
<source lang="bash">
 +
os group set
 +
    [--name <new-group-name>]
 +
    [--domain <domain>]
 +
    [--description <new-group-description>]
 +
    <group>
 +
</source>
 +
|| yes
 +
|| ||
 +
<source lang="bash">
 +
keystone group-update
 +
    [--name <group_name>]
 +
    [--domain_id <domain-id>]
 +
    [--description <group-description>]
 +
    <group-id>
 +
</source>
 +
|-
 +
|
 +
<source lang="bash">
 +
os group show
 +
    <group>
 +
</source>
 +
|| yes
 +
|| ||
 +
<source lang="bash">
 +
keystone group-get
 +
    <group-id>
 +
</source>
 +
|}
  
 
+
==== oauth ====
==== 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 access token create
     [--id <id>]
+
     --consumer-key <consumer-key>
    [--ram <size-mb>]
+
     --consumer-secret <consumer-secret>
     [--disk <size-gb>]
+
     --request-key <request-key>
     [--ephemeral-disk <size-gb>]
+
     --request-secret <request-secret>
     [--swap <size-mb>]
+
     --verifier <pin>
     [--vcpus <num-cpu>]
+
</source>
    [--rxtx-factor <factor>]
+
|| yes
    [--public | --private]
+
|| ||
    <name>
+
<source lang="bash">
 +
n/a
 
</source>
 
</source>
||
+
|-
 +
| look at some alternatives: || || ||
 +
|-
 +
|
 
<source lang="bash">
 
<source lang="bash">
(partial)
+
os oauth token create
default: auto
+
    --consumer-key <consumer-key>
default: 256M
+
    --consumer-secret <consumer-secret>
default: 0G
+
    --request-key <request-key>
default: 0G
+
    --request-secret <request-secret>
default: 0G
+
    --verifier <pin>
default: 1
 
default: 1
 
default: public
 
 
 
 
</source>
 
</source>
 +
|| nyet
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova flavor-create
+
* makes the token specific to oauth
    [--ephemeral <ephemeral>]
+
* add [--oauth-ver X] if versioning for oauth2 is an issue?
    [--swap <swap>]
 
    [--rxtx-factor <factor>]
 
    <name>
 
    <id>
 
    <ram>
 
    <disk>
 
    <vcpus>
 
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os delete flavor
+
os oauth token create
     <flavor>
+
     --access
 +
    --consumer-key <consumer-key>
 +
    --consumer-secret <consumer-secret>
 +
    --request-key <request-key>
 +
    --request-secret <request-secret>
 +
    --verifier <pin>
 +
 
 +
os oauth token create
 +
    --request
 +
    --consumer-key <consumer-key>
 +
    --roles <roles>
 
</source>
 
</source>
|| yes
+
|| nyet
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova flavor-delete
+
* collapse 'access token' and 'request token' into 'oauth token'?
    <id>
 
 
</source>
 
</source>
 +
|}
 +
 +
==== policy ====
 +
 +
{| class="wikitable"
 +
|-
 +
! OSC Command !! Implemented !! !! Keystone command
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os list flavor
+
os policy create
 +
    [--type <policy-type>]
 +
    --blob-file <blob-file>
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova flavor-list
+
keystone policy-create
 +
    --type <policy-type>
 +
    --blob <policy-blob>
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os show flavor
+
os policy delete
     <flavor>
+
     <policy-id>
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
|}
 
 
 
'''floating-ip'''
 
 
 
<source lang="bash">
 
<source lang="bash">
nova add-floating-ip <server> <address>
+
keystone policy-delete
 
+
    <policy-id>
os add floating-ip ...
 
 
</source>
 
</source>
 
+
|-
 
+
|
 
<source lang="bash">
 
<source lang="bash">
nova floating-ip-create [<floating_ip_pool>]
+
os policy list
 
+
    [--include-blob]
os create floating-ip ...
 
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova floating-ip-delete <address>
+
keystone policy-list
 
 
os delete floating-ip
 
 
</source>
 
</source>
 
+
|-
 
+
|
 
<source lang="bash">
 
<source lang="bash">
nova floating-ip-list
+
os policy set
 
+
    [--type <policy-type>]
os list floating-ip
+
    [--blob-file<blob-file>]
 +
    <policy-id>
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova remove-floating-ip <server> <address>
+
keystone policy-update
 
+
    [--type <policy-type>]
os remove floating-ip ...
+
    [--blob <policy-blob>]
 +
    <policy-id>
 
</source>
 
</source>
 
+
|-
 
+
|
'''floating-ip-pool'''
 
 
 
 
<source lang="bash">
 
<source lang="bash">
nova floating-ip-pool-list
+
os policy show
 
+
    <policy-id>
os list floating-ip-pool
 
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
'''host'''
 
 
 
 
<source lang="bash">
 
<source lang="bash">
nova host-action [--action <action>] <hostname>
+
keystone policy-get
 
+
    <policy-id>
os ?? host ...
 
 
</source>
 
</source>
 +
|}
  
 +
==== project ====
  
 +
{| class="wikitable"
 +
|-
 +
! OSC Command !! Implemented !! !! Keystone command
 +
|-
 +
|
 
<source lang="bash">
 
<source lang="bash">
nova host-update [--status <status>]  
+
os project create
                [--maintenance <maintenance_mode>]
+
    [--domain <project-domain>]
                <hostname>
+
    [--description <project-description>]
 
+
    [--enable | --disable]
os set host ...
+
    <project-name>
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
'''image'''
 
 
 
 
<source lang="bash">
 
<source lang="bash">
nova image-create [--poll] <server> <name>
+
keystone project-create
 
+
    [--domain_id <domain_id>]
os create image ...
+
    [--description <description>]
 +
    [--enable | --disable]
 +
    <name>
 
</source>
 
</source>
 
+
|-
 
+
|
 
<source lang="bash">
 
<source lang="bash">
nova image-delete <image>
+
os project delete
 
+
    <project>
os delete image ...
 
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova image-list
+
os project-delete
 
+
    <project_id>
os list image
 
 
</source>
 
</source>
 
+
|-
 
+
|
 
<source lang="bash">
 
<source lang="bash">
nova image-meta <image> <action> <key=value> [<key=value> ...]
+
os project list
 
+
    [--long]
os set image ...
 
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova image-show <image>
+
keystone project-list
 
 
os show image ...
 
 
</source>
 
</source>
 
+
|-
 
+
|
'''keypair'''
 
 
 
 
<source lang="bash">
 
<source lang="bash">
nova keypair-add [--pub_key <pub_key>] <name>
+
os project set
 
+
    [--name <new-project-name>]
os create keypair ...
+
    [--domain <project-domain>]
 +
    [--description <new-project-description>]
 +
    [--enable | --disable]
 +
    <project>
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova keypair-delete <name>
+
keystone project-set
 
+
    [--name <new-project-name>]
os delete keypair
+
    [--domain <project-domain>]
 +
    [--description <new-project-description>]
 +
    [--enable | --disable]
 +
    <project_id>
 
</source>
 
</source>
 
+
|-
 
+
|
 
<source lang="bash">
 
<source lang="bash">
nova keypair-list
+
os project show
 
+
    <project>
os list keypair
 
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
'''limits'''
 
 
 
 
<source lang="bash">
 
<source lang="bash">
nova absolute-limits
+
keystone project-get
 
+
    <project_id>
os show limits --absolute
 
## is there any other kind?
 
 
</source>
 
</source>
 +
|}
  
 +
==== role ====
  
'''quota'''
+
{| class="wikitable"
 
+
|-
 +
! OSC Command !! Implemented !! !! Keystone command
 +
|-
 +
|
 
<source lang="bash">
 
<source lang="bash">
nova quota-defaults <tenant_id>
+
os role add
nova quota-show <tenant_id>
+
    [--user <user> | --group <group>]
 
+
    [--domain <domain> | --project <project>]
os show quota <tenant> [--defaults]
+
    <role>
 
</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 create
 
+
    <role-name>
os show quota-class ...
 
 
</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 delete
 
+
    <role>
os show rate-limits
 
 
</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 list
 
 
os create secgroup ...
 
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova secgroup-delete <secgroup>
 
 
os delete secgroup ...
 
 
</source>
 
</source>
 
+
|-
 
+
|
 
<source lang="bash">
 
<source lang="bash">
nova secgroup-list
+
os role remove
 
+
    [--user <user> | --group <group>]
os list secgroup
+
    [--domain <domain> | --project <project>]
 +
    <role>
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
'''secgroup-group-rule'''
 
 
 
 
<source lang="bash">
 
<source lang="bash">
nova secgroup-add-group-rule [--ip_proto <ip_proto>]
 
                            [--from_port <from_port>]
 
                            [--to_port <to_port>]
 
                            <secgroup> <source_group>
 
 
os create secgroup-group-rule
 
 
</source>
 
</source>
 
+
|-
 
+
|
 
<source lang="bash">
 
<source lang="bash">
nova secgroup-delete-group-rule [--ip_proto <ip_proto>]
+
os role set
                                [--from_port <from_port>]
+
    [--name <new-role-name>]
                                [--to_port <to_port>]
+
    <role>
                                <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>
 
 
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 role show
 
+
    <role>
os delete secgroup-rule
 
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova secgroup-list-rules <secgroup>
 
 
os list secgroup-rule ...
 
 
</source>
 
</source>
 +
|}
  
 
+
==== service ====
====server====
 
  
 
{| class="wikitable"
 
{| class="wikitable"
 
|-
 
|-
! OSC Command !! Implemented !! !! Nova command
+
! OSC Command !! Implemented !! !! Keystone command
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os create server
+
os service create
    --image <image>
+
[--name <name>]
    --flavor <flavor>
+
        [--enabled <true|false>]
    [--security-group <security-group-list> [...] ]
+
        <type>
    [--key-name <key-name>]
 
    [--meta-data <key=value> [--meta-data <key=value] [...] ]
 
    [--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-create
    [--flavor <flavor>]
+
[--name <name>]
    [--image <image>]
+
        [--enabled <true|false>]
    [--meta <key=value>]
+
        <type>
    [--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>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os delete server
+
os service delete
     <server>
+
     <service>
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova delete
+
keystone service-delete
     <server>
+
     <service_id>
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os list server
+
os list service
    [--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>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova list
+
keystone service-list
    [--reservation_id <reservation_id>]
+
</source>
    [--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">
 
<source lang="bash">
os lock server
+
os service set
     <server>
+
     [--type <service-type>]
 +
    [--name <new-name>]
 +
    [--enable | --disable]
 +
    <service>
 
</source>
 
</source>
|| no
+
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova lock
+
keystone service-set
     <server>
+
     [--type <service-type>]
 +
    [--name <new-name>]
 +
    [--enable | --disable]
 +
    <service>
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os migrate server
+
os service show
    --live
+
     <service>
    [--block_migrate]
 
    [--disk_over_commit]
 
    <server>
 
    <host>
 
 
 
os migrate server
 
    [--wait]
 
     <server>
 
 
</source>
 
</source>
|| no
+
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova live-migration
+
keystone service-get
    [--block_migrate]
+
     <service_id>
    [--disk_over_commit]
+
</source>
     <server>
+
|}
<host>
+
 
 +
==== user ====
  
nova migrate
+
{| class="wikitable"
    [--poll]
+
|-
    <server>
+
! OSC Command !! Implemented !! !! Keystone command
</source>
 
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os pause server
+
os user create
     <server>
+
     [--password <password>]
 +
    [--project <project>]
 +
    [--email <user-email>]
 +
    [--enable | --disable]
 +
    <name>
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova pause
+
keystone user-create
     <server>
+
     --name <user-name>  
 +
    [--domain_id <domain-id>]
 +
    [--default_project_id <project-id>]
 +
    [--description <description>]
 +
    [--enabled <true|false>]
 +
    [--password <password>]
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os reboot server
+
os user delete
    [--hard | --soft]
+
     <user>
    [--wait]
 
     <server>
 
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova reboot
+
keystone user-delete
    [--hard]
+
     <user-id>
     [--poll]
 
    <server>
 
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os rebuild server
+
os user list
    --image <image>
+
     [--project <project>]
     [--rebuild-password <rebuild-password>]  
+
     [--long]
     [--wait]
 
    <server>
 
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova rebuild
+
keystone user-list
    [--rebuild_password <rebuild_password>]
 
    [--poll]
 
    <server>
 
    <image>
 
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os rename server
+
os user set
     <server>
+
     [--name <new-name>]
     <new-name>
+
    [--password <password>]
 +
    [--project <project>]
 +
     [--email <user-email>]
 +
    [--enable | --disable]
 +
    <user>
 
</source>
 
</source>
|| no
+
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova rename
+
keystone user-update
     <server>
+
     --user_id <user-id>
     <name>
+
     [--name <user-name>]
 +
    [--domain_id <domain-id>]
 +
    [--default_project_id <project-id>]
 +
    [--description <description>]
 +
    [--enabled <true|false>]
 +
    [--password <password>]
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os rescue server
+
os user show
     <server>
+
     <user>
 
</source>
 
</source>
|| no
+
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova rescue
+
keystone user-get
     <server>
+
     <user-id>
 
</source>
 
</source>
|-
+
|}
|
+
 
<source lang="bash">
+
== Compute ==
os resize server
+
 
    --flavor <flavor>
+
 
    [--wait]
+
{| class="wikitable"
    <server>
+
|-  
</source>
+
! OSC Option !! Environment Variable !! !! Nova Option !! Environment Variable
|| no
+
|-
|| ||
+
| || || || --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">
 
<source lang="bash">
nova resize
+
os agent create
     [--poll]
+
     <os>
     <server>
+
    <architecture>
     <flavor>
+
    <version>
 +
    <url>
 +
     <md5hash>
 +
     <hypervisor>
 
</source>
 
</source>
 +
|| yes
 +
|| ||
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os resize server
+
os agent delete
    --confirm
+
     <id>
     <server>
 
 
</source>
 
</source>
|| no
+
|| yes
 
|| ||
 
|| ||
 +
|-
 +
|
 
<source lang="bash">
 
<source lang="bash">
nova resize-confirm
+
os agent list
     <server>
+
     [--hypervisor <hypervisor>]
 
</source>
 
</source>
 +
|| yes
 +
|| ||
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os resume server
+
os agent set
     <server>
+
     <id>
 +
    <version>
 +
    <url>
 +
    <md5hash>
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
<source lang="bash">
+
|}
nova resume
+
 
    <server>
+
 
</source>
+
==== aggregate ====
 +
 
 +
{| class="wikitable"
 +
|-
 +
! OSC Command !! Implemented !! !! Nova command
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os resize server
+
os aggregate add host
     --revert
+
     <aggregate>
     <server>
+
     <host>
 
</source>
 
</source>
|| no
+
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova resize-revert
+
nova aggregate-add-host
     <server>
+
    <id>
 +
     <host>
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os set server
+
os aggregate create
     --meta-data <key=value>
+
     [--zone <availability-zone>]
     [--meta-data <key=value>] ...
+
     [--property <key=value>]
    <server>
+
     <name>
os unset server
 
    --meta-data <key>
 
    [--meta-data <key>] ...
 
     <server>
 
 
</source>
 
</source>
|| no
+
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova meta
+
nova aggregate-create
     <server>
+
     <name>
    <action>
+
     [<availability_zone>]
    <key=value>
 
     [<key=value> ...]
 
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os set server
+
os aggregate delete
    --root-password
+
     <aggregate>
     <server>
 
 
</source>
 
</source>
|| no
+
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova root-password
+
nova aggregate-delete
     <server>
+
     <id>
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os show server
+
os aggregate list
     <server>
+
     [--long]
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova show
+
nova aggregate-list
    <server>
 
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os ssh server
+
os aggregate remove host
     [--port PORT]
+
     <aggregate>
    --private]
+
     <host>
    [--ipv6]
+
</source>
    [--login <login>]
+
|| yes
     <server>
 
</source>
 
|| no
 
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova ssh
+
nova aggregate-remove-host
    [--port PORT]
+
     <id>
    [--private]
+
     <host>
    [--ipv6]
 
     [--login <login>]
 
     <server>
 
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os suspend server
+
os aggregate set
     <server>
+
     [--name <new-name>]
 +
    [--zone <availability-zone>]
 +
    [--property <key=value>]
 +
    <aggregate>
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova suspend
+
nova aggregate-update
     <server>
+
     <id>
 +
    <name>
 +
    [<availability_zone>]
 +
 
 +
nova aggregate-set-metadata
 +
    <id>
 +
    <key=value>
 +
    [<key=value> ...]
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os unlock server
+
os aggregate show
     <server>
+
     <aggregate>
 
</source>
 
</source>
|| no
+
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova unlock
+
nova aggregate-details
     <server>
+
     <id>
 
</source>
 
</source>
 +
|}
 +
 +
==== bash-completion ====
 +
 +
{| class="wikitable"
 +
|-
 +
! OSC Command !! Implemented !! !! Nova command
 +
|-
 +
|
 +
TBD
 +
|| no
 +
|| ||
 +
<source lang="bash">
 +
nova bash-completion
 +
</source>
 +
|}
 +
 +
==== cloudpipe ====
 +
 +
{| class="wikitable"
 +
|-
 +
! OSC Command !! Implemented !! !! Nova command
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os unpause server
+
os create cloudpipe
     <server>
+
     <project>
 
</source>
 
</source>
|| yes
+
|| no
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova unpause
+
nova cloudpipe-create
     <server>
+
     <project>
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os unrescue server
+
os list cloudpipe
    <server>
 
 
</source>
 
</source>
 
|| no
 
|| no
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova unrescue
+
nova cloudpipe-list
    <server>
 
 
</source>
 
</source>
 
|}
 
|}
  
 +
==== console ====
  
'''usage'''
+
{| class="wikitable"
 
+
|-
 +
! OSC Command !! Implemented !! !! Nova command
 +
|-
 +
|
 
<source lang="bash">
 
<source lang="bash">
nova usage-list [--start <start>] [--end <end>]
+
os console log show
 
+
    [--lines <num-lines>]
os list usage ...
+
    <server>
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
'''volume'''
 
 
 
 
<source lang="bash">
 
<source lang="bash">
nova volume-attach <server> <volume> <device>
+
nova console-log
 
+
    [--length <length>]
os attach volume ...
+
    <server>
 
</source>
 
</source>
 
+
|-
 
+
|
 
<source lang="bash">
 
<source lang="bash">
nova volume-create [--snapshot_id <snapshot_id>]
+
os console url show
                  [--display_name <display_name>]
+
    [--novnc | --xvpvnc | --spice]
                  [--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 get-vnc-console
 
+
    <server>
os delete volume ...
+
    <console_type>
 
</source>
 
</source>
 +
|}
  
 +
==== credentials ====
  
<source lang="bash">
+
See [[#credentials|credentials]] in the [[#Cross_API|cross API section]].
nova volume-detach <server> <volume>
 
 
 
os detach volume ...
 
</source>
 
  
 +
==== diagnostics ====
  
 +
''Consider implementing this as: show server --diagnostics <server>''
 +
{| class="wikitable"
 +
|-
 +
! OSC Command !! Implemented !! !! Nova command
 +
|-
 +
|
 
<source lang="bash">
 
<source lang="bash">
nova nova volume-list
+
os diagnostics show
 
+
    <server>
os list volume
 
 
</source>
 
</source>
 
+
|| no
 
+
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova volume-show <volume>
+
nova diagnostics
 
+
    <server>
os show volume ...
 
 
</source>
 
</source>
 +
|}
  
 +
==== dns ====
  
'''volume-snapshot'''
+
''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-create [--force <True|False>]
+
os create dns
                            [--display_name <display_name>]
+
    [--type <type>]
                            [--display_description <display_description>]
+
    <ip>
                            <volume_id>
+
    <name>
 
+
    <domain>
os create volume-snapshot ...
 
 
</source>
 
</source>
 
+
|| no
 
+
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova volume-snapshot-delete <snapshot_id>
+
nova dns-create
 
+
    [--type <type>]
os delete volume-snapshot ...
+
    <ip>
 +
    <name>
 +
    <domain>
 
</source>
 
</source>
 
+
|-
 
+
|
 
<source lang="bash">
 
<source lang="bash">
nova volume-snapshot-list
+
os delete dns
 
+
    <domain>
os list volume-snapshot
+
    <name>
 
</source>
 
</source>
 
+
|| no
 
+
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova volume-snapshot-show <snapshot>
+
nova dns-delete
 
+
    <domain>
os show volume-snapshot
+
    <name>
 
</source>
 
</source>
 
+
|-
 
+
|
'''volume-type'''
 
 
 
 
<source lang="bash">
 
<source lang="bash">
nova volume-type-create <name>
+
os list dns
 
+
    [--ip <ip>]
os create volume-type ...
+
    [--name <name>]
 +
    <domain>
 
</source>
 
</source>
 
+
|| no
 
+
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova volume-type-delete <id>
+
nova dns-list
 
+
    [--ip <ip>]
os delete volume-type ...
+
    [--name <name>]
 +
    <domain>
 
</source>
 
</source>
 
+
|-
 
+
|
 
<source lang="bash">
 
<source lang="bash">
nova volume-type-list
+
os create dns-domain
 
+
    [--project <project>]
os list volume-type
+
    [--availability-zone <availability-zone>]
 +
    [--public | --private]
 +
    <domain>
 
</source>
 
</source>
 
+
|| no
 
+
|| ||
'''x509-cert'''
 
 
 
 
<source lang="bash">
 
<source lang="bash">
nova x509-create-cert [<private_key_file>] [<x509_cert>]
+
nova dns-create-private-domain
 +
    [--availability_zone <availability_zone>]
 +
    <domain>
  
os create x509-cert ...
+
nova dns-create-public-domain
 +
    [--project <project>]
 +
    <domain>
 
</source>
 
</source>
 
+
|-
 
+
|
'''x509-root-cert'''
 
 
 
 
<source lang="bash">
 
<source lang="bash">
nova x509-get-root-cert [<filename>]
+
os delete dns-domain
 
+
    <domain>
os show x509-root-cert ...
 
 
</source>
 
</source>
 +
|| no
 +
|| ||
 +
<source lang="bash">
 +
nova dns-delete-domain
 +
    <domain>
 +
</source>
 +
|-
 +
|
 +
<source lang="bash">
 +
os list dns-domains
 +
</source>
 +
|| no
 +
|| ||
 +
<source lang="bash">
 +
nova dns-domains
 +
</source>
 +
|}
  
 +
==== endpoints ====
  
== Image ==
+
''Totally duplicates Identity catalog command''
 +
{| class="wikitable"
 +
|-
 +
! OSC Command !! Implemented !! !! Nova command
 +
|-
 +
|
 +
<source lang="bash">
 +
os endpoint list
 +
</source>
 +
|| no
 +
|| ||
 +
<source lang="bash">
 +
nova endpoints
 +
</source>
 +
|}
  
 +
==== fixed-ip ====
  
 
{| class="wikitable"
 
{| class="wikitable"
|-  
+
|-
! Nova Option !! Environment Variable !!   !! OSC Option !!  Environment Variable
+
! OSC Command !! Implemented !! !! Nova command
|-
+
|-
| --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>]
+
os ip fixed add
                                  [--disk-format <CONTAINER_FORMAT>]
+
    <network>
                                  [--container-format <DISK_FORMAT>]
+
    <server>
                                  [--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 ...
 
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
 
<source lang="bash">
 
<source lang="bash">
glance image-delete <IMAGE_ID>
+
nova add-fixed-ip
 
+
    <server>
os delete image ...
+
    <network_id>
 
</source>
 
</source>
 
+
|-
 
+
|
 
<source lang="bash">
 
<source lang="bash">
glance image-list
+
os ip fixed remove
 
+
    <ip-address>
os list image ...
+
    <server>
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
 
<source lang="bash">
 
<source lang="bash">
glance image-show <IMAGE_ID>
+
nova remove-fixed-ip
 
+
    <server>
os show image ...
+
    <address>
 
</source>
 
</source>
 +
|}
  
  
<source lang="bash">
+
==== flavor ====
glance member-images [options] <MEMBER>
 
 
 
os list image --member <member> [options]
 
</source>
 
 
 
  
 +
{| class="wikitable"
 +
|-
 +
! OSC Command !! Implemented !! !! Nova command
 +
|-
 +
|
 
<source lang="bash">
 
<source lang="bash">
glance show [options] <ID>
+
os flavor create
 
+
    [--id <id>]
os show image ...
+
    [--ram <size-mb>]
 +
    [--disk <size-gb>]
 +
    [--ephemeral-disk <size-gb>]
 +
    [--swap <size-mb>]
 +
    [--vcpus <num-cpu>]
 +
    [--rxtx-factor <factor>]
 +
    [--public | --private]
 +
    <name>
 
</source>
 
</source>
 
+
||
 
 
 
<source lang="bash">
 
<source lang="bash">
glance update [options] <ID> <field1=value1 field2=value2 ...>
+
(partial)
 +
default: auto
 +
default: 256M
 +
default: 0G
 +
default: 0G
 +
default: 0G
 +
default: 1
 +
default: 1
 +
default: public
  
os set image ...
 
 
</source>
 
</source>
 
+
|| ||
 
 
'''image-member'''
 
 
 
 
<source lang="bash">
 
<source lang="bash">
glance member-create [--can-share] <IMAGE_ID> <TENANT_ID>
+
nova flavor-create
 
+
    [--ephemeral <ephemeral>]
os create image-member ...
+
    [--swap <swap>]
 +
    [--rxtx-factor <factor>]
 +
    <name>
 +
    <id>
 +
    <ram>
 +
    <disk>
 +
    <vcpus>
 
</source>
 
</source>
 
+
|-
 
+
|
 
<source lang="bash">
 
<source lang="bash">
glance member-delete <IMAGE_ID> <TENANT_ID>
+
os flavor delete
 
+
    <flavor>
os list image-member <image> [options]
 
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
 +
<source lang="bash">
 +
nova flavor-delete
 +
    <id>
 +
</source>
 +
|-
 +
|
 +
<source lang="bash">
 +
os flavor list
 +
</source>
 +
|| yes
 +
|| ||
 
<source lang="bash">
 
<source lang="bash">
glance member-delete [options] <ID> <MEMBER>
+
nova flavor-list
 
 
os delete image-member ...
 
 
</source>
 
</source>
 
+
|-
 
+
|
 
<source lang="bash">
 
<source lang="bash">
glance member-list [--image-id <IMAGE_ID>] [--tenant-id <TENANT_ID>]
+
os flavor show
 
+
    <flavor>
os list image-member ...
 
 
</source>
 
</source>
 +
|| yes
 +
|| ||
 +
|}
  
  
== Volume ==
+
==== floating-ip ====
 
 
  
 
{| 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 ip floating add
 
+
    <ip-address>
os list credential
+
    <server>
 
</source>
 
</source>
 
+
|| yes
'''limits'''
+
|| ||
 
 
 
<source lang="bash">
 
<source lang="bash">
cinder rate-limits
+
nova add-floating-ip
 
+
    <server>
os list limit --rate
+
    <address>
 
</source>
 
</source>
 
+
|-
 
+
|
 
<source lang="bash">
 
<source lang="bash">
cinder absolute-limits
+
os ip floating create
 
+
    [<pool>]
os list limit --absolute
 
 
</source>
 
</source>
 
+
|| yes
'''snapshot'''
+
|| ||
 
 
 
<source lang="bash">
 
<source lang="bash">
cinder snapshot-create
+
nova floating-ip-create
<volume-id>
+
    [<floating_ip_pool>]
--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>
 
+
|-
 
+
|
 
<source lang="bash">
 
<source lang="bash">
cinder snapshot-delete <snapshot-id>
+
os ip floating delete
 
+
    <ip-address>
os delete snapshot <snapshot-id>
 
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
 
<source lang="bash">
 
<source lang="bash">
cinder snapshot-list
+
nova floating-ip-delete
--all-tenants [<0|1>]
+
    <address>
--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>
 
+
|-
 
+
|
 
<source lang="bash">
 
<source lang="bash">
cinder snapshot-rename
+
os ip floating list
--display-description <display-description>
 
<snapshot-id>
 
<display-name>
 
 
 
os update snapshot
 
--display-description <display-description>
 
<snapshot-id>
 
<display-name>
 
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
 
<source lang="bash">
 
<source lang="bash">
cinder snapshot-show <snapshot-id>
+
nova floating-ip-list
 
 
os show snapshot <snapshot-id>
 
 
</source>
 
</source>
 
+
|-
'''type'''
+
|
 
 
 
<source lang="bash">
 
<source lang="bash">
cinder type-create <type-name>
+
os ip floating remove
 
+
    <ip-address>
os create type <type-name>
+
    <server>
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
 
<source lang="bash">
 
<source lang="bash">
cinder type-delete <type-id>
+
nova remove-floating-ip
 
+
    <server>
os delete type <type>
+
    <address>
 
</source>
 
</source>
 +
|}
  
  
<source lang="bash">
+
==== floating-ip-pool ====
cinder type-list
 
 
 
os list type
 
</source>
 
 
 
 
 
<source lang="bash">
 
cinder extra-specs-list
 
 
 
os tbd
 
</source>
 
 
 
 
 
<source lang="bash">
 
cinder type-key <type-name-or-id> <action (set|unset)> <key=value>
 
 
 
os tbd
 
</source>
 
 
 
  
==== volume ====
 
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 2,357: Line 2,290:
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os create volume
+
os ip floating pool list
    [--name <name>]
 
    [--description <description>]
 
    [--volume-type <volume-type>]
 
    [--snapshot-id <snapshot-id>]
 
    [--source <volid>]
 
    [--image <image-id>]
 
    [--availability-zone <availability-zone>]
 
    [--metadata [<key=value>]]
 
    <size>
 
 
</source>
 
</source>
|| wip
+
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
cinder create
+
nova floating-ip-pool-list
    [--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>
 +
|}
 +
 +
 +
==== host ====
 +
 +
{| class="wikitable"
 +
|-
 +
! OSC Command !! Implemented !! !! Nova command
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os delete volume
+
os host list
     <volume>
+
     [--zone <availability-zone>]
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
cinder delete
+
nova host-action
     <volume-id>
+
     [--action <action>]
 +
    <hostname>
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os list volume
+
os host set
     --long
+
     ...
 
</source>
 
</source>
|| yes (no opts yet)
+
|| no
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
cinder list
+
nova host-update
     --all-tenants [<0|1>]
+
     [--status <status>]
     --display-name <display-name>
+
    [--maintenance <maintenance_mode>]
     --status <status>
+
     <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>
 
</source>
 +
|| yes
 +
|| ||
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os set volume
+
os hypervisor show
     --name <new-name>
+
    <id>
     --description <description>
+
</source>
     <volume>
+
|| yes
</source>
+
|| ||
|| yes
+
|}
|| ||
+
 
<source lang="bash">
+
 
cinder rename
+
==== keypair ====
     --display-description <display-description>
+
 
     <volume-id>
+
{| class="wikitable"
     <display-name>
+
|-
 +
! 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>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os show volume
+
os volume type unset
     <volume>
+
    [--property <key>]
 +
     <volume-type>
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
cinder show
+
cinder type-key
    <volume-id>
+
     <type-id>
</source>
+
     <unset>
|-
+
     <key>
|
 
||
 
|| ||
 
<source lang="bash">
 
cinder force-delete
 
    <volume-id>
 
</source>
 
|-
 
|
 
||
 
|| ||
 
<source lang="bash">
 
cinder metadata
 
     <volume-id>
 
     <action>
 
     <key=value>
 
 
</source>
 
</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,613: 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>]
    [<