Jump to: navigation, search

Difference between revisions of "UnifiedCLI/Mapping"

(quota)
(Redirected page to OpenStackClient/Commands)
 
(72 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 14: Line 17:
 
* The top level command name is <code>openstack</code>
 
* The top level command name is <code>openstack</code>
 
* Sub-commands take the form:
 
* Sub-commands take the form:
  <code>openstack [<global-options>] <verb> <object> [<command-local-arguments>]</code>
+
  <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 ==
 
== Command Arguments ==
Line 21: Line 26:
 
* Authentication options conform to [[/Authentication| a revised version of]] the original [[CLIAuth]]
 
* 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.
 
* 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 will appear in the command object and both positional arguments appear in the same order as in the command object.
+
* 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 ==
Line 27: Line 42:
 
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.
 
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 51: 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"
Line 91: Line 156:
 
| --os-use-keyring ||  || ||  ||
 
| --os-use-keyring ||  || ||  ||
 
|}
 
|}
 +
  
 
== Common Options ==
 
== Common Options ==
Line 106: 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 124: Line 191:
  
  
== Identity ==
+
== Cross API ==
  
 +
Object names that appear in multiple APIs, like quota, are handled by putting their command handler classes in openstackclient.common.  If the number of these becomes large they should be moved into a subdirectory.
  
{| class="wikitable"
+
==== credentials ====
|-
 
! 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====
+
''[consider rolling the ec2 creds into this too]''
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 160: 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 180: 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>
|| in progress
+
|| 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>]
  
## what changes if --user is not provided?
+
    # Volume settings
</source>
+
    [--gigabytes <new-gigabytes>]
|| in progress
+
    [--snapshots <new-snapshots>]
 +
    [--volumes <new-volumes>]
 +
 
 +
    <project>
 +
</source>
 +
|| 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>
|| in progress
+
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone ec2-credentials-list
+
nova quota-class-update
     [--user <user-id>]
+
     [--instances <instances>]
</source>
+
    [--cores <cores>]
 +
    [--ram <ram>]
 +
    [--volumes <volumes>]
 +
    [--gigabytes <gigabytes>]
 +
    [--floating-ips <floating_ips>]
 +
    [--metadata-items <metadata_items>]
 +
    [--injected-files <injected_files>]
 +
    [--injected-file-content-bytes <injected_file_content_bytes>]
 +
    <class>
 +
 
 +
cinder quota-class-update
 +
    [--volumes <volumes>]
 +
    [--snapshots <snapshots>]
 +
    [--gigabytes <gigabytes>]
 +
    <tenant_id>
 +
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os show ec2-credentials
+
os quota show
     <access-key>
+
    [--default]
 
+
     <project>
## what changes if --user is not provided?
 
 
</source>
 
</source>
|| in progress
+
|| 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>]
 
    [--internalurl <internal-url>]
 
     <service>
 
 
</source>
 
</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>
|-
+
|}
|
+
 
<source lang="bash">
+
== Identity ==
os delete endpoint
+
 
    <endpoint-id>
+
{| class="wikitable"
</source>
+
|-  
|| yes
+
! OSC Option !!  Environment Variable !!  !!  Keystone Option !!  Environment Variable
|| ||
+
|-
<source lang="bash">
+
| --os-identity-api-version <ver> || OS_IDENTITY_API_VERSION ||  || --os-identity-api-version <ver> || OS_IDENTITY_API_VERSION
keystone endpoint-delete
+
|-
    <endpoint-id>
+
| --os-token <token> || OS_TOKEN || || --os-token <token> || OS_SERVICE_TOKEN
</source>
+
|-
|-
+
| --os-url <url> || OS_URL || || --os-endpoint <url> || OS_SERVICE_ENDPOINT
 +
|-
 +
|  ||  || || --os-cert <file> || OS_CERT
 +
|-
 +
|  ||  || || --os-key <key-file> || OS_KEY
 +
|-
 +
|  ||  || || --os-cache || OS_CACHE
 +
|-
 +
| || || || --force-new-token ||
 +
|-
 +
|  ||  || || --stale-duration <seconds> ||
 +
|-
 +
|}
 +
 
 +
=== API v2.0 ===
 +
 
 +
==== catalog ====
 +
 
 +
{| class="wikitable"
 +
|-
 +
! OSC Command !! Implemented !! !! Keystone command
 +
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os list endpoint
+
os catalog show
     [--long]
+
     [--service <service>]
 
</source>
 
</source>
|| yes
+
|| no
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone endpoint-list
+
keystone catalog
 +
    [--service <service-type>]
 
</source>
 
</source>
 +
|}
 +
 +
==== ec2 credentials ====
 +
 +
{| class="wikitable"
 +
|-
 +
! OSC Command !! Implemented !! !! Keystone command
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os show endpoint
+
os ec2 credentials create
     [--type <endpoint-type>]
+
     [--project <project>]
     [--attr <endpoint-attribute>]  
+
     [--user <user>]
    [--value <endpoint-value>]
+
</source>
    [--all]
 
    <service>
 
</source>
 
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone endpoint-get
+
keystone ec2-credentials-create
    --service <service-type>
+
     [--user <user-id>]  
     [--endpoint_type <endpoint-type>]
+
     [--tenant_id <tenant-id>]
     [--attr <service-attribute>]
 
    [--value <value>]
 
 
</source>
 
</source>
|}
 
 
 
====role====
 
 
{| class="wikitable"
 
|-
 
! OSC Command !! Implemented !! !! Keystone command
 
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os create role
+
os ec2 credentials delete
     <role-name>
+
    [--user <user>]
 +
     <access-key>
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone role-create --name
+
keystone ec2-credentials-delete
     <role-name>
+
    [--user <user-id>]
 +
     --access <access-key>
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os delete role
+
os ec2 credentials list
     <role>
+
     [--user <user>]
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone role-delete
+
keystone ec2-credentials-list
     <role-id>
+
     [--user <user-id>]
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os list role
+
os ec2 credentials show
 +
    [--user <user>]
 +
    <access-key>
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone role-list
+
keystone ec2-credentials-get
</source>
+
    [--user <user-id>]
|-
+
     --access <access-key>
|
 
<source lang="bash">
 
os show role
 
     <role>
 
</source>
 
|| yes
 
|| ||
 
<source lang="bash">
 
keystone role-get
 
    <role-id>
 
 
</source>
 
</source>
 
|}
 
|}
  
 
+
==== endpoint ====
====service====
 
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 369: Line 507:
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os create service
+
os endpoint create
     [--type <service-type>]
+
    --publicurl <public-url>
     [--description <service-description>]
+
    [--adminurl <admin-url>]
     <service-name>
+
     [--internalurl <internal-url>]
 +
     [--region <endpoint-region>]
 +
     <service>
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone service-create
+
keystone endpoint-create
     --name <name>  
+
    [--region <endpoint-region>]
     --type <type>
+
    [--service_id <service-id>]
     [--description <service-description>]
+
     [--publicurl <public-url>]
 +
     [--adminurl <admin-url>]
 +
     [--internalurl <internal-url>]
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os delete service
+
os endpoint delete
     <service>
+
     <endpoint-id>
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone service-delete
+
keystone endpoint-delete
     <service-id>
+
     <endpoint-id>
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os list service [--long]
+
os endpoint list
 +
    [--long]
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone service-list
+
keystone endpoint-list
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os show 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-get
+
keystone endpoint-get
     <service-id>
+
    --service <service-type>
 +
    [--endpoint_type <endpoint-type>]
 +
     [--attr <service-attribute>]
 +
    [--value <value>]
 
</source>
 
</source>
 
|}
 
|}
  
 
+
==== role ====
====tenant====
 
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 427: Line 576:
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os create tenant
+
os role create
     [--description <tenant-description>]
+
     <role-name>
    [--enable | --disable]
 
    <tenant-name>
 
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone tenant-create
+
keystone role-create --name
    --name <tenant-name>
+
     <role-name>
     [--description <tenant-description>]
 
    [--enabled <true|false>]
 
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os delete tenant
+
os role delete
     <tenant>
+
     <role>
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone tenant-delete
+
keystone role-delete
     <tenant-id>
+
     <role-id>
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os list tenant
+
os role list
    [--long]
 
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone tenant-list
+
keystone role-list
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os set tenant
+
os role show
     [--name <new-tenant-name>]
+
     <role>
    [--description <new-tenant-description>]
+
</source>
    [--enable | --disable]
 
    <tenant>
 
</source>
 
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone tenant-update
+
keystone role-get
    [--name <tenant_name>]
+
     <role-id>
    [--description <tenant-description>]
 
    [--enabled <true|false>]
 
     <tenant-id>
 
 
</source>
 
</source>
 +
|}
 +
 +
==== service ====
 +
 +
{| class="wikitable"
 +
|-
 +
! OSC Command !! Implemented !! !! Keystone command
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os show tenant
+
os service create
     <tenant>
+
     [--type <service-type>]
 +
    [--description <service-description>]
 +
    <service-name>
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone tenant-get
+
keystone service-create
     <tenant-id>
+
     --name <name>
 +
    --type <type>
 +
    [--description <service-description>]
 
</source>
 
</source>
|}
 
 
 
==== token ====
 
 
{| class="wikitable"
 
|-
 
! OSC Command !! Implemented !! !! Keystone command
 
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os show token
+
os service delete
     [--width <token-display-width>]
+
     <service>
 
</source>
 
</source>
|| ??
+
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone token-get [--wrap <integer>]
+
keystone service-delete
 +
    <service-id>
 
</source>
 
</source>
|}
 
 
 
====user====
 
 
{| class="wikitable"
 
|-
 
! OSC Command !! Implemented !! !! Keystone command
 
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os create user
+
os service list
     [--password <user-password>]
+
     [--long]
    [--email <user-email>]
 
    [--tenant <tenant>]
 
    [--enable | --disable]
 
    <user-name>
 
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone user-create
+
keystone service-list
    --name <user-name>
 
    [--tenant_id <tenant-id>]
 
    [--pass <pass>]
 
    [--email <email>]
 
    [--enabled <true|false>]
 
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os delete user
+
os service show
     <user>
+
    [--catalog]
 +
     <service>
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone user-delete
+
keystone service-get
     <user-id>
+
     <service-id>
 
</source>
 
</source>
 +
|}
 +
 +
==== tenant ====
 +
 +
{| class="wikitable"
 +
|-
 +
! OSC Command !! Implemented !! !! Keystone command
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os list user
+
os tenant create
     [--tenant <tenant>]
+
     [--description <description>]
     [--long]
+
     [--enable | --disable]
 +
    <tenant-name>
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone user-list
+
keystone tenant-create
     [<tenant-id>]
+
    --name <tenant-name>
 +
     [--description <tenant-description>]
 +
    [--enabled <true|false>]
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os set user
+
os tenant delete
    [--name <new-user-name>]
+
     <tenant>
    [--password <user-password>]
 
    [--email <user-email>]
 
     [--tenant <tenant>]
 
    [--enable|--disable]
 
    <user>
 
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone user-password-update
+
keystone tenant-delete
     --pass <password>
+
     <tenant>
    <user-id>
 
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os show user
+
os tenant list
     <user>
+
     [--long]
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone user-get
+
keystone tenant-list
    <user-id>
 
 
</source>
 
</source>
|}
 
 
 
====user-role====
 
 
{| class="wikitable"
 
|-
 
! OSC Command !! Implemented !! !! Keystone command
 
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os add role-user
+
os tenant set
     [--tenant <tenant>]
+
     [--name <new-tenant-name>]
     <role> <user>
+
     [--description <new-tenant-description>]
 +
    [--enable | --disable]
 +
    <tenant>
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone user-role-add
+
keystone tenant-update
     --user <user-id>
+
     [--name <tenant_name>]
     --role <role-id>
+
     [--description <tenant-description>]
     [--tenant_id <tenant-id>]
+
     [--enabled <true|false>]
 +
    <tenant-id>
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os list role-user
+
os tenant show
     [--tenant <tenant>]
+
     <tenant>
    [<user>]
 
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone user-role-list
+
keystone tenant-get
    [--user <user-id>]
+
     <tenant-id>
     [--tenant_id <tenant-id>]
 
 
</source>
 
</source>
 +
|}
 +
 +
==== token ====
 +
 +
{| class="wikitable"
 +
|-
 +
! OSC Command !! Implemented !! !! Keystone command
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os remove 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-remove
+
keystone token-get [--wrap <integer>]
    --user <user-id>
 
    --role <role-id>
 
    [--tenant_id <tenant-id>]
 
 
</source>
 
</source>
 
|}
 
|}
  
 +
==== user ====
  
====<other>====
+
{| class="wikitable"
 
+
|-
 +
! OSC Command !! Implemented !! !! Keystone command
 +
|-
 +
|
 
<source lang="bash">
 
<source lang="bash">
keystone bootstrap
+
os user create
        --pass <password>
+
    [--password <user-password>]
        [--user-name <user-name>]
+
    [--email <user-email>]
        [--role-name <role-name>]
+
    [--tenant <tenant>]
        [--tenant-name <tenant-name>]
+
    [--enable | --disable]
 
+
    <user-name>
## do not create in openstackclient, since it is in contribute
 
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
 
 
 
<source lang="bash">
 
<source lang="bash">
keystone discover
+
keystone user-create
 
+
    --name <user-name>
## do not create in openstackclient, obsolete.
+
    [--tenant_id <tenant-id>]
 +
    [--pass <pass>]
 +
    [--email <email>]
 +
    [--enabled <true|false>]
 
</source>
 
</source>
 
=== API v3 ===
 
 
====credential====
 
 
{| class="wikitable"
 
|-
 
! OSC Command !! Implemented !! !! Keystone command
 
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os create credential
+
os user delete
    [--project <project>]
 
    [--type ec2|cert]
 
 
     <user>
 
     <user>
    <data>
 
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone credential-create
+
keystone user-delete
     --user_id <user-id>
+
     <user-id>
    --type <credential-type>
 
    --data <credential-data>
 
    [--project_id <project-id>]
 
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os delete credential
+
os user list
     <credential-id>
+
     [--tenant <tenant>]
 +
    [--long]
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone credential-delete
+
keystone user-list
     <credential-id>
+
     [<tenant-id>]
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os list credential
+
os user set
 +
    [--name <new-user-name>]
 +
    [--password <user-password>]
 +
    [--email <user-email>]
 +
    [--tenant <tenant>]
 +
    [--enable|--disable]
 +
    <user>
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone credential-list
+
keystone user-password-update
 +
    --pass <password>
 +
    <user-id>
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os set credential
+
os user show
     [--user <user>]
+
     <user>
    [--type ec2|cert]
 
    [--data <data>]
 
    [--project <project>]
 
    <credential-id>
 
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone credential-update
+
keystone user-get
     [--user <user>]
+
     <user-id>
    [--type <type>]
 
    [--data <data>]
 
    [--project <project>]
 
    <credential-id>
 
 
</source>
 
</source>
 +
|}
 +
 +
==== user role ====
 +
 +
{| class="wikitable"
 +
|-
 +
! OSC Command !! Implemented !! !! Keystone command
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os show credential
+
os user role add
     <credential-id>
+
     [--tenant <tenant>]
 +
    <user>
 +
    <role>
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone credential-get
+
keystone user-role-add
     <credential-id>
+
    --user <user-id>
 +
     --role <role-id>
 +
    [--tenant_id <tenant-id>]
 
</source>
 
</source>
|}
 
 
====domain====
 
 
{| class="wikitable"
 
|-
 
! OSC Command !! Implemented !! !! Keystone command
 
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os create domain
+
os user role list
     [--description <domain-description>]
+
     [--tenant <tenant>]
     [--enable | --disable]
+
     [<user>]
    <domain-name>
 
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone domain-create
+
keystone user-role-list
    --name <domain-name>
+
     [--user <user-id>]
     [--description <domain-description>]
+
     [--tenant_id <tenant-id>]
     [--enabled <true|false>]
 
    [--private_project_names <true|false>]
 
    [--private_user_names <true|false>]
 
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os delete domain
+
os user role remove
     <domain>
+
     [--tenant <tenant>]
 +
    <user>
 +
    <role>
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone domain-delete
+
keystone user-role-remove
     <domain-id>
+
    --user <user-id>
 +
     --role <role-id>
 +
    [--tenant_id <tenant-id>]
 
</source>
 
</source>
|-
+
|}
|
+
 
 +
==== <other> ====
 +
 
 +
These keystone commands are not planned for re-implementation in OpenStackClient
 +
 
 
<source lang="bash">
 
<source lang="bash">
os list domain
+
keystone bootstrap
 +
        --pass <password>
 +
        [--user-name <user-name>]
 +
        [--role-name <role-name>]
 +
        [--tenant-name <tenant-name>]
 
</source>
 
</source>
|| yes
+
 
|| ||
 
 
<source lang="bash">
 
<source lang="bash">
keystone domain-list
+
keystone discover
 
</source>
 
</source>
 +
 +
=== API v3 ===
 +
 +
==== credential ====
 +
 +
{| class="wikitable"
 +
|-
 +
! OSC Command !! Implemented !! !! Keystone command
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os set domain
+
os credential create
     [--name <new-domain-name>]
+
     [--project <project>]
     [--description <new-domain-description>]
+
     [--type ec2|cert]
     [--enable | --disable]
+
     <user>
     <domain>
+
     <data>
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone domain-update
+
keystone credential-create
     [--name <domain_name>]
+
     --user_id <user-id>
     [--description <domain-description>]
+
     --type <credential-type>
     [--enabled <true|false>]
+
     --data <credential-data>
    [--private_project_names <true|false>]
+
     [--project_id <project-id>]
     [--private_user_names <true|false>]
 
    <domain-id>
 
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os show domain
+
os credential delete
     <domain>
+
     <credential-id>
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone domain-get
+
keystone credential-delete
     <domain-id>
+
     <credential-id>
 
</source>
 
</source>
|}
 
 
==== endpoint ====
 
 
{| class="wikitable"
 
|-
 
! OSC Command !! Implemented !! !! Keystone command
 
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os create endpoint
+
os credential list
    [--region <endpoint-region>
 
    [--enable | --disable]
 
    <service>
 
    <interface admin|public|internal>
 
    <url>
 
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone endpoint-create
+
keystone credential-list
    [--region <endpoint-region>
 
    [--enable | --disable]
 
    <service_id>
 
    <interface admin|public|internal>
 
    <url>
 
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os delete endpoint
+
os credential set
     <endpoint-id>
+
     [--user <user>]
</source>
+
    [--type ec2|cert]
 +
    [--data <data>]
 +
    [--project <project>]
 +
    <credential-id>
 +
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
 +
keystone credential-update
 +
    [--user <user>]
 +
    [--type <type>]
 +
    [--data <data>]
 +
    [--project <project>]
 +
    <credential-id>
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os list endpoint
+
os credential show
     [--long]
+
     <credential-id>
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone endpoint-list
+
keystone credential-get
 +
    <credential-id>
 
</source>
 
</source>
 +
|}
 +
 +
==== domain ====
 +
 +
{| class="wikitable"
 +
|-
 +
! OSC Command !! Implemented !! !! Keystone command
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os set endpoint
+
os domain create
     [--interface <endpoint-interface>]
+
     [--description <domain-description>]
    [--url <endpoint-url>]
 
    [--service <service-id>]
 
    [--region <endpoint-region>]
 
 
     [--enable | --disable]
 
     [--enable | --disable]
     <endpoint>
+
     <domain-name>
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone endpoint-set
+
keystone domain-create
     [--interface <endpoint-interface>]
+
     --name <domain-name>
     [--url <endpoint-url>]
+
     [--description <domain-description>]
     [--service <service-id>]
+
     [--enabled <true|false>]
     [--region <endpoint-region>]
+
     [--private_project_names <true|false>]
     [--enable | --disable]
+
     [--private_user_names <true|false>]
    <endpoint>
 
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os show endpoint
+
os domain delete
     <endpoint>
+
     <domain>
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone endpoint-get
+
keystone domain-delete
     <endpoint>
+
     <domain-id>
 
</source>
 
</source>
|}
 
 
====group====
 
 
{| class="wikitable"
 
|-
 
! OSC Command !! Implemented !! !! Keystone command
 
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os create group
+
os domain list
    [--domain <domain>]
 
    [--description <group-description>]
 
    <group-name>
 
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone group-create
+
keystone domain-list
    --name <group-name>
 
    [--domain_id <domain-id>]
 
    [--description <group-description>]
 
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os delete group
+
os domain set
     <group>
+
     [--name <new-domain-name>]
 +
    [--description <new-domain-description>]
 +
    [--enable | --disable]
 +
    <domain>
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone group-delete
+
keystone domain-update
     <group-id>
+
    [--name <domain_name>]
 +
    [--description <domain-description>]
 +
    [--enabled <true|false>]
 +
    [--private_project_names <true|false>]
 +
    [--private_user_names <true|false>]
 +
     <domain-id>
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os list group
+
os domain show
     [--long]
+
     <domain>
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone group-list
+
keystone domain-get
 +
    <domain-id>
 
</source>
 
</source>
 +
|}
 +
 +
==== endpoint ====
 +
 +
{| class="wikitable"
 +
|-
 +
! OSC Command !! Implemented !! !! Keystone command
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os set group
+
os endpoint create
     [--name <new-group-name>]
+
     [--region <endpoint-region>
     [--domain <domain>]
+
     [--enable | --disable]
     [--description <new-group-description>]
+
    <service>
     <group>
+
     <interface admin|public|internal>
 +
     <url>
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone group-update
+
keystone endpoint-create
     [--name <group_name>]
+
     [--region <endpoint-region>
     [--domain_id <domain-id>]
+
     [--enable | --disable]
     [--description <group-description>]
+
    <service_id>
     <group-id>
+
     <interface admin|public|internal>
 +
     <url>
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os show group
+
os endpoint delete
     <group>
+
     <endpoint-id>
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone group-get
 
    <group-id>
 
 
</source>
 
</source>
|}
+
|-
 
+
|
====policy====
 
 
 
{| class="wikitable"
 
|-
 
! OSC Command !! Implemented !! !! Keystone command
 
|-
 
|
 
 
<source lang="bash">
 
<source lang="bash">
os create policy
+
os endpoint list
     [--type <policy-type>]
+
     [--long]
    --blob-file <blob-file>
 
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone policy-create
+
keystone endpoint-list
    --type <policy-type>
 
    --blob <policy-blob>
 
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os delete policy
+
os endpoint set
     <policy-id>
+
     [--interface <endpoint-interface>]
 +
    [--url <endpoint-url>]
 +
    [--service <service-id>]
 +
    [--region <endpoint-region>]
 +
    [--enable | --disable]
 +
    <endpoint>
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone policy-delete
+
keystone endpoint-set
     <policy-id>
+
     [--interface <endpoint-interface>]
 +
    [--url <endpoint-url>]
 +
    [--service <service-id>]
 +
    [--region <endpoint-region>]
 +
    [--enable | --disable]
 +
    <endpoint>
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os list policy
+
os endpoint show
     [--include-blob]
+
     <endpoint>
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone policy-list
+
keystone endpoint-get
 +
    <endpoint>
 
</source>
 
</source>
|-
+
|}
 +
 
 +
==== group ====
 +
 
 +
{| class="wikitable"
 +
|-
 +
! OSC Command !! Implemented !! !! Keystone command
 +
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os set policy
+
os group create
     [--type <policy-type>]
+
     [--domain <domain>]
     [--blob-file<blob-file>]
+
     [--description <group-description>]
     <policy-id>
+
     <group-name>
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone policy-update
+
keystone group-create
     [--type <policy-type>]
+
     --name <group-name>
     [--blob <policy-blob>]
+
     [--domain_id <domain-id>]
     <policy-id>
+
     [--description <group-description>]
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os show policy
+
os group delete
     <policy-id>
+
     <group>
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone policy-get
+
keystone group-delete
     <policy-id>
+
     <group-id>
 
</source>
 
</source>
|}
 
 
====project====
 
 
{| class="wikitable"
 
|-
 
! OSC Command !! Implemented !! !! Keystone command
 
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os create project
+
os group list
     [--domain <project-domain>]
+
     [--long]
    [--description <project-description>]
 
    [--enable | --disable]
 
    <project-name>
 
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone project-create
+
keystone group-list
    [--domain_id <domain_id>]
 
    [--description <description>]
 
    [--enable | --disable]
 
    <name>
 
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os delete project
+
os group set
     <project>
+
     [--name <new-group-name>]
 +
    [--domain <domain>]
 +
    [--description <new-group-description>]
 +
    <group>
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
os project-delete
+
keystone group-update
     <project_id>
+
     [--name <group_name>]
 +
    [--domain_id <domain-id>]
 +
    [--description <group-description>]
 +
    <group-id>
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os list project [--long]
+
os group show
 +
    <group>
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone project-list
+
keystone group-get
 +
    <group-id>
 
</source>
 
</source>
 +
|}
 +
 +
==== oauth ====
 +
 +
{| class="wikitable"
 +
|-
 +
! OSC Command !! Implemented !! !! Keystone command
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os set project
+
os access token create
     [--name <new-project-name>]
+
     --consumer-key <consumer-key>
     [--domain <project-domain>]
+
     --consumer-secret <consumer-secret>
     [--description <new-project-description>]
+
     --request-key <request-key>
     [--enable | --disable]
+
     --request-secret <request-secret>
     <project>
+
     --verifier <pin>
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone project-set
+
n/a
    [--name <new-project-name>]
 
    [--domain <project-domain>]
 
    [--description <new-project-description>]
 
    [--enable | --disable]
 
    <project_id>
 
 
</source>
 
</source>
 +
|-
 +
| look at some alternatives: || || ||
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os show project
+
os oauth token create
     <project>
+
     --consumer-key <consumer-key>
 +
    --consumer-secret <consumer-secret>
 +
    --request-key <request-key>
 +
    --request-secret <request-secret>
 +
    --verifier <pin>
 +
</source>
 +
|| nyet
 +
|| ||
 +
<source lang="bash">
 +
* makes the token specific to oauth
 +
* add [--oauth-ver X] if versioning for oauth2 is an issue?
 +
</source>
 +
|-
 +
|
 +
<source lang="bash">
 +
os oauth token create
 +
    --access
 +
    --consumer-key <consumer-key>
 +
    --consumer-secret <consumer-secret>
 +
    --request-key <request-key>
 +
    --request-secret <request-secret>
 +
    --verifier <pin>
 +
 
 +
os oauth token create
 +
    --request
 +
    --consumer-key <consumer-key>
 +
    --roles <roles>
 
</source>
 
</source>
|| yes
+
|| nyet
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone project-get
+
* collapse 'access token' and 'request token' into 'oauth token'?
    <project_id>
 
 
</source>
 
</source>
 
|}
 
|}
  
====role====
+
==== policy ====
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 1,147: Line 1,312:
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os add role
+
os policy create
     [--user <user> | --group <group>]
+
     [--type <policy-type>]
     [--domain <domain> | --project <project>]
+
     --blob-file <blob-file>
    <role>
 
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
 +
keystone policy-create
 +
    --type <policy-type>
 +
    --blob <policy-blob>
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os create role
+
os policy delete
     <role-name>
+
     <policy-id>
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
 +
keystone policy-delete
 +
    <policy-id>
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os delete role
+
os policy list
     <role>
+
     [--include-blob]
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
 +
keystone policy-list
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os list role
+
os policy set
 +
    [--type <policy-type>]
 +
    [--blob-file<blob-file>]
 +
    <policy-id>
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
 +
keystone policy-update
 +
    [--type <policy-type>]
 +
    [--blob <policy-blob>]
 +
    <policy-id>
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os list user-role
+
os policy show
 +
    <policy-id>
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
 +
keystone policy-get
 +
    <policy-id>
 
</source>
 
</source>
 +
|}
 +
 +
==== project ====
 +
 +
{| class="wikitable"
 +
|-
 +
! OSC Command !! Implemented !! !! Keystone command
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os list group-role
+
os project create
 +
    [--domain <project-domain>]
 +
    [--description <project-description>]
 +
    [--enable | --disable]
 +
    <project-name>
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
 +
keystone project-create
 +
    [--domain_id <domain_id>]
 +
    [--description <description>]
 +
    [--enable | --disable]
 +
    <name>
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os remove role
+
os project delete
    [--user <user> | --group <group>]
+
     <project>
     [--domain <domain> | --project <project>]
 
    <role>
 
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
 +
os project-delete
 +
    <project_id>
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os set role
+
os project list
     [--name <new-role-name>]
+
     [--long]
    <role>
 
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
 +
keystone project-list
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os show role
+
os project set
     <role>
+
     [--name <new-project-name>]
 +
    [--domain <project-domain>]
 +
    [--description <new-project-description>]
 +
    [--enable | --disable]
 +
    <project>
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
 +
keystone project-set
 +
    [--name <new-project-name>]
 +
    [--domain <project-domain>]
 +
    [--description <new-project-description>]
 +
    [--enable | --disable]
 +
    <project_id>
 
</source>
 
</source>
|}
+
|-
 +
|
 +
<source lang="bash">
 +
os project show
 +
    <project>
 +
</source>
 +
|| yes
 +
|| ||
 +
<source lang="bash">
 +
keystone project-get
 +
    <project_id>
 +
</source>
 +
|}
  
====service====
+
==== role ====
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 1,246: Line 1,464:
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os create service
+
os role add
[--name <name>]
+
    [--user <user> | --group <group>]
        [--enabled <true|false>]
+
    [--domain <domain> | --project <project>]
        <type>
+
    <role>
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone service-create
 
[--name <name>]
 
        [--enabled <true|false>]
 
        <type>
 
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os delete service
+
os role create
     <service>
+
     <role-name>
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone service-delete
 
    <service_id>
 
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os list service
+
os role delete
 +
    <role>
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone service-list
 
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os set service
+
os role list
    [--type <service-type>]
 
    [--name <new-name>]
 
    [--enable | --disable]
 
    <service>
 
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone service-set
 
    [--type <service-type>]
 
    [--name <new-name>]
 
    [--enable | --disable]
 
    <service>
 
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os show service
+
os role remove
     <service>
+
     [--user <user> | --group <group>]
 +
    [--domain <domain> | --project <project>]
 +
    <role>
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone service-get
 
    <service_id>
 
 
</source>
 
</source>
|}
 
 
====user====
 
 
{| class="wikitable"
 
|-
 
! OSC Command !! Implemented !! !! Keystone command
 
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os create user
+
os role set
     [--password <password>]
+
     [--name <new-role-name>]
    [--project <project>]
+
     <role>
    [--email <user-email>]
 
    [--enable | --disable]
 
     <name>
 
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone user-create
 
    --name <user-name>
 
    [--domain_id <domain-id>]
 
    [--default_project_id <project-id>]
 
    [--description <description>]
 
    [--enabled <true|false>]
 
    [--password <password>]
 
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os delete user
+
os role show
     <user>
+
     <role>
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone user-delete
 
    <user-id>
 
 
</source>
 
</source>
 +
|}
 +
 +
==== service ====
 +
 +
{| class="wikitable"
 +
|-
 +
! OSC Command !! Implemented !! !! Keystone command
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os list user
+
os service create
    [--project <project>]
+
[--name <name>]
    [--long]
+
        [--enabled <true|false>]
 +
        <type>
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone user-list
+
keystone service-create
 +
[--name <name>]
 +
        [--enabled <true|false>]
 +
        <type>
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os set user
+
os service delete
     [--name <new-name>]
+
     <service>
    [--password <password>]
 
    [--project <project>]
 
    [--email <user-email>]
 
    [--enable | --disable]
 
    <user>
 
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone user-update
+
keystone service-delete
     --user_id <user-id>
+
     <service_id>
    [--name <user-name>]
 
    [--domain_id <domain-id>]
 
    [--default_project_id <project-id>]
 
    [--description <description>]
 
    [--enabled <true|false>]
 
    [--password <password>]
 
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os show user
+
os list service
    <user>
 
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone user-get
+
keystone service-list
    <user-id>
 
 
</source>
 
</source>
|}
+
|-
 
+
|
== Compute ==
+
<source lang="bash">
 
+
os service set
 +
    [--type <service-type>]
 +
    [--name <new-name>]
 +
    [--enable | --disable]
 +
    <service>
 +
</source>
 +
|| yes
 +
|| ||
 +
<source lang="bash">
 +
keystone service-set
 +
    [--type <service-type>]
 +
    [--name <new-name>]
 +
    [--enable | --disable]
 +
    <service>
 +
</source>
 +
|-
 +
|
 +
<source lang="bash">
 +
os service show
 +
    <service>
 +
</source>
 +
|| yes
 +
|| ||
 +
<source lang="bash">
 +
keystone service-get
 +
    <service_id>
 +
</source>
 +
|}
 +
 
 +
==== user ====
  
 
{| class="wikitable"
 
{| class="wikitable"
|-
+
|-
! OSC Option !! Environment Variable !! !! Nova Option !! Environment Variable
+
! OSC Command !! Implemented !! !! Keystone command
|-
+
|-
| || || || --os-auth-system <auth-system> || OS_AUTH_SYSTEM
+
|
|-
+
<source lang="bash">
| || || || --service-type <type> ||
+
os user create
|-
+
     [--password <password>]
| || || || --service-name <name> || NOVA_SERVICE_NAME
+
     [--project <project>]
|-
+
     [--email <user-email>]
| || || || --volume-service-name <name> || NOVA_VOLUME_SERVICE_NAME
+
     [--enable | --disable]
|-
+
     <name>
| || || || --endpoint-type <type> || NOVA_ENDPOINT_TYPE
 
|-
 
| --os-compute-api-version <ver> || OS_COMPUTE_API_VERSION || || --os-compute-api-version <ver> || OS_COMPUTE_API_VERSION
 
|-
 
| || || || --bypass-url <bypass-url> ||
 
|}
 
 
 
 
 
=== API v2 (1.1) ===
 
 
 
==== agent ====
 
 
 
{| class="wikitable"
 
|-
 
! OSC Command !! Implemented !! !! Nova command
 
|-
 
|
 
<source lang="bash">
 
os create agent
 
     <os>
 
     <architecture>
 
     <version>
 
     <url>
 
     <md5hash>
 
    <hypervisor>
 
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
|-
 
|
 
 
<source lang="bash">
 
<source lang="bash">
os delete agent
+
keystone user-create
     <id>
+
     --name <user-name>
</source>
+
    [--domain_id <domain-id>]
|| yes
+
    [--default_project_id <project-id>]
|| ||
+
    [--description <description>]
 +
    [--enabled <true|false>]
 +
    [--password <password>]
 +
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os list agent
+
os user delete
     [--hypervisor <hypervisor>]
+
     <user>
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
|-
 
|
 
 
<source lang="bash">
 
<source lang="bash">
os set agent
+
keystone user-delete
     <id>
+
     <user-id>
    <version>
 
    <url>
 
    <md5hash>
 
 
</source>
 
</source>
|| yes
 
|| ||
 
|}
 
 
 
==== aggregate ====
 
 
{| class="wikitable"
 
|-
 
! OSC Command !! Implemented !! !! Nova command
 
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os add aggregate
+
os user list
     <aggregate>
+
     [--project <project>]
     <host>
+
     [--long]
 
</source>
 
</source>
|| no
+
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova aggregate-add-host
+
keystone user-list
    <id>
 
    <host>
 
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os create aggregate
+
os user set
     <name>
+
     [--name <new-name>]
     <availability_zone>
+
    [--password <password>]
 +
    [--project <project>]
 +
    [--email <user-email>]
 +
    [--enable | --disable]
 +
     <user>
 
</source>
 
</source>
|| no
+
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova aggregate-create
+
keystone user-update
     <name>
+
     --user_id <user-id>
     <availability_zone>
+
    [--name <user-name>]
 +
    [--domain_id <domain-id>]
 +
     [--default_project_id <project-id>]
 +
    [--description <description>]
 +
    [--enabled <true|false>]
 +
    [--password <password>]
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os delete aggregate
+
os user show
     <aggregate>
+
     <user>
 
</source>
 
</source>
|| no
+
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova aggregate-delete
+
keystone user-get
     <id>
+
     <user-id>
 
</source>
 
</source>
|-
+
|}
|
+
 
<source lang="bash">
+
== Compute ==
os list aggregate
+
 
</source>
+
 
|| no
+
{| 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">
nova aggregate-list
+
os agent create
 +
    <os>
 +
    <architecture>
 +
    <version>
 +
    <url>
 +
    <md5hash>
 +
    <hypervisor>
 
</source>
 
</source>
 +
|| yes
 +
|| ||
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os remove aggregate
+
os agent delete
 +
    <id>
 +
</source>
 +
|| yes
 +
|| ||
 +
|-
 +
|
 +
<source lang="bash">
 +
os agent list
 +
    [--hypervisor <hypervisor>]
 +
</source>
 +
|| yes
 +
|| ||
 +
|-
 +
|
 +
<source lang="bash">
 +
os agent set
 +
    <id>
 +
    <version>
 +
    <url>
 +
    <md5hash>
 +
</source>
 +
|| yes
 +
|| ||
 +
|}
 +
 
 +
 
 +
==== aggregate ====
 +
 
 +
{| class="wikitable"
 +
|-
 +
! OSC Command !! Implemented !! !! Nova command
 +
|-
 +
|
 +
<source lang="bash">
 +
os aggregate add host
 
     <aggregate>
 
     <aggregate>
 
     <host>
 
     <host>
 
</source>
 
</source>
|| no
+
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova aggregate-remove-host
+
nova aggregate-add-host
 
     <id>
 
     <id>
 
     <host>
 
     <host>
Line 1,545: Line 1,794:
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os set aggregate
+
os aggregate create
    [--name <new-name>]
 
 
     [--zone <availability-zone>]
 
     [--zone <availability-zone>]
 
     [--property <key=value>]
 
     [--property <key=value>]
     <aggregate>
+
     <name>
 
</source>
 
</source>
|| no
+
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova aggregate-update
+
nova aggregate-create
    <id>
 
 
     <name>
 
     <name>
 
     [<availability_zone>]
 
     [<availability_zone>]
 
nova aggregate-set-metadata
 
    <id>
 
    <key=value>
 
    [<key=value> ...]
 
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os show aggregate
+
os aggregate delete
 
     <aggregate>
 
     <aggregate>
 
</source>
 
</source>
|| no
+
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova aggregate-details
+
nova aggregate-delete
 
     <id>
 
     <id>
 
</source>
 
</source>
|}
 
 
 
==== bash-completion ====
 
 
{| class="wikitable"
 
|-
 
! OSC Command !! Implemented !! !! Nova command
 
 
|-
 
|-
 
|
 
|
TBD
+
<source lang="bash">
|| no
+
os aggregate list
 +
    [--long]
 +
</source>
 +
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova bash-completion
+
nova aggregate-list
 
</source>
 
</source>
|}
 
 
==== cloudpipe ====
 
 
{| class="wikitable"
 
|-
 
! OSC Command !! Implemented !! !! Nova command
 
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os create cloudpipe
+
os aggregate remove host
     <project>
+
     <aggregate>
 +
    <host>
 
</source>
 
</source>
|| no
+
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova cloudpipe-create
+
nova aggregate-remove-host
     <project>
+
    <id>
 +
     <host>
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os list cloudpipe
+
os aggregate set
 +
    [--name <new-name>]
 +
    [--zone <availability-zone>]
 +
    [--property <key=value>]
 +
    <aggregate>
 
</source>
 
</source>
|| no
+
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova cloudpipe-list
+
nova aggregate-update
 +
    <id>
 +
    <name>
 +
    [<availability_zone>]
 +
 
 +
nova aggregate-set-metadata
 +
    <id>
 +
    <key=value>
 +
    [<key=value> ...]
 
</source>
 
</source>
|}
 
 
==== console ====
 
 
{| class="wikitable"
 
|-
 
! OSC Command !! Implemented !! !! Nova command
 
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os show console-log
+
os aggregate show
     [--lines <num-lines>]
+
     <aggregate>
    <server>
 
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova console-log
+
nova aggregate-details
    [--length <length>]
+
     <id>
    <server>
 
</source>
 
|-
 
|
 
<source lang="bash">
 
os show console-url
 
    [--novnc | --xvpvnc | --spice]
 
    <server>
 
</source>
 
|| yes
 
|| ||
 
<source lang="bash">
 
nova get-vnc-console
 
    <server>
 
     <console_type>
 
 
</source>
 
</source>
 
|}
 
|}
  
==== credentials ====
+
==== bash-completion ====
  
''This may be better handled as part of the Identity API''
 
 
{| class="wikitable"
 
{| class="wikitable"
 
|-
 
|-
Line 1,666: Line 1,886:
 
|-
 
|-
 
|
 
|
<source lang="bash">
 
 
TBD
 
TBD
</source>
 
 
|| no
 
|| no
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova credentials
+
nova bash-completion
 
</source>
 
</source>
 
|}
 
|}
  
==== diagnostics ====
+
==== cloudpipe ====
  
''Consider implementing this as: show server --diagnostics <server>''
 
 
{| class="wikitable"
 
{| class="wikitable"
 
|-
 
|-
Line 1,685: Line 1,902:
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os show diagnostics
+
os create cloudpipe
     <server>
+
     <project>
 
</source>
 
</source>
 
|| no
 
|| no
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova diagnostics
+
nova cloudpipe-create
     <server>
+
     <project>
 
</source>
 
</source>
|}
+
|-
 
+
|
==== dns ====
+
<source lang="bash">
 +
os list cloudpipe
 +
</source>
 +
|| no
 +
|| ||
 +
<source lang="bash">
 +
nova cloudpipe-list
 +
</source>
 +
|}
 +
 
 +
==== console ====
  
''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"
 
{| class="wikitable"
 
|-
 
|-
Line 1,705: Line 1,931:
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os create dns
+
os console log show
     [--type <type>]
+
     [--lines <num-lines>]
     <ip>
+
     <server>
    <name>
 
    <domain>
 
 
</source>
 
</source>
|| no
+
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova dns-create
+
nova console-log
     [--type <type>]
+
     [--length <length>]
     <ip>
+
     <server>
    <name>
 
    <domain>
 
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os delete dns
+
os console url show
     <domain>
+
     [--novnc | --xvpvnc | --spice]
     <name>
+
     <server>
 
</source>
 
</source>
|| no
+
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova dns-delete
+
nova get-vnc-console
     <domain>
+
     <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 list dns
+
os diagnostics show
     [--ip <ip>]
+
     <server>
    [--name <name>]
 
    <domain>
 
 
</source>
 
</source>
 
|| no
 
|| no
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova dns-list
+
nova diagnostics
     [--ip <ip>]
+
     <server>
    [--name <name>]
 
    <domain>
 
 
</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 create dns-domain
+
os create dns
     [--project <project>]
+
     [--type <type>]
     [--availability-zone <availability-zone>]
+
     <ip>
     [--public | --private]
+
     <name>
 
     <domain>
 
     <domain>
 
</source>
 
</source>
Line 1,762: Line 2,000:
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova dns-create-private-domain
+
nova dns-create
     [--availability_zone <availability_zone>]
+
     [--type <type>]
     <domain>
+
     <ip>
 
+
     <name>
nova dns-create-public-domain
 
     [--project <project>]
 
 
     <domain>
 
     <domain>
 
</source>
 
</source>
Line 1,773: Line 2,009:
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os delete dns-domain
+
os delete dns
 
     <domain>
 
     <domain>
 +
    <name>
 
</source>
 
</source>
 
|| no
 
|| no
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova dns-delete-domain
+
nova dns-delete
 
     <domain>
 
     <domain>
 +
    <name>
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os list dns-domains
+
os list dns
 +
    [--ip <ip>]
 +
    [--name <name>]
 +
    <domain>
 
</source>
 
</source>
 
|| no
 
|| no
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova dns-domains
+
nova dns-list
 +
    [--ip <ip>]
 +
    [--name <name>]
 +
    <domain>
 
</source>
 
</source>
|}
 
 
==== endpoints ====
 
 
''Totally duplicates Identity catalog command''
 
{| class="wikitable"
 
 
|-
 
|-
! OSC Command !! Implemented !! !! Nova command
+
|
 +
<source lang="bash">
 +
os create dns-domain
 +
    [--project <project>]
 +
    [--availability-zone <availability-zone>]
 +
    [--public | --private]
 +
    <domain>
 +
</source>
 +
|| no
 +
|| ||
 +
<source lang="bash">
 +
nova dns-create-private-domain
 +
    [--availability_zone <availability_zone>]
 +
    <domain>
 +
 
 +
nova dns-create-public-domain
 +
    [--project <project>]
 +
    <domain>
 +
</source>
 +
|-
 +
|
 +
<source lang="bash">
 +
os delete dns-domain
 +
    <domain>
 +
</source>
 +
|| no
 +
|| ||
 +
<source lang="bash">
 +
nova dns-delete-domain
 +
    <domain>
 +
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os list endpoints
+
os list dns-domains
 
</source>
 
</source>
 
|| no
 
|| no
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova endpoints
+
nova dns-domains
 
</source>
 
</source>
 
|}
 
|}
  
==== fixed-ip ====
+
==== endpoints ====
  
 +
''Totally duplicates Identity catalog command''
 
{| class="wikitable"
 
{| class="wikitable"
 
|-
 
|-
Line 1,820: Line 2,089:
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os add fixed-ip
+
os endpoint list
     <network>
+
</source>
 +
|| no
 +
|| ||
 +
<source lang="bash">
 +
nova endpoints
 +
</source>
 +
|}
 +
 
 +
==== fixed-ip ====
 +
 
 +
{| class="wikitable"
 +
|-
 +
! OSC Command !! Implemented !! !! Nova command
 +
|-
 +
|
 +
<source lang="bash">
 +
os ip fixed add
 +
     <network>
 
     <server>
 
     <server>
 
</source>
 
</source>
Line 1,834: Line 2,120:
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os remove fixed-ip
+
os ip fixed remove
 
     <ip-address>
 
     <ip-address>
 
     <server>
 
     <server>
Line 1,856: Line 2,142:
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os create flavor
+
os flavor create
 
     [--id <id>]
 
     [--id <id>]
 
     [--ram <size-mb>]
 
     [--ram <size-mb>]
Line 1,895: Line 2,181:
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os delete flavor
+
os flavor delete
 
     <flavor>
 
     <flavor>
 
</source>
 
</source>
Line 1,907: Line 2,193:
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os list flavor
+
os flavor list
 
</source>
 
</source>
 
|| yes
 
|| yes
Line 1,917: Line 2,203:
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os show flavor
+
os flavor show
 
     <flavor>
 
     <flavor>
 
</source>
 
</source>
Line 1,933: Line 2,219:
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os add floating-ip
+
os ip floating add
 
     <ip-address>
 
     <ip-address>
 
     <server>
 
     <server>
Line 1,947: Line 2,233:
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os create floating-ip
+
os ip floating create
 
     [<pool>]
 
     [<pool>]
 
</source>
 
</source>
Line 1,959: Line 2,245:
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os delete floating-ip
+
os ip floating delete
 
     <ip-address>
 
     <ip-address>
 
</source>
 
</source>
Line 1,971: Line 2,257:
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os list floating-ip
+
os ip floating list
 
</source>
 
</source>
 
|| yes
 
|| yes
Line 1,981: Line 2,267:
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os remove floating-ip
+
os ip floating remove
 
     <ip-address>
 
     <ip-address>
 
     <server>
 
     <server>
Line 2,004: Line 2,290:
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os list floating-ip-pool
+
os ip floating pool list
 
</source>
 
</source>
 
|| yes
 
|| yes
Line 2,022: Line 2,308:
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os list host
+
os host list
 
     [--zone <availability-zone>]
 
     [--zone <availability-zone>]
 
</source>
 
</source>
Line 2,035: Line 2,321:
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os set host
+
os host set
 
     ...
 
     ...
 
</source>
 
</source>
Line 2,049: Line 2,335:
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os show host
+
os host show
 
     <host>
 
     <host>
 
</source>
 
</source>
Line 2,065: Line 2,351:
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os list hypervisor
+
os hypervisor list
 
     [--matching <hostname>]
 
     [--matching <hostname>]
 
</source>
 
</source>
Line 2,073: Line 2,359:
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os show hypervisor
+
os hypervisor show
 
     <id>
 
     <id>
 
</source>
 
</source>
Line 2,089: Line 2,375:
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os create keypair
+
os keypair create
 
     [--public-key <file>]
 
     [--public-key <file>]
 
     <name>
 
     <name>
Line 2,103: Line 2,389:
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os delete keypair
+
os keypair delete
 
     <name>
 
     <name>
 
</source>
 
</source>
Line 2,115: Line 2,401:
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os list keypair
+
os keypair list
 
</source>
 
</source>
 
|| yes
 
|| yes
Line 2,125: Line 2,411:
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os show keypair
+
os keypair show
 
     [--public-key]
 
     [--public-key]
 
     <name>
 
     <name>
Line 2,135: Line 2,421:
  
 
==== limits ====
 
==== limits ====
 +
 +
See [[#limits|limits]] in the [[#Cross_API|cross API section]].
 +
 +
==== quota ====
 +
 +
See [[#quota|quota]] in the [[#Cross_API|cross API section]].
 +
 +
 +
==== resource ====
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 2,142: Line 2,437:
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os show limits
+
os show resource
     --absolute [--reserved] | --rate
+
     <hostname>
 
</source>
 
</source>
 
|| no
 
|| no
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova absolute-limits
+
nova describe-resource
 
+
    <hostname>
nova rate-limits
 
 
</source>
 
</source>
 
|}
 
|}
  
==== quota ====
+
==== secgroup ====
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 2,162: Line 2,456:
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os set quota
+
os secgroup add
    [--instances <instances>]
+
 
    [--cores <cores>]
+
(see server add secgroup)
    [--ram <ram>]
 
    [--volumes <volumes>]
 
    [--gigabytes <gigabytes>]
 
    [--floating-ips <floating-ips>]
 
    [--property-items <property-items>]
 
    [--injected-files <injected-files>]
 
    [--injected-file-content-bytes <injected-file-content-bytes>]
 
    <project>
 
 
</source>
 
</source>
 
|| no
 
|| no
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova quota-update
+
nova add-secgroup
     [--instances <instances>]
+
     <server>
    [--cores <cores>]
+
     <secgroup>
    [--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>
 
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os set quota
+
os secgroup create
    --class
+
     [--description <description>]
    [--instances <instances>]
+
     <name>
    [--cores <cores>]
 
    [--ram <ram>]
 
    [--volumes <volumes>]
 
    [--gigabytes <gigabytes>]
 
    [--floating-ips <floating-ips>]
 
    [--property-items <property-items>]
 
    [--injected-files <injected-files>]
 
     [--injected-file-content-bytes <injected-file-content-bytes>]
 
     <class>
 
 
</source>
 
</source>
|| no
+
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova quota-class-update
+
nova secgroup-create
     [--instances <instances>]
+
     <name>
     [--cores <cores>]
+
     <description>
    [--ram <ram>]
+
</source>
    [--volumes <volumes>]
+
|-
     [--gigabytes <gigabytes>]
+
|
    [--floating-ips <floating_ips>]
+
<source lang="bash">
    [--metadata-items <metadata_items>]
+
os secgroup delete
    [--injected-files <injected_files>]
+
     <group>
    [--injected-file-content-bytes <injected_file_content_bytes>]
+
</source>
     <class>
+
|| yes
 +
|| ||
 +
<source lang="bash">
 +
nova secgroup-delete
 +
     <secgroup>
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os show quota
+
os secgroup list
     [--defaults]
+
     [--all-projects]
    <project>
 
 
</source>
 
</source>
|| no
+
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova quota-defaults
+
nova secgroup-list
    <tenant_id>
+
    [--all-tenants [<0|1>]]
 
 
nova quota-show
 
    <tenant_id>
 
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os show quota-class
+
os secgroup remove
    <class>
+
 
 +
(see server remove secgroup)
 
</source>
 
</source>
 
|| no
 
|| no
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova quota-class-show
+
nova remove-secgroup
     <class>
+
    <server>
 +
     <secgroup>
 
</source>
 
</source>
|}
+
|-
 
+
|
 
 
 
 
'''resource'''
 
 
 
 
<source lang="bash">
 
<source lang="bash">
nova describe-resource <hostname>
+
os secgroup set
 
+
    [--name <new-name>]
os show resource ...
+
    [--description [<new-description>]
 +
    <group>
 +
</source>
 +
|| yes
 +
|| ||
 +
<source lang="bash">
 +
nova secgroup-update
 +
    <secgroup>
 +
    <name>
 +
    <description>
 
</source>
 
</source>
 +
|-
 +
|
 +
<source lang="bash">
 +
os secgroup show
 +
    <group>
 +
</source>
 +
|| yes
 +
|| ||
 +
<source lang="bash">
 +
n/a
 +
</source>
 +
|}
  
==== secgroup ====
+
==== secgroup-group-rule ====
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 2,268: Line 2,556:
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os add secgroup
+
os secgroup group rule create
 +
    [--proto <protocol>]
 +
    [--port <port>:<port>]
 +
    <source-group>
 
     <secgroup>
 
     <secgroup>
    <server>
 
 
</source>
 
</source>
 
|| no
 
|| no
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova add-secgroup
+
nova secgroup-add-group-rule
     <server>
+
    [--ip_proto <ip_proto>]
 +
    [--from_port <from_port>]
 +
     [--to_port <to_port>]
 
     <secgroup>
 
     <secgroup>
 +
    <source_group>
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os create secgroup
+
os secgroup group rule delete
     [--description <description>]
+
     [--proto <protocol>]
     <name>
+
    [--port <port>:<port>]
 +
    <source-group>
 +
     <secgroup>
 
</source>
 
</source>
|| yes
+
|| no
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova secgroup-create
+
nova secgroup-delete-group-rule
     <name>
+
     [--ip_proto <ip_proto>]
     <description>
+
     [--from_port <from_port>]
 +
    [--to_port <to_port>]
 +
    <secgroup>
 +
    <source_group>
 
</source>
 
</source>
 +
|}
 +
 +
==== secgroup-rule ====
 +
 +
{| class="wikitable"
 +
|-
 +
! OSC Command !! Implemented !! !! Nova command
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os delete secgroup
+
os secgroup rule create
     <secgroup>
+
     [--proto <proto>]
 +
    [--src-ip <ip-address>]
 +
    [--dst-port <port-range>]
 +
    <group>
 
</source>
 
</source>
|| yes
+
|| no
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova secgroup-delete
+
nova secgroup-add-rule
 
     <secgroup>
 
     <secgroup>
 +
    <ip_proto>
 +
    <from_port>
 +
    <to_port>
 +
    <cidr>
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os list secgroup
+
os secgroup rule delete
     [--all-tenants]
+
     [--proto <proto>]
 +
    [--src-ip <ip-address>]
 +
    [--dst-port <port-range>]
 +
    <group>
 
</source>
 
</source>
|| yes
+
|| no
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova secgroup-list
+
nova secgroup-delete-rule
    [--all-tenants [<0|1>]]
+
    <secgroup>
 +
    <ip_proto>
 +
    <from_port>
 +
    <to_port>
 +
    <cidr>
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os remove secgroup
+
os secgroup rule list
     <secgroup>
+
     <group>
    <server>
 
 
</source>
 
</source>
 
|| no
 
|| no
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova remove-secgroup
+
nova secgroup-list-rules
    <server>
 
 
     <secgroup>
 
     <secgroup>
 
</source>
 
</source>
 
|}
 
|}
  
==== secgroup-group-rule ====
+
====server====
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 2,341: Line 2,658:
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os create secgroup-group-rule
+
os server add secgroup
    [--proto <protocol>]
+
     <server>
     [--port <port>:<port>]
+
     <group>
     <source-group>
 
    <secgroup>
 
 
</source>
 
</source>
 
|| no
 
|| no
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova secgroup-add-group-rule
+
nova add-secgroup
    [--ip_proto <ip_proto>]
+
     <server>
     [--from_port <from_port>]
 
    [--to_port <to_port>]
 
 
     <secgroup>
 
     <secgroup>
    <source_group>
 
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os delete secgroup-group-rule
+
os server create
     [--proto <protocol>]
+
    --image <image>
     [--port <port>:<port>]
+
    --flavor <flavor>
     <source-group>
+
    [--security-group <security-group-list> [...] ]
     <secgroup>
+
     [--key-name <key-name>]
</source>
+
     [--meta-data <key=value> [...] ]
|| no
+
    [--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">
 
<source lang="bash">
nova secgroup-delete-group-rule
+
nova boot
     [--ip_proto <ip_proto>]
+
    [--flavor <flavor>]
     [--from_port <from_port>]
+
    [--image <image>]
     [--to_port <to_port>]
+
     [--meta <key=value>]
     <secgroup>
+
     [--file <dst-path=src-path>]
     <source_group>
+
     [--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>
|}
 
 
==== secgroup-rule ====
 
 
{| class="wikitable"
 
|-
 
! OSC Command !! Implemented !! !! Nova command
 
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os create secgroup-rule
+
os server delete
     [--proto <proto>]
+
     <server>
    [--src-ip <ip-address>]
 
    [--src-port <port>]
 
    [--dst-port <port>]
 
    <secgroup>
 
 
</source>
 
</source>
|| no
+
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova secgroup-add-rule
+
nova delete
     <secgroup>
+
     <server>
    <ip_proto>
 
    <from_port>
 
    <to_port>
 
    <cidr>
 
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os delete secgroup-rule
+
os server list
     [--proto <proto>]
+
    [--reservation-id <reservation-id>]
     [--src-ip <ip-address>]
+
     [--ip <ip-regex>]
     [--src-port <port>]
+
     [--ip6 <ip6-regex>]
     [--dst-port <port>]
+
    [--name <name-regex>]
     <secgroup>
+
     [--instance-name <instance-name-regex>]
 +
    [--status <status>]
 +
     [--flavor <flavor>]
 +
    [--image <image>]  
 +
     [--host <hostname>]
 +
    [--all-tenants]
 
</source>
 
</source>
|| no
+
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova secgroup-delete-rule
+
nova list
     <secgroup>
+
    [--reservation_id <reservation_id>]
     <ip_proto>
+
    [--ip <ip_regexp>]
     <from_port>
+
    [--ip6 <ip6_regexp>]
     <to_port>
+
    [--name <name_regexp>]
     <cidr>
+
     [--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 list secgroup-rule
+
os server lock
     <secgroup>
+
     <server>
 
</source>
 
</source>
 
|| no
 
|| no
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova secgroup-list-rules
+
nova lock
     <secgroup>
+
     <server>
 
</source>
 
</source>
|}
 
 
====server====
 
 
{| class="wikitable"
 
|-
 
! OSC Command !! Implemented !! !! Nova command
 
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os create server
+
os server migrate
     --image <image>
+
     --live
    --flavor <flavor>
+
     [--block_migrate]
     [--security-group <security-group-list> [...] ]
+
     [--disk_over_commit]
     [--key-name <key-name>]
+
     <server>
     [--meta-data <key=value> [...] ]
+
     <host>
     [--file <dest-filename=source-filename>] [...] ]
+
 
    [--user-data <user-data>]
+
os server migrate
    [--availability-zone <zone-name>]
+
     [--wait]
    [--block-device-mapping <dev-name=mapping> [...] ]
+
     <server>
    [--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
+
|| no
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova boot
+
nova live-migration
    [--flavor <flavor>]
+
     [--block_migrate]  
    [--image <image>]
+
     [--disk_over_commit]
    [--meta <key=value>]
+
     <server>
    [--file <dst-path=src-path>]
+
<host>
    [--key_name <key_name>]
+
 
    [--user_data <user-data>]
+
nova migrate
     [--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]
 
     [--poll]
     <name>
+
     <server>
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os delete server
+
os server pause
 
     <server>
 
     <server>
 
</source>
 
</source>
Line 2,491: Line 2,798:
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova delete
+
nova pause
 
     <server>
 
     <server>
 
</source>
 
</source>
Line 2,497: Line 2,804:
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os list server
+
os server reboot
     [--reservation-id <reservation-id>]  
+
     [--hard | --soft]
     [--ip <ip-regex>]
+
     [--wait]
     [--ip6 <ip6-regex>]
+
     <server>
    [--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 reboot
     [--reservation_id <reservation_id>]
+
     [--hard]
    [--ip <ip_regexp>]
+
     [--poll]
    [--ip6 <ip6_regexp>]
+
     <server>
    [--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 server rebuild
 +
    --image <image>
 +
    [--password <password>]
 +
    [--wait]
 
     <server>
 
     <server>
 
</source>
 
</source>
|| no
+
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova lock
+
nova rebuild
 +
    [--rebuild_password <rebuild_password>]
 +
    [--poll]
 
     <server>
 
     <server>
 +
    <image>
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os migrate server
+
os server remove secgroup
    --live
 
    [--block_migrate]
 
    [--disk_over_commit]
 
    <server>
 
    <host>
 
 
 
os migrate server
 
    [--wait]
 
 
     <server>
 
     <server>
 +
    <group>
 
</source>
 
</source>
 
|| no
 
|| no
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova live-migration
+
nova remove-secgroup
    [--block_migrate]
 
    [--disk_over_commit]
 
    <server>
 
<host>
 
 
 
nova migrate
 
    [--poll]
 
 
     <server>
 
     <server>
 +
    <secgroup>
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os pause server
+
os server rename
 
     <server>
 
     <server>
 +
    <new-name>
 
</source>
 
</source>
|| yes
+
|| no
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova pause
+
nova rename
 
     <server>
 
     <server>
 +
    <name>
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os reboot server
+
os server rescue
    [--hard | --soft]
 
    [--wait]
 
 
     <server>
 
     <server>
 
</source>
 
</source>
|| yes
+
|| no
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova reboot
+
nova rescue
    [--hard]
 
    [--poll]
 
 
     <server>
 
     <server>
 
</source>
 
</source>
Line 2,593: Line 2,878:
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os rebuild server  
+
os server resize
     --image <image>
+
     --flavor <flavor>
    [--password <password>]
 
 
     [--wait]
 
     [--wait]
 
     <server>
 
     <server>
 
</source>
 
</source>
|| yes
+
|| no
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova rebuild
+
nova resize
    [--rebuild_password <rebuild_password>]
 
 
     [--poll]
 
     [--poll]
 
     <server>
 
     <server>
     <image>
+
     <flavor>
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os rename server
+
os server resize
 +
    --confirm
 
     <server>
 
     <server>
    <new-name>
 
 
</source>
 
</source>
 
|| no
 
|| no
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova rename
+
nova resize-confirm
 
     <server>
 
     <server>
    <name>
 
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os rescue server
+
os server resume
 
     <server>
 
     <server>
 
</source>
 
</source>
|| no
+
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova rescue
+
nova resume
 
     <server>
 
     <server>
 
</source>
 
</source>
Line 2,637: Line 2,919:
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os resize server  
+
os server set
     --flavor <flavor>
+
     --meta-data <key=value>
     [--wait]
+
     [--meta-data <key=value>] ...
 +
    <server>
 +
os unset server
 +
    --meta-data <key>
 +
    [--meta-data <key>] ...
 
     <server>
 
     <server>
 
</source>
 
</source>
Line 2,645: Line 2,931:
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova resize
+
nova meta
    [--poll]
 
 
     <server>
 
     <server>
     <flavor>
+
     <action>
 +
    <key=value>
 +
    [<key=value> ...]
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os resize server
+
os server set
     --confirm
+
     --root-password
 
     <server>
 
     <server>
 
</source>
 
</source>
Line 2,660: Line 2,947:
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova resize-confirm
+
nova root-password
 
     <server>
 
     <server>
 
</source>
 
</source>
Line 2,666: Line 2,953:
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os resume server
+
os server show
 
     <server>
 
     <server>
 
</source>
 
</source>
Line 2,672: Line 2,959:
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova resume
+
nova show
 
     <server>
 
     <server>
 
</source>
 
</source>
Line 2,678: Line 2,965:
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os set server
+
os server ssh
     --meta-data <key=value>
+
     [--port PORT]
     [--meta-data <key=value>] ...
+
    --private]
 +
     [--ipv6]
 +
    [--login <login>]
 
     <server>
 
     <server>
os unset server
+
</source>
    --meta-data <key>
+
|| no
    [--meta-data <key>] ...
 
    <server>
 
</source>
 
|| no
 
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova meta
+
nova ssh
 +
    [--port PORT]
 +
    [--private]
 +
    [--ipv6]
 +
    [--login <login>]
 
     <server>
 
     <server>
    <action>
 
    <key=value>
 
    [<key=value> ...]
 
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os set server
+
os server suspend
    --root-password
 
 
     <server>
 
     <server>
 
</source>
 
</source>
|| no
+
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova root-password
+
nova suspend
 
     <server>
 
     <server>
 
</source>
 
</source>
Line 2,712: Line 2,997:
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os show server
+
os server unlock
 
     <server>
 
     <server>
 
</source>
 
</source>
|| yes
+
|| no
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova show
+
nova unlock
 
     <server>
 
     <server>
 
</source>
 
</source>
Line 2,724: Line 3,009:
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os ssh server
+
os server unpause
    [--port PORT]
 
    --private]
 
    [--ipv6]
 
    [--login <login>]
 
 
     <server>
 
     <server>
 
</source>
 
</source>
|| no
+
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova ssh
+
nova unpause
    [--port PORT]
 
    [--private]
 
    [--ipv6]
 
    [--login <login>]
 
 
     <server>
 
     <server>
 
</source>
 
</source>
Line 2,744: Line 3,021:
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os suspend server
+
os server unrescue
 
     <server>
 
     <server>
 
</source>
 
</source>
|| yes
+
|| no
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova suspend
+
nova unrescue
 
     <server>
 
     <server>
 
</source>
 
</source>
 +
|}
 +
 +
==== usage ====
 +
 +
{| class="wikitable"
 +
|-
 +
! OSC Command !! Implemented !! !! Keystone command
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os unlock server
+
os usage list
     <server>
+
     [--start <start>]
 +
    [--end <end>]
 
</source>
 
</source>
 
|| no
 
|| no
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova unlock
+
nova usage-list
     <server>
+
     [--start <start>]
 +
    [--end <end>]
 
</source>
 
</source>
 +
|}
 +
 +
 +
==== volume ====
 +
 +
{| class="wikitable"
 +
|-
 +
! OSC Command !! Implemented !! !! Keystone command
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os unpause server
+
os volume attach
 +
    <volume>
 
     <server>
 
     <server>
 +
    <device>
 
</source>
 
</source>
|| yes
+
|| no
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova unpause
+
nova volume-attach
 
     <server>
 
     <server>
 +
    <volume>
 +
    <device>
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os unrescue server
+
os volume detach
 
     <server>
 
     <server>
 +
    <volume>
 
</source>
 
</source>
 
|| no
 
|| no
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova unrescue
+
nova volume-detach
 
     <server>
 
     <server>
 +
    <volume>
 
</source>
 
</source>
 
|}
 
|}
  
  
'''usage'''
+
==== x509-cert ====
  
<source lang="bash">
+
See [[#credentials|credentials]] in the [[#Cross_API|cross API section]].
nova usage-list [--start <start>] [--end <end>]
 
  
os list usage ...
+
==== x509-root-cert ====
</source>
 
  
 +
See [[#credentials|credentials]] in the [[#Cross_API|cross API section]].
  
'''volume'''
+
== Image ==
  
<source lang="bash">
+
{| class="wikitable"
nova volume-attach <server> <volume> <device>
+
|-  
 
+
! OSC Option !!  Environment Variable !!  !!  Glance Option !!  Environment Variable
os attach volume ...
+
|-  
</source>
+
| --os-image-api-version <ver> || OS_IMAGE_API_VERSION ||  || --os-image-api-version <ver> || OS_IMAGE_API_VERSION
 
 
<source lang="bash">
 
nova volume-detach <server> <volume>
 
 
 
os detach volume ...
 
</source>
 
 
 
 
 
'''x509-cert'''
 
 
 
<source lang="bash">
 
nova x509-create-cert [<private_key_file>] [<x509_cert>]
 
 
 
os create x509-cert ...
 
</source>
 
 
 
 
 
'''x509-root-cert'''
 
 
 
<source lang="bash">
 
nova x509-get-root-cert [<filename>]
 
 
 
os show x509-root-cert ...
 
</source>
 
 
 
== 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-service-type <type> || OS_SERVICE_TYPE
Line 2,863: Line 3,129:
 
=== API v1 ===
 
=== API v1 ===
  
'''image'''
+
==== image ====
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 2,871: Line 3,137:
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os create image
+
os image create
 
     [--id <id>]
 
     [--id <id>]
 
     [--store <store>]
 
     [--store <store>]
Line 2,895: Line 3,161:
 
     [--id <IMAGE_ID>]
 
     [--id <IMAGE_ID>]
 
     [--name <NAME>]
 
     [--name <NAME>]
     [--disk-format <CONTAINER_FORMAT>]
+
     [--disk-format <DISK_FORMAT>]
     [--container-format <DISK_FORMAT>]
+
     [--container-format <CONTAINER_FORMAT>]
 
     [--owner <TENANT_ID>]
 
     [--owner <TENANT_ID>]
 
     [--size <SIZE>]
 
     [--size <SIZE>]
Line 2,904: Line 3,170:
 
     [--checksum <CHECKSUM>]
 
     [--checksum <CHECKSUM>]
 
     [--copy-from <IMAGE_URL>]
 
     [--copy-from <IMAGE_URL>]
     [--public] [--protected]
+
     [--is-public [True|False]]
 +
    [--is-protected [True|False]]
 
     [--property <key=value>]
 
     [--property <key=value>]
 +
    [--human-readable]
 
</source>
 
</source>
|}
 
 
=== API v2 ===
 
 
'''image'''
 
 
{| class="wikitable"
 
|-
 
! OSC Command !! Implemented !! !! Glance command
 
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os delete image
+
os image delete
     <id>
+
     <image>
 
</source>
 
</source>
 
|| yes
 
|| yes
Line 2,928: Line 3,187:
 
     <IMAGE_ID>
 
     <IMAGE_ID>
 
</source>
 
</source>
|}
+
|-
 
+
|
 
+
<source lang="bash">
 
+
os image list
 +
    [--page-size <size>]
 +
</source>
 +
|| yes
 +
|| ||
 
<source lang="bash">
 
<source lang="bash">
 
glance image-list
 
glance image-list
 
os list image ...
 
 
</source>
 
</source>
 
+
|-
 
+
|
 
<source lang="bash">
 
<source lang="bash">
glance image-show <IMAGE_ID>
+
os image save
 
+
    [--file <filename>]
os show image ...
+
    <image>
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
 
<source lang="bash">
 
<source lang="bash">
glance member-images [options] <MEMBER>
+
glance image-download
 
+
    [--file <FILE>]
os list image --member <member> [options]
+
    <IMAGE>
 
</source>
 
</source>
 
+
|-
 
+
|
 
<source lang="bash">
 
<source lang="bash">
glance show [options] <ID>
+
os image set
 
+
    [--name <name>]
os show image ...
+
    [--owner <tenant>]
 +
    [--min-disk <disk-gb>]
 +
    [--min-ram <ram-mg>]
 +
    [--protected | --unprotected]
 +
    [--public | --private]
 +
    [--property <key=value>]
 +
    <image>
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
 
<source lang="bash">
 
<source lang="bash">
glance update [options] <ID> <field1=value1 field2=value2 ...>
+
glance image-update
 
+
    [--name <NAME>]
os set image ...
+
    [--disk-format <DISK_FORMAT>]
</source>
+
    [--container-format <CONTAINER_FORMAT>]
 
+
    [--owner <TENANT_ID>]
 
+
    [--size <SIZE>]
'''image-member'''
+
    [--min-disk <DISK_GB>]
 
+
    [--min-ram <DISK_RAM>]
<source lang="bash">
+
    [--location <IMAGE_URL>]
glance member-create [--can-share] <IMAGE_ID> <TENANT_ID>
+
    [--file <FILE>]
 
+
    [--checksum <CHECKSUM>]
os create image-member ...
+
    [--copy-from <IMAGE_URL>]
 +
    [--is-public [True|False]]
 +
    [--is-protected [True|False]]
 +
    [--property <key=value>]
 +
    [--purge-props]
 +
    [--human-readable]
 +
    <IMAGE>
 
</source>
 
</source>
 
+
|-
 
+
|
 
<source lang="bash">
 
<source lang="bash">
glance member-delete <IMAGE_ID> <TENANT_ID>
+
os image show
 
+
    <image>
os list image-member <image> [options]
 
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
 
<source lang="bash">
 
<source lang="bash">
glance member-delete [options] <ID> <MEMBER>
+
glance image-show
 
+
    [--human-readable]
os delete image-member ...
+
    <IMAGE>
 
</source>
 
</source>
 +
|}
  
 +
=== API v2 ===
  
<source lang="bash">
+
==== image ====
glance member-list [--image-id <IMAGE_ID>] [--tenant-id <TENANT_ID>]
 
  
os list image-member ...
+
{| class="wikitable"
</source>
+
|-
 
+
! OSC Command !! Implemented !! !! Glance command
== 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 ===
 
 
 
==== quota ====
 
 
 
{| class="wikitable"
 
|-
 
! OSC Command !! Implemented !! !! Cinder command
 
|-
 
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os list quota
+
os image delete
     <tenant>
+
     <image>
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
 +
glance image-delete
 +
    <IMAGE_ID>
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os set quota
+
os image list
     [--volumes] <new-volumes>]
+
     [--page-size <size>]
    [--gigabytes <new-gigabytes>]
+
</source>
    <tenant>
 
</source>
 
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
cinder quota-update
+
glance image-list
    [--volumes <volumes>]
 
    [--snapshots <snapshots>]
 
    [--gigabytes <gigabytes>]
 
    <tenant_id>
 
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os show quota
 
    <tenant>
 
 
</source>
 
</source>
|| yes
+
|| no
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
cinder quota-show
+
glance member-images
     <tenant_id>
+
    [options]
 +
     <MEMBER>
 
</source>
 
</source>
|}
 
 
==== snapshot ====
 
 
{| class="wikitable"
 
|-
 
! OSC Command !! Implemented !! !! Cinder command
 
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os create snapshot
+
os image save
    --name <name>
+
     [--file <filename>]
     [--description <description>]
+
     <image>
    [--force]
 
     <volume>
 
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
cinder snapshot-create
+
glance image-download
     --force <True|False>
+
     [--file <FILE>]
     --display-name <display-name>
+
     <IMAGE>
    --display-description <display-description>
 
    <volume-id>
 
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os delete snapshot
+
os image set
     <snapshot>
+
     [--id <id>]
</source>
+
    [--store <store>]
|| yes
+
    [--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">
 
<source lang="bash">
cinder snapshot-delete
+
glance image-update
     <snapshot-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>]
 +
    [--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>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os list snapshot
+
os image show
 +
    <image>
 
</source>
 
</source>
|| yes (no opts yet)
+
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
cinder snapshot-list
+
glance image-show
     --all-tenants [<0|1>]
+
     [--human-readable]
     --display-name <display-name>
+
     <IMAGE>
    --status <status>
 
    --volume-id <volume-id>
 
 
</source>
 
</source>
|-
+
|}
|
+
 
 +
 
 +
==== image-member ====
 +
 
 +
Need to discuss the future of these commands with markwash...
 +
 
 
<source lang="bash">
 
<source lang="bash">
os set snapshot
+
glance member-create [--can-share] <IMAGE_ID> <TENANT_ID>
    [--name <new-name>]
+
 
    [--description <new-description>]
+
os create image-member ...
    <snapshot>
 
 
</source>
 
</source>
|| yes
+
 
|| ||
+
 
 
<source lang="bash">
 
<source lang="bash">
cinder snapshot-rename
+
glance member-delete <IMAGE_ID> <TENANT_ID>
    --display-description <display-description>
+
 
    --display-name <display-name>
+
os list image-member <image> [options]
    <snapshot-id>
 
 
</source>
 
</source>
|-
+
 
|
+
 
 
<source lang="bash">
 
<source lang="bash">
os show snapshot
+
glance member-delete [options] <ID> <MEMBER>
    <snapshot>
+
 
 +
os delete image-member ...
 
</source>
 
</source>
|| yes
+
 
|| ||
+
 
 
<source lang="bash">
 
<source lang="bash">
cinder snapshot-show
+
glance member-list [--image-id <IMAGE_ID>] [--tenant-id <TENANT_ID>]
    <snapshot-id>
+
 
 +
os list image-member ...
 
</source>
 
</source>
|}
 
  
==== volume ====
+
== 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"
 
{| class="wikitable"
Line 3,153: Line 3,446:
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os create volume
+
os snapshot create
     --size <size>
+
     --name <name>
 
     [--description <description>]
 
     [--description <description>]
     [--volume-type <volume-type>]
+
     [--force]
     [--snapshot-id <snapshot-id>]
+
     <volume>
    [--source <volid>]
+
</source>
    [--image <image-id>]
 
    [--availability-zone <availability-zone>]
 
    [--metadata <key=value>]
 
    [--user <user>]          # admin only
 
    [--project <project>]    # admin only
 
    <name>
 
</source>
 
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
cinder create
+
cinder snapshot-create
    [--snapshot-id <snapshot-id>]
+
     --force <True|False>
    [--source-volid <source-volid>]
+
     --display-name <display-name>
     [--image-id <image-id>]
+
     --display-description <display-description>
     [--display-name <display-name>]
+
     <volume-id>
     [--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 snapshot delete
    [--force]
+
     <snapshot>
     <volume>
 
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
cinder delete
+
cinder snapshot-delete
    <volume-id>
+
     <snapshot-id>
 
 
cinder force-delete
 
     <volume-id>
 
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os list volume
+
os snapshot list
    [--name <name>]
 
    [--status <status>]
 
    [--long]
 
    [--all-tenants]          # admin only
 
 
</source>
 
</source>
|| yes
+
|| yes (no opts yet)
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
cinder list  
+
cinder snapshot-list  
 
     --all-tenants [<0|1>]
 
     --all-tenants [<0|1>]
 
     --display-name <display-name>
 
     --display-name <display-name>
 
     --status <status>
 
     --status <status>
 +
    --volume-id <volume-id>
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os set volume
+
os snapshot set
 
     [--name <new-name>]
 
     [--name <new-name>]
 
     [--description <new-description>]
 
     [--description <new-description>]
     [--metadata <key=value>]
+
     <snapshot>
    <volume>
 
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
cinder metadata
+
cinder snapshot-rename
    <volume-id>
 
    <action>
 
    <key=value>
 
 
 
cinder rename
 
 
     --display-description <display-description>
 
     --display-description <display-description>
     <volume-id>
+
     --display-name <display-name>
     <display-name>
+
     <snapshot-id>
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os show volume
+
os snapshot show
     <volume>
+
     <snapshot>
</source>
 
|| yes
 
|| ||
 
<source lang="bash">
 
cinder show
 
    <volume-id>
 
</source>
 
|-
 
|
 
<source lang="bash">
 
os unset volume
 
    [--metadata <key=value>]
 
    <volume>
 
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
 +
cinder snapshot-show
 +
    <snapshot-id>
 
</source>
 
</source>
 
|}
 
|}
  
==== volume-type ====
+
==== volume ====
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 3,267: Line 3,524:
 
|-
 
|-
 
|
 
|
<source lang="bash">
+
<source lang="bash">
os create volume-type
+
os volume create
     <name>
+
    --size <size>
</source>
+
    [--description <description>]
|| yes
+
    [--volume-type <volume-type>]
|| ||
+
    [--snapshot-id <snapshot-id>]
<source lang="bash">
+
    [--source <volid>]
cinder type-create
+
    [--image <image-id>]
     <type-name>
+
    [--availability-zone <availability-zone>]
</source>
+
    [--property <key=value>]
|-
+
    [--user <user>]          # admin only
|
+
    [--project <project>]    # admin only
<source lang="bash">
+
    <name>
os delete volume-type
+
</source>
     <volume-type>
+
|| yes
</source>
+
|| ||
|| yes
+
<source lang="bash">
|| ||
+
cinder create
<source lang="bash">
+
    [--snapshot-id <snapshot-id>]
cinder type-delete
+
    [--source-volid <source-volid>]
     <type-id>
+
    [--image-id <image-id>]
</source>
+
    [--display-name <display-name>]
|-
+
    [--display-description <display-description>]
|
+
    [--volume-type <volume-type>]
<source lang="bash">
+
    [--availability-zone <availability-zone>]
os list volume-type
+
    [--metadata <key=value>]
     [--long]
+
    <size>
</source>
+
</source>
|| yes
+
|-
|| ||
+
|
<source lang="bash">
+
<source lang="bash">
cinder type-list  
+
os volume delete
 
+
    [--force]
cinder extra-specs-list
+
    <volume>
</source>
+
</source>
|-
+
|| yes
|
+
|| ||
<source lang="bash">
+
<source lang="bash">
os set volume-type
+
cinder delete
     [--metadata <key=value>]
+
    <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>
 
     <volume-type>
 
</source>
 
</source>
Line 3,320: Line 3,693:
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os unset volume-type
+
os volume type unset
     [--metadata <key=value>]
+
     [--property <key>]
 
     <volume-type>
 
     <volume-type>
 
</source>
 
</source>
Line 3,336: Line 3,709:
 
== 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 3,490: Line 3,863:
 
set port <tenant> <network> <port> <params>
 
set port <tenant> <network> <port> <params>
 
</source>
 
</source>
 
  
 
= Options =
 
= Options =

Latest revision as of 02:10, 19 July 2013

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

OpenStackClient Commands

Part of the UnifiedCLI proposal

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

Command Structure

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

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

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


Command Arguments

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

Other

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

Verbs

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

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


Objects

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


Global Options

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

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


Common Options

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

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


Command Mapping Summary

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

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


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


Cross API

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

credentials

[consider rolling the ec2 creds into this too]

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

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

limits

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

nova rate-limits

cinder absolute-limits

cinder rate-limits

quota

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

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

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

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

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

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

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

cinder quota-show
    <tenant_id>

nova quota-defaults
    <tenant_id>

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

cinder quota-class-show
    <class>

Identity

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

API v2.0

catalog

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

ec2 credentials

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

endpoint

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

role

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

service

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

tenant

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

token

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

user

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

user role

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

<other>

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

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

API v3

credential

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

domain

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

endpoint

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

group

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

oauth

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

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

policy

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

project

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

role

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

service

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

user

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

Compute

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


API v2 (1.1)

agent

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


aggregate

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

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

bash-completion

OSC Command Implemented Nova command

TBD

no
nova bash-completion

cloudpipe

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

console

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

credentials

See credentials in the cross API section.

diagnostics

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

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

dns

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

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

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

endpoints

Totally duplicates Identity catalog command

OSC Command Implemented Nova command
os endpoint list
no
nova endpoints

fixed-ip

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


flavor

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


floating-ip

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


floating-ip-pool

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


host

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


hypervisor

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


keypair

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


limits

See limits in the cross API section.

quota

See quota in the cross API section.


resource

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

secgroup

OSC Command Implemented Nova command
os secgroup add

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

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

secgroup-group-rule

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

secgroup-rule

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

server

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

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

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

usage

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


volume

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


x509-cert

See credentials in the cross API section.

x509-root-cert

See credentials in the cross API section.

Image

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


API v1

image

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

API v2

image

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


image-member

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

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

os create image-member ...


glance member-delete <IMAGE_ID> <TENANT_ID>

os list image-member <image> [options]


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

os delete image-member ...


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

os list image-member ...

Volume

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


API v1.0

limits

See limits in the cross API section.

quota

See quota in the cross API section.

snapshot

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

volume

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