Jump to: navigation, search

Difference between revisions of "UnifiedCLI/Mapping"

(Updates to compute - server table)
(Redirected page to OpenStackClient/Commands)
 
(152 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 ==
 
 
 
 
{| class="wikitable"
 
|-
 
! 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> ||  ||  ||  ||
 
|-
 
|}
 
  
 +
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.
  
=== API v2.0 ===
+
==== credentials ====
  
====catalog====
+
''[consider rolling the ec2 creds into this too]''
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 147: Line 205:
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os show service
+
os credentials create
     [--catalog <service-type>]
+
    --x509
 +
     [<private-key-file>]
 +
    [<certificate-file>]
 
</source>
 
</source>
|| yes
+
|| no
 +
|| ||
 +
<source lang="bash">
 +
nova x509-create-cert
 +
    [<pk-file>]
 +
    [<x509-cert>]
 +
</source>
 +
|-
 +
|
 +
<source lang="bash">
 +
os credentials show
 +
    [--token]
 +
    [--user]
 +
    [--x509 [--root]]
 +
</source>
 +
|| no
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone catalog
+
nova credentials
     [--service <service-type>]
+
     [--wrap <integer>]
 +
 
 +
nova x509-get-root-cert
 +
    [<filename>]
 
</source>
 
</source>
 
|}
 
|}
  
 
+
==== limits ====
====ec2-credentials====
 
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 167: Line 244:
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os create ec2-credentials
+
os limits show
     --tenant_id <tenant-id>
+
     --absolute [--reserved] | --rate
    [--user <user-id>]
 
 
 
 
</source>
 
</source>
|| no
+
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone ec2-credentials-create
+
nova absolute-limits
     [--user <user-id>]  
+
     [--reserved]
    [--tenant_id <tenant-id>]
+
 
## are both args really optional?
+
nova rate-limits
 +
 
 +
cinder absolute-limits
 +
 
 +
cinder rate-limits
 
</source>
 
</source>
 +
|}
 +
 +
==== quota ====
 +
 +
{| class="wikitable"
 
|-
 
|-
 +
! OSC Command !! Implemented !! !! Keystone command
 +
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os delete ec2-credentials
+
os quota set
     <access-key>
+
    # Compute settings
 +
    [--cores <num-cores>]
 +
    [--fixed-ips <num-fixed-ips>]
 +
    [--floating-ips <num-floating-ips>]
 +
    [--injected-file-size <injected-file-bytes>]
 +
    [--injected-files <num-injected-files>]
 +
     [--instances <num-instances>]
 +
    [--key-pairs <num-key-pairs>]
 +
    [--properties <num-properties>]
 +
    [--ram <ram-mb>]
 +
 
 +
    # Volume settings
 +
    [--gigabytes <new-gigabytes>]
 +
    [--snapshots <new-snapshots>]
 +
    [--volumes <new-volumes>]
  
## what changes if --user is not provided?
+
    <project>
 
</source>
 
</source>
|| no
+
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone ec2-credentials-delete
+
nova quota-update
     [--user <user-id>]  
+
    [--instances <instances>]
     --access <access-key>
+
    [--cores <cores>]
 +
    [--ram <ram>]
 +
    [--volumes <volumes>]
 +
    [--gigabytes <gigabytes>]
 +
    [--floating-ips <floating_ips>]
 +
    [--metadata-items <metadata_items>]
 +
    [--injected-files <injected_files>]
 +
     [--injected-file-content-bytes <injected_file_content_bytes>]
 +
    <tenant_id>
 +
 
 +
cinder quota-update
 +
    [--volumes <volumes>]
 +
     [--snapshots <snapshots>]
 +
    [--gigabytes <gigabytes>]
 +
    <tenant_id>
 
</source>
 
</source>
|-
+
|-  
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os list ec2-credentials
+
os quota set
     [--user <user-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>
|| no
+
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone ec2-credentials-list
+
nova quota-class-update
     [--user <user-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 show ec2-credentials
+
os quota show
     <access-key>
+
    [--default]
 
+
     <project>
## what changes if --user is not provided?
 
 
</source>
 
</source>
|| no
+
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone ec2-credentials-get
+
nova quota-show
     [--user <user-id>]  
+
     [--tenant <tenant-id>]
    --access <access-key>
 
</source>
 
|}
 
  
 +
cinder quota-show
 +
    <tenant_id>
  
==== endpoint ====
+
nova quota-defaults
 +
    <tenant_id>
  
{| class="wikitable"
+
cinder quota-defaults
|-
+
    <tenant_id>
! OSC Command !! Implemented !! !! Keystone command
+
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os create endpoint
+
os quota show
     [--region <endpoint-region>
+
     --class
    [--publicurl <public-url>]
+
     <class>
    [--adminurl <admin-url>]
+
</source>
    [--internalurl <internal-url>]
 
     <service>
 
</source>
 
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone endpoint-create
+
nova quota-class-show
    [--region <endpoint-region>]
+
     <class>
     [--service_id <service-id>]
+
 
    [--publicurl <public-url>]
+
cinder quota-class-show
    [--adminurl <admin-url>]
+
     <class>
     [--internalurl <internal-url>]
 
 
</source>
 
</source>
 +
|}
 +
 +
== Identity ==
 +
 +
{| class="wikitable"
 +
|-
 +
! 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 ====
 +
 +
{| class="wikitable"
 +
|-
 +
! OSC Command !! Implemented !! !! Keystone command
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os delete endpoint
+
os catalog show
     <endpoint-id>
+
     [--service <service>]
 
</source>
 
</source>
|| yes
+
|| no
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone endpoint-delete
+
keystone catalog
     <endpoint-id>
+
     [--service <service-type>]
 
</source>
 
</source>
 +
|}
 +
 +
==== ec2 credentials ====
 +
 +
{| class="wikitable"
 +
|-
 +
! OSC Command !! Implemented !! !! Keystone command
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os list endpoint
+
os ec2 credentials create
     [--long]
+
     [--project <project>]
 +
    [--user <user>]
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone endpoint-list
+
keystone ec2-credentials-create
 +
    [--user <user-id>]
 +
    [--tenant_id <tenant-id>]
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os show endpoint
+
os ec2 credentials delete
     [--type <endpoint-type>]
+
     [--user <user>]
    [--attr <endpoint-attribute>]  
+
     <access-key>
     [--value <endpoint-value>]
 
    [--all]
 
    <service>
 
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone endpoint-get
+
keystone ec2-credentials-delete
    --service <service-type>
+
     [--user <user-id>]  
     [--endpoint_type <endpoint-type>]
+
     --access <access-key>
     [--attr <service-attribute>]
 
    [--value <value>]
 
 
</source>
 
</source>
|}
 
 
 
====role====
 
 
{| class="wikitable"
 
|-
 
! OSC Command !! Implemented !! !! Keystone command
 
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os create role
+
os ec2 credentials list
     <role-name>
+
     [--user <user>]
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone role-create --name
+
keystone ec2-credentials-list
     <role-name>
+
     [--user <user-id>]
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os delete role
+
os ec2 credentials show
     <role>
+
     [--user <user>]
 +
    <access-key>
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone role-delete
+
keystone ec2-credentials-get
     <role-id>
+
     [--user <user-id>]
 +
    --access <access-key>
 
</source>
 
</source>
 +
|}
 +
 +
==== endpoint ====
 +
 +
{| class="wikitable"
 +
|-
 +
! OSC Command !! Implemented !! !! Keystone command
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os list role
+
os endpoint create
 +
    --publicurl <public-url>
 +
    [--adminurl <admin-url>]
 +
    [--internalurl <internal-url>]
 +
    [--region <endpoint-region>]
 +
    <service>
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone role-list
+
keystone endpoint-create
</source>
+
    [--region <endpoint-region>]
 +
    [--service_id <service-id>]
 +
    [--publicurl <public-url>]
 +
    [--adminurl <admin-url>]
 +
    [--internalurl <internal-url>]
 +
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os show role
+
os endpoint delete
     <role>
+
     <endpoint-id>
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone role-get
+
keystone endpoint-delete
     <role-id>
+
     <endpoint-id>
 
</source>
 
</source>
|}
 
 
 
====service====
 
 
{| class="wikitable"
 
|-
 
! OSC Command !! Implemented !! !! Keystone command
 
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os create service
+
os endpoint list
     [--type <service-type>]
+
     [--long]
    [--description <service-description>]
 
    <service-name>
 
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone service-create
+
keystone endpoint-list
    --name <name>
 
    --type <type>
 
    [--description <service-description>]
 
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os delete service
+
os endpoint show
     <service>
+
    [--type <endpoint-type>]
 +
    [--attr <endpoint-attribute>]
 +
    [--value <endpoint-value>]
 +
    [--all]
 +
     <service-type>
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone service-delete
+
keystone endpoint-get
     <service-id>
+
    --service <service-type>
 +
     [--endpoint_type <endpoint-type>]
 +
    [--attr <service-attribute>]
 +
    [--value <value>]
 
</source>
 
</source>
 +
|}
 +
 +
==== role ====
 +
 +
{| class="wikitable"
 +
|-
 +
! OSC Command !! Implemented !! !! Keystone command
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os list service [--long]
+
os role create
 +
    <role-name>
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone service-list
+
keystone role-create --name
 +
    <role-name>
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os show service
+
os role delete
     <service>
+
     <role>
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone service-get
+
keystone role-delete
     <service-id>
+
     <role-id>
 
</source>
 
</source>
|}
 
 
 
====tenant====
 
 
{| class="wikitable"
 
|-
 
! OSC Command !! Implemented !! !! Keystone command
 
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os create tenant
+
os role list
    [--description <tenant-description>]
 
    [--enable | --disable]
 
    <tenant-name>
 
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone tenant-create
+
keystone role-list
    --name <tenant-name>
+
</source>
    [--description <tenant-description>]
 
    [--enabled <true|false>]
 
</source>
 
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os delete tenant
+
os role show
     <tenant>
+
     <role>
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone tenant-delete
+
keystone role-get
     <tenant-id>
+
     <role-id>
 
</source>
 
</source>
 +
|}
 +
 +
==== service ====
 +
 +
{| class="wikitable"
 +
|-
 +
! OSC Command !! Implemented !! !! Keystone command
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os list tenant
+
os service create
     [--long]
+
     [--type <service-type>]
 +
    [--description <service-description>]
 +
    <service-name>
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone tenant-list
+
keystone service-create
 +
    --name <name>
 +
    --type <type>
 +
    [--description <service-description>]
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os set tenant
+
os service delete
     [--name <new-tenant-name>]
+
     <service>
    [--description <new-tenant-description>]
 
    [--enable | --disable]
 
    <tenant>
 
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone tenant-update
+
keystone service-delete
    [--name <tenant_name>]
+
     <service-id>
    [--description <tenant-description>]
 
    [--enabled <true|false>]
 
     <tenant-id>
 
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os show tenant
+
os service list
     <tenant>
+
     [--long]
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone tenant-get
+
keystone service-list
    <tenant-id>
 
 
</source>
 
</source>
|}
 
 
 
==== token ====
 
 
{| class="wikitable"
 
|-
 
! OSC Command !! Implemented !! !! Keystone command
 
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os show token
+
os service show
     [--width <token-display-width>]
+
     [--catalog]
 +
    <service>
 
</source>
 
</source>
|| ??
+
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone token-get [--wrap <integer>]
+
keystone service-get
 +
    <service-id>
 
</source>
 
</source>
 
|}
 
|}
  
 
+
==== tenant ====
====user====
 
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 511: Line 688:
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os create user
+
os tenant create
     [--password <user-password>]
+
     [--description <description>]
    [--email <user-email>]
 
    [--tenant <tenant>]
 
 
     [--enable | --disable]
 
     [--enable | --disable]
     <user-name>
+
     <tenant-name>
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone user-create
+
keystone tenant-create
     --name <user-name>  
+
     --name <tenant-name>
     [--tenant_id <tenant-id>]
+
     [--description <tenant-description>]
    [--pass <pass>]
 
    [--email <email>]
 
 
     [--enabled <true|false>]
 
     [--enabled <true|false>]
 
</source>
 
</source>
Line 531: Line 704:
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os delete user
+
os tenant delete
     <user>
+
     <tenant>
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone user-delete
+
keystone tenant-delete
     <user-id>
+
     <tenant>
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os list user
+
os tenant list
    [--tenant <tenant>]
 
 
     [--long]
 
     [--long]
 
</source>
 
</source>
Line 550: Line 722:
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone user-list
+
keystone tenant-list
    [<tenant-id>]
 
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os set user
+
os tenant set
     [--name <new-user-name>]
+
     [--name <new-tenant-name>]
     [--password <user-password>]
+
     [--description <new-tenant-description>]
    [--email <user-email>]
+
     [--enable | --disable]
    [--tenant <tenant>]
+
     <tenant>
     [--enable|--disable]
 
     <user>
 
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone user-password-update
+
keystone tenant-update
     --pass <password>
+
    [--name <tenant_name>]
     <user-id>
+
    [--description <tenant-description>]
 +
     [--enabled <true|false>]
 +
     <tenant-id>
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os show user
+
os tenant show
     <user>
+
     <tenant>
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone user-get
+
keystone tenant-get
     <user-id>
+
     <tenant-id>
 
</source>
 
</source>
 
|}
 
|}
  
 
+
==== token ====
====user-role====
 
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 594: Line 764:
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os add role-user
+
os token show
     [--tenant <tenant>]
+
     [--width <token-display-width>]
    <role> <user>
 
 
</source>
 
</source>
|| yes
+
|| ??
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone user-role-add
+
keystone token-get [--wrap <integer>]
    --user <user-id>
 
    --role <role-id>
 
    [--tenant_id <tenant-id>]
 
 
</source>
 
</source>
 +
|}
 +
 +
==== user ====
 +
 +
{| class="wikitable"
 +
|-
 +
! OSC Command !! Implemented !! !! Keystone command
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os list role-user
+
os user create
 +
    [--password <user-password>]
 +
    [--email <user-email>]
 
     [--tenant <tenant>]
 
     [--tenant <tenant>]
     [<user>]
+
     [--enable | --disable]
 +
    <user-name>
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone user-role-list
+
keystone user-create
     [--user <user-id>]
+
     --name <user-name>  
 
     [--tenant_id <tenant-id>]
 
     [--tenant_id <tenant-id>]
 +
    [--pass <pass>]
 +
    [--email <email>]
 +
    [--enabled <true|false>]
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os remove role-user
+
os user delete
     [--tenant <tenant>]
+
     <user>
    <role> <user>
 
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone user-role-remove
+
keystone user-delete
     --user <user-id>
+
     <user-id>
    --role <role-id>
 
    [--tenant_id <tenant-id>]
 
 
</source>
 
</source>
|}
+
|-
 
+
|
 
 
'''<other>'''
 
 
 
 
<source lang="bash">
 
<source lang="bash">
keystone bootstrap
+
os user list
        --pass <password>
+
    [--tenant <tenant>]
        [--user-name <user-name>]
+
    [--long]
        [--role-name <role-name>]
 
        [--tenant-name <tenant-name>]
 
 
 
##TBD
 
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
 
 
 
<source lang="bash">
 
<source lang="bash">
keystone discover
+
keystone user-list
 
+
    [<tenant-id>]
##TBD
 
 
</source>
 
</source>
 
+
|-
=== API v3 ===
+
|
 
 
'''credential'''
 
 
 
 
<source lang="bash">
 
<source lang="bash">
keystone credential-create --user_id <user-id>
+
os user set
                      --type <credential-type>
+
    [--name <new-user-name>]
                      --data <credential-data>
+
    [--password <user-password>]
                      [--project_id <project-id>]
+
    [--email <user-email>]
 
+
    [--tenant <tenant>]
os create credential
+
    [--enable|--disable]
        [--project <project>]
+
    <user>
        <user>
 
        <type>
 
        <data>
 
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone credential-delete <credential-id>
+
keystone user-password-update
 
+
    --pass <password>
os delete credential <credential-id>
+
    <user-id>
 
</source>
 
</source>
 
+
|-
 
+
|
 
<source lang="bash">
 
<source lang="bash">
keystone credential-get <credential-id>
+
os user show
 
+
    <user>
os show credential <credential-id>
 
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone credential-list
+
keystone user-get
 
+
    <user-id>
os list credential [--long]
 
 
</source>
 
</source>
 +
|}
  
 +
==== user role ====
  
 +
{| class="wikitable"
 +
|-
 +
! OSC Command !! Implemented !! !! Keystone command
 +
|-
 +
|
 
<source lang="bash">
 
<source lang="bash">
keystone credential-update
+
os user role add
        [--user <user>]
+
    [--tenant <tenant>]
        [--type <type>]
+
    <user>
        [--data <data>]
+
    <role>
        [--project <project>]
 
        <credential-id>
 
 
 
os set credential
 
        [--user <user>]
 
        [--type <type>]
 
        [--data <data>]
 
        [--project <project>]
 
        <credential-id>
 
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
'''domain'''
 
 
 
 
<source lang="bash">
 
<source lang="bash">
keystone domain-create --name <domain-name>
+
keystone user-role-add
                      [--description <domain-description>]
+
    --user <user-id>
                      [--enabled <true|false>]
+
    --role <role-id>
                      [--private_project_names <true|false>]
+
    [--tenant_id <tenant-id>]
                      [--private_user_names <true|false>]
 
 
 
os create domain
 
        [--description <domain-description>]
 
        [--enable | --disable]
 
        [--private_project_names]
 
        [--private_user_names]
 
        <domain-name>
 
 
</source>
 
</source>
 
+
|-
 
+
|
 
<source lang="bash">
 
<source lang="bash">
keystone domain-delete <domain-id>
+
os user role list
 
+
    [--tenant <tenant>]
os delete domain <domain>
+
    [<user>]
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone domain-get <domain-id>
+
keystone user-role-list
 
+
    [--user <user-id>]
os show domain <domain>
+
    [--tenant_id <tenant-id>]
 
</source>
 
</source>
 
+
|-
 
+
|
 
<source lang="bash">
 
<source lang="bash">
keystone domain-list
+
os user role remove
 
+
    [--tenant <tenant>]
os list domain [--long]
+
    <user>
 +
    <role>
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone domain-update
+
keystone user-role-remove
        [--name <domain_name>]
+
    --user <user-id>
        [--description <domain-description>]
+
    --role <role-id>
        [--enabled <true|false>]
+
    [--tenant_id <tenant-id>]
        [--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>
 +
|}
  
 +
==== <other> ====
  
'''endpoint'''
+
These keystone commands are not planned for re-implementation in OpenStackClient
  
 
<source lang="bash">
 
<source lang="bash">
keystone endpoint-create --service_id <service-id>
+
keystone bootstrap
--interface <endpoint-interface>
+
        --pass <password>
--url <endpoint-url>
+
        [--user-name <user-name>]
[--region <endpoint-region>]
+
        [--role-name <role-name>]
                        [--enabled <true|false>]
+
        [--tenant-name <tenant-name>]
 
 
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>
+
keystone discover
 
 
os delete endpoint <endpoint-id>
 
 
</source>
 
</source>
  
 +
=== API v3 ===
  
<source lang="bash">
+
==== credential ====
keystone endpoint-list
 
  
os list endpoint [--long]
+
{| class="wikitable"
 +
|-
 +
! OSC Command !! Implemented !! !! Keystone command
 +
|-
 +
|
 +
<source lang="bash">
 +
os credential create
 +
    [--project <project>]
 +
    [--type ec2|cert]
 +
    <user>
 +
    <data>
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone enpoint-get <endpoint-id>
+
keystone credential-create
 
+
    --user_id <user-id>
os show endpoint <endpoint-id>
+
    --type <credential-type>
 +
    --data <credential-data>
 +
    [--project_id <project-id>]
 
</source>
 
</source>
 
+
|-
 
+
|
 
<source lang="bash">
 
<source lang="bash">
keystone endpoint-update --endpoint_id <endpoint-id>
+
os credential delete
[--region <endpoint-region>]
+
    <credential-id>
        [--enabled <true|false>]
 
[<service-id>]
 
[<endpoint-interface>]
 
[<endpoint-url>]
 
 
 
os update endpoint
 
[--region <endpoint-region>]
 
        [--enabled <true|false>]
 
[--service <service-id>]
 
[--interface <endpoint-interface>]
 
[--url <endpoint-url>]
 
        <endpoint-id>
 
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
'''group'''
 
 
 
 
<source lang="bash">
 
<source lang="bash">
keystone group-create --name <group-name>
+
keystone credential-delete
                      [--domain_id <domain-id>]
+
    <credential-id>
                      [--description <group-description>]
 
 
 
os create group
 
        [--domain <domain>]
 
        [--description <group-description>]
 
        <group-name>
 
 
</source>
 
</source>
 
+
|-
 
+
|
 
<source lang="bash">
 
<source lang="bash">
keystone group-delete <group-id>
+
os credential list
 
 
os delete group <group>
 
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone group-get <group-id>
+
keystone credential-list
 
 
os show group <group>
 
 
</source>
 
</source>
 
+
|-
 
+
|
 
<source lang="bash">
 
<source lang="bash">
keystone group-list
+
os credential set
 
+
    [--user <user>]
os list group [--long]
+
    [--type ec2|cert]
 +
    [--data <data>]
 +
    [--project <project>]
 +
    <credential-id>
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone group-update
+
keystone credential-update
        [--name <group_name>]
+
    [--user <user>]
        [--domain_id <domain-id>]
+
    [--type <type>]
        [--description <group-description>]
+
    [--data <data>]
        <group-id>
+
    [--project <project>]
 
+
    <credential-id>
os set group
 
        [--name <new-group-name>]
 
        [--domain <domain>]
 
        [--description <new-group-description>]
 
        <group>
 
 
</source>
 
</source>
 
+
|-
 
+
|
'''policy'''
 
 
 
 
<source lang="bash">
 
<source lang="bash">
keystone policy-create --type <policy-type>
+
os credential show
                      --blob <policy-blob>
+
    <credential-id>
 
 
os create policy
 
        --type <policy-type>
 
        --blob <policy-blob>
 
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone policy-delete <policy-id>
+
keystone credential-get
 
+
    <credential-id>
os delete policy <policy-id>
 
 
</source>
 
</source>
 +
|}
  
 +
==== domain ====
  
 +
{| class="wikitable"
 +
|-
 +
! OSC Command !! Implemented !! !! Keystone command
 +
|-
 +
|
 
<source lang="bash">
 
<source lang="bash">
keystone policy-get <policy-id>
+
os domain create
 
+
    [--description <domain-description>]
os show policy <policy-id>
+
    [--enable | --disable]
 +
    <domain-name>
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone policy-list
+
keystone domain-create
 
+
    --name <domain-name>
os list policy [--long]
+
    [--description <domain-description>]
 +
    [--enabled <true|false>]
 +
    [--private_project_names <true|false>]
 +
    [--private_user_names <true|false>]
 
</source>
 
</source>
 
+
|-
 
+
|
 
<source lang="bash">
 
<source lang="bash">
keystone policy-update
+
os domain delete
        [--type <policy-type>]
+
    <domain>
        [--blob <policy-blob>]
 
        <policy-id>
 
 
 
os set policy
 
        [--type <policy-type>]
 
        [--blob <policy-blob>]
 
        <policy-id>
 
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
'''project'''
 
 
 
 
<source lang="bash">
 
<source lang="bash">
keystone project-create --name <project-name>
+
keystone domain-delete
                      [--domain_id <project-domain-id>]
+
    <domain-id>
                      [--description <project-description>]
 
                      [--enabled <true|false>]
 
 
 
os create project
 
        [--domain <project-domain>]
 
        [--description <project-description>]
 
        [--enable | --disable]
 
        <project-name>
 
 
</source>
 
</source>
 
+
|-
 
+
|
 
<source lang="bash">
 
<source lang="bash">
keystone project-delete <project-id>
+
os domain list
 
 
os delete project <project>
 
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone project-get <project-id>
+
keystone domain-list
 
 
os show project <project>
 
 
</source>
 
</source>
 
+
|-
 
+
|
 
<source lang="bash">
 
<source lang="bash">
keystone project-list
+
os domain set
 
+
    [--name <new-domain-name>]
os list project [--long]
+
    [--description <new-domain-description>]
 +
    [--enable | --disable]
 +
    <domain>
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone project-update
+
keystone domain-update
        [--name <project_name>]
+
    [--name <domain_name>]
        [--domain_id <project-domain-id>]
+
    [--description <domain-description>]
        [--description <project-description>]
+
    [--enabled <true|false>]
        [--enabled <true|false>]
+
    [--private_project_names <true|false>]
        <project-id>
+
    [--private_user_names <true|false>]
 
+
    <domain-id>
os set project
 
        [--name <new-project-name>]
 
        [--domain <project-domain>]
 
        [--description <new-project-description>]
 
        [--enable | --disable]
 
        <project>
 
 
</source>
 
</source>
 
+
|-
 
+
|
'''role'''
 
 
 
 
<source lang="bash">
 
<source lang="bash">
keystone role-create --name <role-name>
+
os domain show
 
+
    <domain>
os create role <role-name>
 
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone role-delete <role-id>
+
keystone domain-get
 
+
    <domain-id>
os delete role <role>
 
 
</source>
 
</source>
 +
|}
  
 +
==== endpoint ====
  
 +
{| class="wikitable"
 +
|-
 +
! OSC Command !! Implemented !! !! Keystone command
 +
|-
 +
|
 
<source lang="bash">
 
<source lang="bash">
keystone role-get <role-id>
+
os endpoint create
 
+
    [--region <endpoint-region>
os show role <role>
+
    [--enable | --disable]
 +
    <service>
 +
    <interface admin|public|internal>
 +
    <url>
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone role-list
+
keystone endpoint-create
 
+
    [--region <endpoint-region>
os list role
+
    [--enable | --disable]
 +
    <service_id>
 +
    <interface admin|public|internal>
 +
    <url>
 
</source>
 
</source>
 
+
|-
 
+
|
 
<source lang="bash">
 
<source lang="bash">
keystone role-update <role-id>
+
os endpoint delete
 
+
    <endpoint-id>
os update role <role>
 
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
'''service'''
 
 
 
 
<source lang="bash">
 
<source lang="bash">
keystone service-create --type <type>
 
[--name <name>]
 
                        [--enabled <true|false>]
 
 
os create service
 
[--name <name>]
 
        [--enabled <true|false>]
 
        <type>
 
 
</source>
 
</source>
 
+
|-
 
+
|
 
<source lang="bash">
 
<source lang="bash">
keystone service-delete <service-id>
+
os endpoint list
 
+
    [--long]
os delete service <service>
 
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone service-get <service-id>
+
keystone endpoint-list
 
 
os show service <service>
 
 
</source>
 
</source>
 
+
|-
 
+
|
 
<source lang="bash">
 
<source lang="bash">
keystone service-list
+
os endpoint set
 
+
    [--interface <endpoint-interface>]
os list service [--long]
+
    [--url <endpoint-url>]
 +
    [--service <service-id>]
 +
    [--region <endpoint-region>]
 +
    [--enable | --disable]
 +
    <endpoint>
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone service-update --service_id <service-id>
+
keystone endpoint-set
[--type <type>]
+
    [--interface <endpoint-interface>]
[--name <name>]
+
    [--url <endpoint-url>]
                        [--enabled <true|false>]
+
    [--service <service-id>]
 
+
    [--region <endpoint-region>]
os update service
+
    [--enable | --disable]
[--type <type>]
+
    <endpoint>
[--name <name>]
 
        [--enabled <true|false>]
 
        <service>
 
 
</source>
 
</source>
 
+
|-
 
+
|
'''user'''
 
 
 
 
<source lang="bash">
 
<source lang="bash">
keystone user-create --name <user-name>
+
os endpoint show
                    [--domain_id <domain-id>]
+
    <endpoint>
                    [--default_project_id <project-id>]
 
                    [--description <description>]
 
                    [--enabled <true|false>]
 
                    [--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>
 
+
|| yes
 
+
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone user-delete <user-id>
+
keystone endpoint-get
 
+
    <endpoint>
os delete user <user>
 
 
</source>
 
</source>
 +
|}
  
 +
==== group ====
  
 +
{| class="wikitable"
 +
|-
 +
! OSC Command !! Implemented !! !! Keystone command
 +
|-
 +
|
 
<source lang="bash">
 
<source lang="bash">
keystone user-get <user-id>
+
os group create
 
+
    [--domain <domain>]
os show user <user>
+
    [--description <group-description>]
 +
    <group-name>
 +
</source>
 +
|| yes
 +
|| ||
 +
<source lang="bash">
 +
keystone group-create
 +
    --name <group-name>
 +
    [--domain_id <domain-id>]
 +
    [--description <group-description>]
 +
</source>
 +
|-
 +
|
 +
<source lang="bash">
 +
os group delete
 +
    <group>
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone user-list
+
keystone group-delete
 
+
    <group-id>
os list user [--long]
 
 
</source>
 
</source>
 
+
|-
 
+
|
 
<source lang="bash">
 
<source lang="bash">
keystone user-update --user_id <user-id>
+
os group list
    [--name <user-name>]
+
    [--long]
                    [--domain_id <domain-id>]
+
</source>
                    [--default_project_id <project-id>]
+
|| yes
                    [--description <description>]
+
|| ||
                    [--enabled <true|false>]
+
<source lang="bash">
                    [--password <password>]
+
keystone group-list
 
 
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"
 
|-
 
! OSC Option !! Environment Variable !! !! Nova Option !! Environment Variable
 
|-
 
| || || || --os-auth-system <auth-system> || OS_AUTH_SYSTEM
 
|-
 
| || || || --service-type <type> ||
 
|-
 
| || || || --service-name <name> || NOVA_SERVICE_NAME
 
|-
 
| || || || --volume-service-name <name> || NOVA_VOLUME_SERVICE_NAME
 
|-
 
| || || || --endpoint-type <type> || NOVA_ENDPOINT_TYPE
 
|-
 
| --os-compute-api-version <ver> || OS_COMPUTE_API_VERSION || || --os-compute-api-version <ver> || OS_COMPUTE_API_VERSION
 
|-
 
| || || || --bypass-url <bypass-url> ||
 
|}
 
 
 
=== API v2 (1.1) ===
 
 
==== agent ====
 
 
{| class="wikitable"
 
|-
 
! OSC Command !! Implemented !! !! Nova command
 
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os create agent
+
os group set
     <os>
+
     [--name <new-group-name>]
     <architecture>
+
     [--domain <domain>]
     <version>
+
     [--description <new-group-description>]
     <url>
+
     <group>
    <md5hash>
 
    <hypervisor>
 
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 +
<source lang="bash">
 +
keystone group-update
 +
    [--name <group_name>]
 +
    [--domain_id <domain-id>]
 +
    [--description <group-description>]
 +
    <group-id>
 +
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os delete agent
+
os group show
     <id>
+
     <group>
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 +
<source lang="bash">
 +
keystone group-get
 +
    <group-id>
 +
</source>
 +
|}
 +
 +
==== oauth ====
 +
 +
{| class="wikitable"
 +
|-
 +
! OSC Command !! Implemented !! !! Keystone command
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os list agent
+
os access token create
     [--hypervisor <hypervisor>]
+
     --consumer-key <consumer-key>
 +
    --consumer-secret <consumer-secret>
 +
    --request-key <request-key>
 +
    --request-secret <request-secret>
 +
    --verifier <pin>
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 +
<source lang="bash">
 +
n/a
 +
</source>
 +
|-
 +
| look at some alternatives: || || ||
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os set agent
+
os oauth token create
     <id>
+
     --consumer-key <consumer-key>
     <version>
+
     --consumer-secret <consumer-secret>
     <url>
+
     --request-key <request-key>
     <md5hash>
+
     --request-secret <request-secret>
 +
    --verifier <pin>
 
</source>
 
</source>
|| yes
+
|| nyet
 
|| ||
 
|| ||
|}
 
 
 
'''aggregate'''
 
 
 
<source lang="bash">
 
<source lang="bash">
nova aggregate-create <name> <availability_zone>
+
* makes the token specific to oauth
 
+
* add [--oauth-ver X] if versioning for oauth2 is an issue?
os create aggregate ...
 
 
</source>
 
</source>
 
+
|-
 
+
|
 
<source lang="bash">
 
<source lang="bash">
nova aggregate-delete <id>
+
os oauth token create
 +
    --access
 +
    --consumer-key <consumer-key>
 +
    --consumer-secret <consumer-secret>
 +
    --request-key <request-key>
 +
    --request-secret <request-secret>
 +
    --verifier <pin>
  
os delete aggregate ...
+
os oauth token create
 +
    --request
 +
    --consumer-key <consumer-key>
 +
    --roles <roles>
 
</source>
 
</source>
 
+
|| nyet
 
+
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova aggregate-details <id>
+
* collapse 'access token' and 'request token' into 'oauth token'?
 
 
os show aggregate ...
 
 
</source>
 
</source>
 +
|}
  
 +
==== policy ====
  
<source lang="bash">
+
{| class="wikitable"
nova aggregate-list
+
|-
 
+
! OSC Command !! Implemented !! !! Keystone command
os list aggregate
+
|-
 +
|
 +
<source lang="bash">
 +
os policy create
 +
    [--type <policy-type>]
 +
    --blob-file <blob-file>
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova aggregate-update <id> <name> [<availability_zone>]
+
keystone policy-create
 
+
    --type <policy-type>
os set aggregate ...
+
    --blob <policy-blob>
 
</source>
 
</source>
 
+
|-
 
+
|
 
<source lang="bash">
 
<source lang="bash">
nova aggregate-set-metadata <id> <key=value> [<key=value> ...]
+
os policy delete
 
+
    <policy-id>
os set aggregate --metadata ...
 
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
'''aggregate-host'''
 
 
 
 
<source lang="bash">
 
<source lang="bash">
nova aggregate-add-host <id> <host>
+
keystone policy-delete
 
+
    <policy-id>
os add aggregate-host ...
 
 
</source>
 
</source>
 
+
|-
 
+
|
 
<source lang="bash">
 
<source lang="bash">
nova aggregate-remove-host <id> <host>
+
os policy list
 
+
    [--include-blob]
os remove aggregate-host ...
 
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
'''bash-completion'''
 
 
 
 
<source lang="bash">
 
<source lang="bash">
nova bash-completion
+
keystone policy-list
 
 
os show bash-completion
 
 
</source>
 
</source>
 
+
|-
 
+
|
'''cloudpipe'''
 
 
 
 
<source lang="bash">
 
<source lang="bash">
nova cloudpipe-create <project>
+
os policy set
 
+
    [--type <policy-type>]
os create cloudpipe ...
+
    [--blob-file<blob-file>]
 +
    <policy-id>
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova cloudpipe-list
+
keystone policy-update
 
+
    [--type <policy-type>]
os list cloudpipe
+
    [--blob <policy-blob>]
 +
    <policy-id>
 
</source>
 
</source>
 
+
|-
 
+
|
'''console'''
 
 
 
 
<source lang="bash">
 
<source lang="bash">
nova console-log [--length <length>] <server>
+
os policy show
 
+
    <policy-id>
os show console ...
 
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova get-vnc-console <server> <console_type>
+
keystone policy-get
 
+
    <policy-id>
os show console [--vnc] ...
 
 
</source>
 
</source>
 +
|}
  
 +
==== project ====
  
'''credentials'''
+
{| class="wikitable"
 
+
|-
 +
! OSC Command !! Implemented !! !! Keystone command
 +
|-
 +
|
 
<source lang="bash">
 
<source lang="bash">
nova credentials
+
os project create
 
+
    [--domain <project-domain>]
os show credentials
+
    [--description <project-description>]
 +
    [--enable | --disable]
 +
    <project-name>
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
'''diagnostics'''
 
 
 
 
<source lang="bash">
 
<source lang="bash">
nova diagnostics <server>
+
keystone project-create
 
+
    [--domain_id <domain_id>]
os show diagnostics ...
+
    [--description <description>]
 +
    [--enable | --disable]
 +
    <name>
 
</source>
 
</source>
 
+
|-
 
+
|
'''dns'''
 
 
 
 
<source lang="bash">
 
<source lang="bash">
nova dns-create [--type <type>] <ip> <name> <domain>
+
os project delete
 
+
    <project>
os create dns ...
 
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova dns-delete <domain> <name>
+
os project-delete
 
+
    <project_id>
os delete dns ...
 
 
</source>
 
</source>
 
+
|-
 
+
|
 
<source lang="bash">
 
<source lang="bash">
nova dns-list [--ip <ip>] [--name <name>] <domain>
+
os project list
 
+
    [--long]
os list dns ...
 
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
'''dns-domain'''
 
 
 
 
<source lang="bash">
 
<source lang="bash">
nova dns-create-private-domain [--availability_zone <availability_zone>]
+
keystone project-list
                              <domain>
 
 
 
os create dns-domain [--private] ...
 
 
</source>
 
</source>
 
+
|-
 
+
|
'''dns-public-domain'''
 
 
 
 
<source lang="bash">
 
<source lang="bash">
nova dns-create-public-domain [--project <project>] <domain>
+
os project set
 
+
    [--name <new-project-name>]
os create dns-domain [--public] ...
+
    [--domain <project-domain>]
 +
    [--description <new-project-description>]
 +
    [--enable | --disable]
 +
    <project>
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova dns-delete-domain <domain>
+
keystone project-set
 
+
    [--name <new-project-name>]
os delete dns-domain ...
+
    [--domain <project-domain>]
 +
    [--description <new-project-description>]
 +
    [--enable | --disable]
 +
    <project_id>
 
</source>
 
</source>
 
+
|-
 
+
|
 
<source lang="bash">
 
<source lang="bash">
nova dns-domains
+
os project show
 
+
    <project>
os list dns-domains
 
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
'''endpoints'''
 
 
 
 
<source lang="bash">
 
<source lang="bash">
nova endpoints
+
keystone project-get
 
+
    <project_id>
os list endpoints
 
 
 
# does this overlap with keystone?
 
 
</source>
 
</source>
 +
|}
  
 +
==== role ====
  
'''fixed-ip'''
+
{| class="wikitable"
 
+
|-
 +
! OSC Command !! Implemented !! !! Keystone command
 +
|-
 +
|
 
<source lang="bash">
 
<source lang="bash">
nova add-fixed-ip <server> <network_id>
+
os role add
 
+
    [--user <user> | --group <group>]
os add fixed-ip ...
+
    [--domain <domain> | --project <project>]
 +
    <role>
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova remove-fixed-ip <server> <address>
 
 
os remove fixed-ip ...
 
 
</source>
 
</source>
 
 
==== flavor ====
 
 
{| class="wikitable"
 
|-
 
! OSC Command !! Implemented !! !! Nova command
 
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os create flavor
+
os role create
     [--id <id>]
+
     <role-name>
    [--ram <size-mb>]
 
    [--disk <size-gb>]
 
    [--ephemeral-disk <size-gb>]
 
    [--swap <size-mb>]
 
    [--vcpus <num-cpu>]
 
    [--rxtx-factor <factor>]
 
    [--public | --private]
 
    <name>
 
 
</source>
 
</source>
||
+
|| yes
 +
|| ||
 
<source lang="bash">
 
<source lang="bash">
(partial)
 
default: auto
 
default: 256M
 
default: 0G
 
default: 0G
 
default: 0G
 
default: 1
 
default: 1
 
default: public
 
 
 
</source>
 
</source>
 +
|-
 +
|
 +
<source lang="bash">
 +
os role delete
 +
    <role>
 +
</source>
 +
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova flavor-create
 
    [--ephemeral <ephemeral>]
 
    [--swap <swap>]
 
    [--rxtx-factor <factor>]
 
    <name>
 
    <id>
 
    <ram>
 
    <disk>
 
    <vcpus>
 
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os delete flavor
+
os role list
    <flavor>
 
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova flavor-delete
 
    <id>
 
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os list flavor
+
os role remove
 +
    [--user <user> | --group <group>]
 +
    [--domain <domain> | --project <project>]
 +
    <role>
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova flavor-list
 
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os show flavor
+
os role set
     <flavor>
+
     [--name <new-role-name>]
 +
    <role>
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
|}
 
 
 
'''floating-ip'''
 
 
 
<source lang="bash">
 
<source lang="bash">
nova add-floating-ip <server> <address>
 
 
os add floating-ip ...
 
 
</source>
 
</source>
 
+
|-
 
+
|
 
<source lang="bash">
 
<source lang="bash">
nova floating-ip-create [<floating_ip_pool>]
+
os role show
 
+
    <role>
os create floating-ip ...
 
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova floating-ip-delete <address>
 
 
os delete floating-ip
 
 
</source>
 
</source>
 +
|}
  
 +
==== service ====
  
 +
{| class="wikitable"
 +
|-
 +
! OSC Command !! Implemented !! !! Keystone command
 +
|-
 +
|
 
<source lang="bash">
 
<source lang="bash">
nova floating-ip-list
+
os service create
 
+
[--name <name>]
os list floating-ip
+
        [--enabled <true|false>]
 +
        <type>
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova remove-floating-ip <server> <address>
+
keystone service-create
 
+
[--name <name>]
os remove floating-ip ...
+
        [--enabled <true|false>]
 +
        <type>
 
</source>
 
</source>
 
+
|-
 
+
|
'''floating-ip-pool'''
 
 
 
 
<source lang="bash">
 
<source lang="bash">
nova floating-ip-pool-list
+
os service delete
 
+
    <service>
os list floating-ip-pool
 
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
'''host'''
 
 
 
 
<source lang="bash">
 
<source lang="bash">
nova host-action [--action <action>] <hostname>
+
keystone service-delete
 
+
    <service_id>
os ?? host ...
 
 
</source>
 
</source>
 
+
|-
 
+
|
 
<source lang="bash">
 
<source lang="bash">
nova host-update [--status <status>]
+
os list service
                [--maintenance <maintenance_mode>]
 
                <hostname>
 
 
 
os set host ...
 
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
'''image'''
 
 
 
 
<source lang="bash">
 
<source lang="bash">
nova image-create [--poll] <server> <name>
+
keystone service-list
 
 
os create image ...
 
 
</source>
 
</source>
 
+
|-
 
+
|
 
<source lang="bash">
 
<source lang="bash">
nova image-delete <image>
+
os service set
 
+
    [--type <service-type>]
os delete image ...
+
    [--name <new-name>]
 +
    [--enable | --disable]
 +
    <service>
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova image-list
+
keystone service-set
 
+
    [--type <service-type>]
os list image
+
    [--name <new-name>]
 +
    [--enable | --disable]
 +
    <service>
 
</source>
 
</source>
 
+
|-
 
+
|
 
<source lang="bash">
 
<source lang="bash">
nova image-meta <image> <action> <key=value> [<key=value> ...]
+
os service show
 
+
    <service>
os set image ...
 
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova image-show <image>
+
keystone service-get
 
+
    <service_id>
os show image ...
 
 
</source>
 
</source>
 +
|}
  
 +
==== user ====
  
'''keypair'''
+
{| class="wikitable"
 
+
|-
 +
! OSC Command !! Implemented !! !! Keystone command
 +
|-
 +
|
 
<source lang="bash">
 
<source lang="bash">
nova keypair-add [--pub_key <pub_key>] <name>
+
os user create
 
+
    [--password <password>]
os create keypair ...
+
    [--project <project>]
 +
    [--email <user-email>]
 +
    [--enable | --disable]
 +
    <name>
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova keypair-delete <name>
+
keystone user-create
 
+
    --name <user-name>  
os delete keypair
+
    [--domain_id <domain-id>]
 +
    [--default_project_id <project-id>]
 +
    [--description <description>]
 +
    [--enabled <true|false>]
 +
    [--password <password>]
 
</source>
 
</source>
 
+
|-
 
+
|
 
<source lang="bash">
 
<source lang="bash">
nova keypair-list
+
os user delete
 
+
    <user>
os list keypair
 
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
'''limits'''
 
 
 
 
<source lang="bash">
 
<source lang="bash">
nova absolute-limits
+
keystone user-delete
 
+
    <user-id>
os show limits --absolute
 
## is there any other kind?
 
 
</source>
 
</source>
 
+
|-
 
+
|
'''quota'''
 
 
 
 
<source lang="bash">
 
<source lang="bash">
nova quota-defaults <tenant_id>
+
os user list
nova quota-show <tenant_id>
+
    [--project <project>]
 
+
    [--long]
os show quota <tenant> [--defaults]
 
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova quota-update [--instances <instances>]
+
keystone user-list
                  [--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">
 
+
os user set
 +
    [--name <new-name>]
 +
    [--password <password>]
 +
    [--project <project>]
 +
    [--email <user-email>]
 +
    [--enable | --disable]
 +
    <user>
 +
</source>
 +
|| yes
 +
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova quota-class-show <class>
+
keystone user-update
 
+
    --user_id <user-id>
os show quota-class ...
+
    [--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">
nova quota-class-update [--instances <instances>]
+
os user show
                        [--cores <cores>]
+
    <user>
                        [--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>
 
+
|| yes
 
+
|| ||
'''rate-limits'''
 
 
 
 
<source lang="bash">
 
<source lang="bash">
nova rate-limits
+
keystone user-get
 
+
    <user-id>
os show rate-limits
 
 
</source>
 
</source>
 +
|}
  
 +
== Compute ==
  
'''resource'''
 
  
<source lang="bash">
+
{| class="wikitable"
nova describe-resource <hostname>
+
|-
 +
! OSC Option !! Environment Variable !! !! Nova Option !! Environment Variable
 +
|-
 +
| || || || --os-auth-system <auth-system> || OS_AUTH_SYSTEM
 +
|-  
 +
| || || || --service-type <type> ||
 +
|-
 +
| || || || --service-name <name> || NOVA_SERVICE_NAME
 +
|-
 +
| || || || --volume-service-name <name> || NOVA_VOLUME_SERVICE_NAME
 +
|-
 +
| || || || --endpoint-type <type> || NOVA_ENDPOINT_TYPE
 +
|-
 +
| --os-compute-api-version <ver> || OS_COMPUTE_API_VERSION || || --os-compute-api-version <ver> || OS_COMPUTE_API_VERSION
 +
|-
 +
| || || || --bypass-url <bypass-url> ||
 +
|}
  
os show resource ...
 
</source>
 
  
 +
=== API v2 (1.1) ===
  
'''secgroup'''
+
==== agent ====
  
 +
{| class="wikitable"
 +
|-
 +
! OSC Command !! Implemented !! !! Nova command
 +
|-
 +
|
 
<source lang="bash">
 
<source lang="bash">
nova secgroup-create <name> <description>
+
os agent create
 
+
    <os>
os create secgroup ...
+
    <architecture>
 +
    <version>
 +
    <url>
 +
    <md5hash>
 +
    <hypervisor>
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
 +
|-
 +
|
 
<source lang="bash">
 
<source lang="bash">
nova secgroup-delete <secgroup>
+
os agent delete
 
+
    <id>
os delete secgroup ...
 
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
 +
|-
 +
|
 
<source lang="bash">
 
<source lang="bash">
nova secgroup-list
+
os agent list  
 
+
    [--hypervisor <hypervisor>]
os list secgroup
 
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
'''secgroup-group-rule'''
+
|-
 
+
|
 
<source lang="bash">
 
<source lang="bash">
nova secgroup-add-group-rule [--ip_proto <ip_proto>]
+
os agent set
                            [--from_port <from_port>]
+
    <id>
                            [--to_port <to_port>]
+
    <version>
                            <secgroup> <source_group>
+
    <url>
 
+
    <md5hash>
os create secgroup-group-rule
 
 
</source>
 
</source>
 +
|| yes
 +
|| ||
 +
|}
  
  
<source lang="bash">
+
==== aggregate ====
nova secgroup-delete-group-rule [--ip_proto <ip_proto>]
 
                                [--from_port <from_port>]
 
                                [--to_port <to_port>]
 
                                <secgroup> <source_group>
 
 
 
os delete secgroup-group-rule ...
 
</source>
 
 
 
 
 
'''secgroup-rule'''
 
  
 +
{| class="wikitable"
 +
|-
 +
! OSC Command !! Implemented !! !! Nova command
 +
|-
 +
|
 +
<source lang="bash">
 +
os aggregate add host
 +
    <aggregate>
 +
    <host>
 +
</source>
 +
|| yes
 +
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova secgroup-add-rule <secgroup> <ip_proto> <from_port> <to_port> <cidr>
+
nova aggregate-add-host
 
+
    <id>
os create secgroup-rule
+
    <host>
 
</source>
 
</source>
 
+
|-
 
+
|
 
<source lang="bash">
 
<source lang="bash">
nova secgroup-delete-rule <secgroup> <ip_proto> <from_port> <to_port> <cidr>
+
os aggregate create
 
+
    [--zone <availability-zone>]
os delete secgroup-rule
+
    [--property <key=value>]
 +
    <name>
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova secgroup-list-rules <secgroup>
+
nova aggregate-create
 
+
    <name>
os list secgroup-rule ...
+
    [<availability_zone>]
 
</source>
 
</source>
 
 
====server====
 
 
{| class="wikitable"
 
|-
 
! OSC Command !! Implemented !! !! Nova command
 
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os create server
+
os aggregate delete
     --image <image>
+
     <aggregate>
    --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>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova boot
+
nova aggregate-delete
    [--flavor <flavor>]
+
     <id>
     [--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>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os delete server
+
os aggregate list
     <server>
+
     [--long]
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova delete
+
nova aggregate-list
    <server>
 
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os list server
+
os aggregate remove host
    [--reservation-id <reservation-id>]
+
     <aggregate>
    [--ip <ip-regex>]
+
     <host>
    [--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
+
nova aggregate-remove-host
    [--reservation_id <reservation_id>]
+
     <id>
     [--ip <ip_regexp>]
+
     <host>
     [--ip6 <ip6_regexp>]
 
    [--name <name_regexp>]
 
    [--instance_name <name_regexp>]
 
    [--status <status>]
 
    [--flavor <flavor>] [--image <image>]
 
    [--host <hostname>]
 
    [--all_tenants [<0|1>]]
 
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os lock server
+
os aggregate set
     <server>
+
     [--name <new-name>]
 +
    [--zone <availability-zone>]
 +
    [--property <key=value>]
 +
    <aggregate>
 
</source>
 
</source>
|| no
+
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova lock
+
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 migrate server
+
os aggregate show
    --live
+
     <aggregate>
    [--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
+
nova aggregate-details
    [--block_migrate]
+
     <id>
    [--disk_over_commit]
+
</source>
     <server>
+
|}
<host>
+
 
 +
==== bash-completion ====
  
nova migrate
+
{| class="wikitable"
    [--poll]
+
|-
    <server>
+
! OSC Command !! Implemented !! !! Nova command
</source>
 
 
|-
 
|-
 
|
 
|
 +
TBD
 +
|| no
 +
|| ||
 
<source lang="bash">
 
<source lang="bash">
os pause server
+
nova bash-completion
    <server>
 
 
</source>
 
</source>
|| yes
+
|}
 +
 
 +
==== cloudpipe ====
 +
 
 +
{| class="wikitable"
 +
|-
 +
! OSC Command !! Implemented !! !! Nova command
 +
|-
 +
|
 +
<source lang="bash">
 +
os create cloudpipe
 +
    <project>
 +
</source>
 +
|| no
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova pause
+
nova cloudpipe-create
     <server>
+
     <project>
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os reboot server
+
os list cloudpipe
    [--hard | --soft]
 
    [--wait]
 
    <server>
 
 
</source>
 
</source>
|| yes
+
|| no
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova reboot
+
nova cloudpipe-list
    [--hard]
 
    [--poll]
 
    <server>
 
 
</source>
 
</source>
 +
|}
 +
 +
==== console ====
 +
 +
{| class="wikitable"
 +
|-
 +
! OSC Command !! Implemented !! !! Nova command
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os rebuild server
+
os console log show
     --image <image>
+
     [--lines <num-lines>]
    [--password <password>]
 
    [--wait]
 
 
     <server>
 
     <server>
 
</source>
 
</source>
Line 1,915: Line 1,938:
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova rebuild
+
nova console-log
     [--rebuild_password <rebuild_password>]
+
     [--length <length>]
    [--poll]
+
     <server>
     <server>
 
    <image>
 
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os rename server
+
os console url show
 +
    [--novnc | --xvpvnc | --spice]
 
     <server>
 
     <server>
    <new-name>
 
 
</source>
 
</source>
|| no
+
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova rename
+
nova get-vnc-console
 
     <server>
 
     <server>
     <name>
+
     <console_type>
 
</source>
 
</source>
 +
|}
 +
 +
==== credentials ====
 +
 +
See [[#credentials|credentials]] in the [[#Cross_API|cross API section]].
 +
 +
==== diagnostics ====
 +
 +
''Consider implementing this as: show server --diagnostics <server>''
 +
{| class="wikitable"
 +
|-
 +
! OSC Command !! Implemented !! !! Nova command
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os rescue server
+
os diagnostics show
 
     <server>
 
     <server>
 
</source>
 
</source>
Line 1,944: Line 1,977:
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova rescue
+
nova diagnostics
 
     <server>
 
     <server>
 
</source>
 
</source>
 +
|}
 +
 +
==== dns ====
 +
 +
''These commands need some attention...an IP shouldn't be required for all record types.  They need to be more DNS-y.  Zone anyone?''
 +
{| class="wikitable"
 +
|-
 +
! OSC Command !! Implemented !! !! Nova command
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os resize server
+
os create dns
     --flavor <flavor>
+
     [--type <type>]
     [--wait]
+
    <ip>
     <server>
+
     <name>
 +
     <domain>
 
</source>
 
</source>
 
|| no
 
|| no
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova resize
+
nova dns-create
     [--poll]
+
     [--type <type>]
     <server>
+
     <ip>
     <flavor>
+
    <name>
 +
     <domain>
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os resize server
+
os delete dns
     --confirm
+
     <domain>
     <server>
+
     <name>
 
</source>
 
</source>
 
|| no
 
|| no
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova resize-confirm
+
nova dns-delete
     <server>
+
     <domain>
 +
    <name>
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os resume server
+
os list dns
     <server>
+
     [--ip <ip>]
 +
    [--name <name>]
 +
    <domain>
 
</source>
 
</source>
|| yes
+
|| no
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova resume
+
nova dns-list
     <server>
+
     [--ip <ip>]
 +
    [--name <name>]
 +
    <domain>
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os set server
+
os create dns-domain
    --meta-data <key=value>
+
     [--project <project>]
     [--meta-data <key=value>] ...
+
     [--availability-zone <availability-zone>]
    <server>
+
     [--public | --private]
os unset server
+
     <domain>
     --meta-data <key>
 
     [--meta-data <key>] ...
 
     <server>
 
 
</source>
 
</source>
 
|| no
 
|| no
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova meta
+
nova dns-create-private-domain
     <server>
+
     [--availability_zone <availability_zone>]
     <action>
+
     <domain>
     <key=value>
+
 
     [<key=value> ...]
+
nova dns-create-public-domain
 +
     [--project <project>]
 +
     <domain>
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os set server
+
os delete dns-domain
    --root-password
+
     <domain>
     <server>
 
 
</source>
 
</source>
 
|| no
 
|| no
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova root-password
+
nova dns-delete-domain
     <server>
+
     <domain>
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os show server
+
os list dns-domains
    <server>
 
 
</source>
 
</source>
|| yes
+
|| no
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova show
+
nova dns-domains
    <server>
 
 
</source>
 
</source>
 +
|}
 +
 +
==== endpoints ====
 +
 +
''Totally duplicates Identity catalog command''
 +
{| class="wikitable"
 +
|-
 +
! OSC Command !! Implemented !! !! Nova command
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os ssh server
+
os endpoint list
    [--port PORT]
 
    --private]
 
    [--ipv6]
 
    [--login <login>]
 
    <server>
 
 
</source>
 
</source>
 
|| no
 
|| no
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova ssh
+
nova endpoints
    [--port PORT]
 
    [--private]
 
    [--ipv6]
 
    [--login <login>]
 
    <server>
 
 
</source>
 
</source>
 +
|}
 +
 +
==== fixed-ip ====
 +
 +
{| class="wikitable"
 +
|-
 +
! OSC Command !! Implemented !! !! Nova command
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os suspend server
+
os ip fixed add
 +
    <network>
 
     <server>
 
     <server>
 
</source>
 
</source>
Line 2,063: Line 2,113:
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova suspend
+
nova add-fixed-ip
 
     <server>
 
     <server>
 +
    <network_id>
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os unlock server
+
os ip fixed remove
 +
    <ip-address>
 
     <server>
 
     <server>
 
</source>
 
</source>
|| no
+
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova unlock
+
nova remove-fixed-ip
 
     <server>
 
     <server>
 +
    <address>
 
</source>
 
</source>
 +
|}
 +
 +
 +
==== flavor ====
 +
 +
{| class="wikitable"
 +
|-
 +
! OSC Command !! Implemented !! !! Nova command
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os unpause server
+
os flavor create
     <server>
+
     [--id <id>]
 +
    [--ram <size-mb>]
 +
    [--disk <size-gb>]
 +
    [--ephemeral-disk <size-gb>]
 +
    [--swap <size-mb>]
 +
    [--vcpus <num-cpu>]
 +
    [--rxtx-factor <factor>]
 +
    [--public | --private]
 +
    <name>
 
</source>
 
</source>
|| yes
+
||
|| ||
 
 
<source lang="bash">
 
<source lang="bash">
nova unpause
+
(partial)
    <server>
+
default: auto
 +
default: 256M
 +
default: 0G
 +
default: 0G
 +
default: 0G
 +
default: 1
 +
default: 1
 +
default: public
 +
 
 
</source>
 
</source>
|-
+
|| ||
|
 
 
<source lang="bash">
 
<source lang="bash">
os unrescue server
+
nova flavor-create
     <server>
+
     [--ephemeral <ephemeral>]
 +
    [--swap <swap>]
 +
    [--rxtx-factor <factor>]
 +
    <name>
 +
    <id>
 +
    <ram>
 +
    <disk>
 +
    <vcpus>
 
</source>
 
</source>
|| no
+
|-
|| ||
+
|
 
<source lang="bash">
 
<source lang="bash">
nova unrescue
+
os flavor delete
     <server>
+
     <flavor>
 
</source>
 
</source>
|}
+
|| yes
 
+
|| ||
 
 
'''usage'''
 
 
 
 
<source lang="bash">
 
<source lang="bash">
nova usage-list [--start <start>] [--end <end>]
+
nova flavor-delete
 
+
    <id>
os list usage ...
 
 
</source>
 
</source>
 
+
|-
 
+
|
'''volume'''
 
 
 
 
<source lang="bash">
 
<source lang="bash">
nova volume-attach <server> <volume> <device>
+
os flavor list
 
 
os attach volume ...
 
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova volume-create [--snapshot_id <snapshot_id>]
+
nova flavor-list
                  [--display_name <display_name>]
 
                  [--display_description <display_description>]
 
                  [--volume_type <volume_type>]
 
                  <size>
 
 
 
os create volume ...
 
 
</source>
 
</source>
 
+
|-
 
+
|
 
<source lang="bash">
 
<source lang="bash">
nova volume-delete <volume>
+
os flavor show
 +
    <flavor>
 +
</source>
 +
|| yes
 +
|| ||
 +
|}
  
os delete volume ...
 
</source>
 
  
 +
==== floating-ip ====
  
 +
{| class="wikitable"
 +
|-
 +
! OSC Command !! Implemented !! !! Nova command
 +
|-
 +
|
 
<source lang="bash">
 
<source lang="bash">
nova volume-detach <server> <volume>
+
os ip floating add
 
+
    <ip-address>
os detach volume ...
+
    <server>
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova nova volume-list
+
nova add-floating-ip
 
+
    <server>
os list volume
+
    <address>
 
</source>
 
</source>
 
+
|-
 
+
|
 
<source lang="bash">
 
<source lang="bash">
nova volume-show <volume>
+
os ip floating create
 
+
    [<pool>]
os show volume ...
 
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
'''volume-snapshot'''
 
 
 
 
<source lang="bash">
 
<source lang="bash">
nova volume-snapshot-create [--force <True|False>]
+
nova floating-ip-create
                            [--display_name <display_name>]
+
    [<floating_ip_pool>]
                            [--display_description <display_description>]
 
                            <volume_id>
 
 
 
os create volume-snapshot ...
 
 
</source>
 
</source>
 
+
|-
 
+
|
 
<source lang="bash">
 
<source lang="bash">
nova volume-snapshot-delete <snapshot_id>
+
os ip floating delete
 
+
    <ip-address>
os delete volume-snapshot ...
 
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova volume-snapshot-list
+
nova floating-ip-delete
 
+
    <address>
os list volume-snapshot
 
 
</source>
 
</source>
 
+
|-
 
+
|
 
<source lang="bash">
 
<source lang="bash">
nova volume-snapshot-show <snapshot>
+
os ip floating list
 
 
os show volume-snapshot
 
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
'''volume-type'''
 
 
 
 
<source lang="bash">
 
<source lang="bash">
nova volume-type-create <name>
+
nova floating-ip-list
 
 
os create volume-type ...
 
 
</source>
 
</source>
 
+
|-
 
+
|
 
<source lang="bash">
 
<source lang="bash">
nova volume-type-delete <id>
+
os ip floating remove
 
+
    <ip-address>
os delete volume-type ...
+
    <server>
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova volume-type-list
+
nova remove-floating-ip
 +
    <server>
 +
    <address>
 +
</source>
 +
|}
  
os list volume-type
 
</source>
 
  
 +
==== floating-ip-pool ====
  
'''x509-cert'''
 
  
 +
{| class="wikitable"
 +
|-
 +
! OSC Command !! Implemented !! !! Nova command
 +
|-
 +
|
 
<source lang="bash">
 
<source lang="bash">
nova x509-create-cert [<private_key_file>] [<x509_cert>]
+
os ip floating pool list
 
 
os create x509-cert ...
 
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
'''x509-root-cert'''
 
 
 
 
<source lang="bash">
 
<source lang="bash">
nova x509-get-root-cert [<filename>]
+
nova floating-ip-pool-list
 
 
os show x509-root-cert ...
 
 
</source>
 
</source>
 +
|}
  
  
== Image ==
+
==== host ====
 
 
  
 
{| class="wikitable"
 
{| class="wikitable"
|-  
+
|-
! Nova Option !! Environment Variable !!   !! OSC Option !!  Environment Variable
+
! OSC Command !! Implemented !! !! Nova command
|-
+
|-
| --force ||  ||  ||  ||
+
|
|-
+
<source lang="bash">
| --dry-run ||  ||  ||  ||
+
os host list
|-
+
    [--zone <availability-zone>]
| --os-image-url <url> || OS_IMAGE_URL ||  ||  ||
+
</source>
|-
+
|| yes
| --os-image-api-version <ver> || OS_IMAGE_API_VERSION ||  || --os-image-api-version <ver> || OS_IMAGE_API_VERSION
+
|| ||
|-
 
| --os-service-type <type> || OS_SERVICE_TYPE ||  ||  ||
 
|-
 
| --os-endpoint-type <type> || OS_ENDPOINT_TYPE ||  ||  ||
 
|-
 
| --cert-file <file> ||  ||  ||  ||
 
|-
 
| --key-file <file> ||  ||  ||  ||
 
|-
 
| --timeout <seconds> ||  ||  ||  ||
 
|-
 
| --no-ssl-compression ||  ||  ||  ||  
 
|}
 
 
 
 
 
=== API v2.0 ===
 
 
 
'''image'''
 
 
 
 
<source lang="bash">
 
<source lang="bash">
glance image-create [--id <IMAGE_ID>] [--name <NAME>]
+
nova host-action
                                  [--disk-format <CONTAINER_FORMAT>]
+
    [--action <action>]
                                  [--container-format <DISK_FORMAT>]
+
    <hostname>
                                  [--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>
 
+
|-
 
+
|
 
<source lang="bash">
 
<source lang="bash">
glance image-delete <IMAGE_ID>
+
os host set
 
+
    ...
os delete image ...
 
 
</source>
 
</source>
 
+
|| no
 
+
|| ||
 
<source lang="bash">
 
<source lang="bash">
glance image-list
+
nova host-update
 
+
    [--status <status>]
os list image ...
+
    [--maintenance <maintenance_mode>]
 +
    <hostname>
 
</source>
 
</source>
 
+
|-
 
+
|
 
<source lang="bash">
 
<source lang="bash">
glance image-show <IMAGE_ID>
+
os host show
 
+
    <host>
os show image ...
 
 
</source>
 
</source>
 +
|| yes
 +
|| ||
 +
|}
  
  
<source lang="bash">
+
==== hypervisor ====
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 hypervisor list
 
+
    [--matching <hostname>]
os show image ...
 
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
 +
|-
 +
|
 
<source lang="bash">
 
<source lang="bash">
glance update [options] <ID> <field1=value1 field2=value2 ...>
+
os hypervisor show
 
+
    <id>
os set image ...
 
 
</source>
 
</source>
 +
|| yes
 +
|| ||
 +
|}
  
  
'''image-member'''
+
==== keypair ====
  
 +
{| class="wikitable"
 +
|-
 +
! OSC Command !! Implemented !! !! Nova command
 +
|-
 +
|
 
<source lang="bash">
 
<source lang="bash">
glance member-create [--can-share] <IMAGE_ID> <TENANT_ID>
+
os keypair create
 
+
    [--public-key <file>]
os create image-member ...
+
    <name>
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
 +
<source lang="bash">
 +
nova keypair-add
 +
    [--pub_key <pub_key>]
 +
    <name>
 +
</source>
 +
|-
 +
|
 
<source lang="bash">
 
<source lang="bash">
glance member-delete <IMAGE_ID> <TENANT_ID>
+
os keypair delete
 
+
    <name>
os list image-member <image> [options]
 
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
 
<source lang="bash">
 
<source lang="bash">
glance member-delete [options] <ID> <MEMBER>
+
nova keypair-delete
 
+
    <name>
os delete image-member ...
 
 
</source>
 
</source>
 
+
|-
 
+
|
 
<source lang="bash">
 
<source lang="bash">
glance member-list [--image-id <IMAGE_ID>] [--tenant-id <TENANT_ID>]
+
os keypair list
 
 
os list image-member ...
 
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
== Volume ==
+
<source lang="bash">
 
+
nova keypair-list
 
+
</source>
{| class="wikitable"
+
|-
|-
+
|
! Cinder Option !!  Environment Variable !!  !!  OSC Option !!  Environment Variable
+
<source lang="bash">
|-
+
os keypair show
| --os-volume-api-version <ver> || OS_VOLUME_API_VERSION ||  || --os-volume-api-version <ver> || OS_VOLUME_API_VERSION
+
    [--public-key]
|-  
+
    <name>
| --service-type <type> ||  ||  ||  ||
+
</source>
|-  
+
|| yes
| --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 ====
  
'''credentials'''
+
See [[#limits|limits]] in the [[#Cross_API|cross API section]].
  
<source lang="bash">
+
==== quota ====
cinder credentials
 
  
os list credential
+
See [[#quota|quota]] in the [[#Cross_API|cross API section]].
</source>
 
  
'''limits'''
 
 
<source lang="bash">
 
cinder rate-limits
 
 
os list limit --rate
 
</source>
 
  
 +
==== resource ====
  
 +
{| class="wikitable"
 +
|-
 +
! OSC Command !! Implemented !! !! Nova command
 +
|-
 +
|
 
<source lang="bash">
 
<source lang="bash">
cinder absolute-limits
+
os show resource
 
+
    <hostname>
os list limit --absolute
 
 
</source>
 
</source>
 
+
|| no
'''snapshot'''
+
|| ||
 
 
 
<source lang="bash">
 
<source lang="bash">
cinder snapshot-create
+
nova describe-resource
<volume-id>
+
    <hostname>
--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>
 +
|}
  
 +
==== secgroup ====
  
 +
{| class="wikitable"
 +
|-
 +
! OSC Command !! Implemented !! !! Nova command
 +
|-
 +
|
 
<source lang="bash">
 
<source lang="bash">
cinder snapshot-delete <snapshot-id>
+
os secgroup add
  
os delete snapshot <snapshot-id>
+
(see server add secgroup)
 
</source>
 
</source>
 
+
|| no
 
+
|| ||
 
<source lang="bash">
 
<source lang="bash">
cinder snapshot-list
+
nova add-secgroup
--all-tenants [<0|1>]
+
    <server>
--display-name <display-name>
+
    <secgroup>
--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 secgroup create
--display-description <display-description>
+
    [--description <description>]
<snapshot-id>
+
    <name>
<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 secgroup-create
 
+
    <name>
os show snapshot <snapshot-id>
+
    <description>
 
</source>
 
</source>
 
+
|-
'''type'''
+
|
 
 
 
<source lang="bash">
 
<source lang="bash">
cinder type-create <type-name>
+
os secgroup delete
 
+
    <group>
os create type <type-name>
 
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
 
<source lang="bash">
 
<source lang="bash">
cinder type-delete <type-id>
+
nova secgroup-delete
 
+
    <secgroup>
os delete type <type>
 
 
</source>
 
</source>
 
+
|-
 
+
|
 
<source lang="bash">
 
<source lang="bash">
cinder type-list
+
os secgroup list
 
+
    [--all-projects]
os list type
 
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
 
<source lang="bash">
 
<source lang="bash">
cinder extra-specs-list
+
nova secgroup-list
 
+
    [--all-tenants [<0|1>]]
os tbd
 
 
</source>
 
</source>
 
+
|-
 
+
|
 
<source lang="bash">
 
<source lang="bash">
cinder type-key <type-name-or-id> <action (set|unset)> <key=value>
+
os secgroup remove
  
os tbd
+
(see server remove secgroup)
 +
</source>
 +
|| no
 +
|| ||
 +
<source lang="bash">
 +
nova remove-secgroup
 +
    <server>
 +
    <secgroup>
 
</source>
 
</source>
 
 
==== volume ====
 
 
{| class="wikitable"
 
|-
 
! OSC Command !! Implemented !! !! Nova command
 
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os create volume
+
os secgroup set
     [--name <name>]
+
     [--name <new-name>]
     [--description <description>]
+
     [--description [<new-description>]
    [--volume-type <volume-type>]
+
     <group>
    [--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 secgroup-update
    [--snapshot-id <snapshot-id>]
+
     <secgroup>
    [--source-volid <source-volid>]
+
     <name>
     [--image-id <image-id>]
+
     <description>
     [--display-name <display-name>]
 
     [--display-description <display-description>]
 
    [--volume-type <volume-type>]
 
    [--availability-zone <availability-zone>]
 
    [--metadata [<key=value>]]
 
    <size>
 
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os delete volume
+
os secgroup show
     <volume>
+
     <group>
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
cinder delete
+
n/a
    <volume-id>
 
 
</source>
 
</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">
 
<source lang="bash">
os list volume
+
os secgroup rule create
     --long
+
     [--proto <proto>]
 +
    [--src-ip <ip-address>]
 +
    [--dst-port <port-range>]
 +
    <group>
 
</source>
 
</source>
|| yes (no opts yet)
+
|| no
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
cinder list
+
nova secgroup-add-rule
     --all-tenants [<0|1>]
+
    <secgroup>
     --display-name <display-name>
+
    <ip_proto>
     --status <status>
+
     <from_port>
 +
     <to_port>
 +
     <cidr>
 
</source>
 
</source>
 
|-
 
|-
|
+
|
<source lang="bash">
+
<source lang="bash">
os set volume
+
os secgroup rule delete
     --name <new-name>
+
    [--proto <proto>]
     --description <description>
+
    [--src-ip <ip-address>]
     <volume>
+
    [--dst-port <port-range>]
</source>
+
    <group>
|| yes
+
</source>
|| ||
+
|| no
<source lang="bash">
+
|| ||
cinder rename
+
<source lang="bash">
     --display-description <display-description>
+
nova secgroup-delete-rule
     <volume-id>
+
    <secgroup>
     <display-name>
+
    <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,761: Line 3,863:
 
set port <tenant> <network> <port> <params>
 
set port <tenant> <network> <port> <params>
 
</source>
 
</source>
 
  
 
= Options =
 
= Options =

Latest revision as of 02:10, 19 July 2013

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

OpenStackClient Commands

Part of the UnifiedCLI proposal

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

Command Structure

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

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

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


Command Arguments

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

Other

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

Verbs

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

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


Objects

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


Global Options

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

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


Common Options

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

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


Command Mapping Summary

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

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


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


Cross API

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

credentials

[consider rolling the ec2 creds into this too]

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

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

limits

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

nova rate-limits

cinder absolute-limits

cinder rate-limits

quota

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

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

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

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

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

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

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

cinder quota-show
    <tenant_id>

nova quota-defaults
    <tenant_id>

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

cinder quota-class-show
    <class>

Identity

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

API v2.0

catalog

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

ec2 credentials

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

endpoint

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

role

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

service

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

tenant

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

token

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

user

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

user role

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

<other>

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

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

API v3

credential

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

domain

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

endpoint

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

group

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

oauth

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

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

policy

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

project

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

role

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

service

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

user

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

Compute

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


API v2 (1.1)

agent

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


aggregate

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

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

bash-completion

OSC Command Implemented Nova command

TBD

no
nova bash-completion

cloudpipe

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

console

OSC Command Implemented Nova command
os