Jump to: navigation, search

Difference between revisions of "UnifiedCLI/Mapping"

(bash-completion)
(Redirected page to OpenStackClient/Commands)
 
(79 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>]
 +
 
 +
    # Volume settings
 +
    [--gigabytes <new-gigabytes>]
 +
    [--snapshots <new-snapshots>]
 +
    [--volumes <new-volumes>]
  
## what changes if --user is not provided?
+
    <project>
 
</source>
 
</source>
|| in progress
+
|| 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>]
 +
    [--cores <cores>]
 +
    [--ram <ram>]
 +
    [--volumes <volumes>]
 +
    [--gigabytes <gigabytes>]
 +
    [--floating-ips <floating_ips>]
 +
    [--metadata-items <metadata_items>]
 +
    [--injected-files <injected_files>]
 +
    [--injected-file-content-bytes <injected_file_content_bytes>]
 +
    <class>
 +
 
 +
cinder quota-class-update
 +
    [--volumes <volumes>]
 +
    [--snapshots <snapshots>]
 +
    [--gigabytes <gigabytes>]
 +
    <tenant_id>
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os show ec2-credentials
+
os quota show
     <access-key>
+
    [--default]
 
+
     <project>
## what changes if --user is not provided?
 
 
</source>
 
</source>
|| 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>
 
|}
 
  
==== endpoint ====
+
cinder quota-show
 +
    <tenant_id>
 +
 
 +
nova quota-defaults
 +
    <tenant_id>
  
{| class="wikitable"
+
cinder quota-defaults
|-
+
     <tenant_id>
! OSC Command !! Implemented !! !! Keystone command
 
|-
 
|
 
<source lang="bash">
 
os create endpoint
 
    [--region <endpoint-region>
 
    [--publicurl <public-url>]
 
    [--adminurl <admin-url>]
 
    [--internalurl <internal-url>]
 
    <service>
 
</source>
 
|| yes
 
|| ||
 
<source lang="bash">
 
keystone endpoint-create
 
     [--region <endpoint-region>]
 
    [--service_id <service-id>]
 
    [--publicurl <public-url>]
 
    [--adminurl <admin-url>]
 
    [--internalurl <internal-url>]
 
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os delete endpoint
+
os quota show
     <endpoint-id>
+
    --class
 +
     <class>
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone endpoint-delete
+
nova quota-class-show
     <endpoint-id>
+
     <class>
 +
 
 +
cinder quota-class-show
 +
    <class>
 
</source>
 
</source>
|-
+
|}
|
+
 
<source lang="bash">
+
== Identity ==
os list endpoint
+
 
     [--long]
+
{| class="wikitable"
 +
|-
 +
! OSC Option !!  Environment Variable !!  !!  Keystone Option !!  Environment Variable
 +
|-
 +
| --os-identity-api-version <ver> || OS_IDENTITY_API_VERSION ||  || --os-identity-api-version <ver> || OS_IDENTITY_API_VERSION
 +
|-
 +
| --os-token <token> || OS_TOKEN || || --os-token <token> || OS_SERVICE_TOKEN
 +
|-
 +
| --os-url <url> || OS_URL || || --os-endpoint <url> || OS_SERVICE_ENDPOINT
 +
|-
 +
|  ||  || || --os-cert <file> || OS_CERT
 +
|-
 +
|  ||  || || --os-key <key-file> || OS_KEY
 +
|-
 +
|  ||  || || --os-cache || OS_CACHE
 +
|-
 +
|  ||  || || --force-new-token ||
 +
|-
 +
|  ||  || || --stale-duration <seconds> ||
 +
|-
 +
|}
 +
 
 +
=== API v2.0 ===
 +
 
 +
==== catalog ====
 +
 
 +
{| class="wikitable"
 +
|-
 +
! OSC Command !! Implemented !! !! Keystone command
 +
|-
 +
|
 +
<source lang="bash">
 +
os catalog show
 +
     [--service <service>]
 
</source>
 
</source>
|| yes
+
|| no
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone endpoint-list
+
keystone catalog
</source>
+
     [--service <service-type>]
|-
 
|
 
<source lang="bash">
 
os show endpoint
 
     [--type <endpoint-type>]
 
    [--attr <endpoint-attribute>]
 
    [--value <endpoint-value>]
 
    [--all]
 
    <service>
 
</source>
 
|| yes
 
|| ||
 
<source lang="bash">
 
keystone endpoint-get
 
    --service <service-type>
 
    [--endpoint_type <endpoint-type>]
 
    [--attr <service-attribute>]
 
    [--value <value>]
 
 
</source>
 
</source>
 
|}
 
|}
  
 
+
==== ec2 credentials ====
====role====
 
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 315: Line 446:
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os create role
+
os ec2 credentials create
     <role-name>
+
     [--project <project>]
 +
    [--user <user>]
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone role-create --name
+
keystone ec2-credentials-create
     <role-name>
+
    [--user <user-id>]
 +
     [--tenant_id <tenant-id>]
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os delete role
+
os ec2 credentials delete
     <role>
+
     [--user <user>]
 +
    <access-key>
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone role-delete
+
keystone ec2-credentials-delete
     <role-id>
+
     [--user <user-id>]
 +
    --access <access-key>
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os list role
+
os ec2 credentials list
 +
    [--user <user>]
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone role-list
+
keystone ec2-credentials-list
 +
    [--user <user-id>]
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os show role
+
os ec2 credentials show
     <role>
+
     [--user <user>]
 +
    <access-key>
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone role-get
+
keystone ec2-credentials-get
     <role-id>
+
     [--user <user-id>]
 +
    --access <access-key>
 
</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 lang="bash">
 
os show tenant
 
    <tenant>
 
</source>
 
|| yes
 
|| ||
 
<source lang="bash">
 
keystone tenant-get
 
     <tenant-id>
 
 
</source>
 
</source>
 
|}
 
|}
  
 
+
==== service ====
==== token ====
 
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 504: Line 629:
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os show token
+
os service create
     [--width <token-display-width>]
+
     [--type <service-type>]
 +
    [--description <service-description>]
 +
    <service-name>
 
</source>
 
</source>
|| ??
+
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone token-get [--wrap <integer>]
+
keystone service-create
 +
    --name <name>
 +
    --type <type>
 +
    [--description <service-description>]
 
</source>
 
</source>
|}
+
|-
 
 
 
 
====user====
 
 
 
{| class="wikitable"
 
|-
 
! OSC Command !! Implemented !! !! Keystone command
 
|-
 
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os create user
+
os service delete
     [--password <user-password>]
+
     <service>
    [--email <user-email>]
 
    [--tenant <tenant>]
 
    [--enable | --disable]
 
    <user-name>
 
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone user-create
+
keystone service-delete
     --name <user-name>
+
     <service-id>
    [--tenant_id <tenant-id>]
 
    [--pass <pass>]
 
    [--email <email>]
 
    [--enabled <true|false>]
 
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os delete user
+
os service list
     <user>
+
     [--long]
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone user-delete
+
keystone service-list
    <user-id>
 
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os list user
+
os service show
     [--tenant <tenant>]
+
     [--catalog]
     [--long]
+
     <service>
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone user-list
+
keystone service-get
     [<tenant-id>]
+
     <service-id>
 
</source>
 
</source>
 +
|}
 +
 +
==== tenant ====
 +
 +
{| class="wikitable"
 +
|-
 +
! OSC Command !! Implemented !! !! Keystone command
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os set user
+
os tenant create
    [--name <new-user-name>]
+
     [--description <description>]
    [--password <user-password>]
+
     [--enable | --disable]
    [--email <user-email>]
+
     <tenant-name>
     [--tenant <tenant>]
 
     [--enable|--disable]
 
     <user>
 
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone user-password-update
+
keystone tenant-create
     --pass <password>
+
    --name <tenant-name>
     <user-id>
+
     [--description <tenant-description>]
 +
     [--enabled <true|false>]
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os show user
+
os tenant delete
     <user>
+
     <tenant>
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone user-get
+
keystone tenant-delete
     <user-id>
+
     <tenant>
 
</source>
 
</source>
|}
 
 
 
====user-role====
 
 
{| class="wikitable"
 
|-
 
! OSC Command !! Implemented !! !! Keystone command
 
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os add role-user
+
os tenant list
     [--tenant <tenant>]
+
     [--long]
    <role> <user>
 
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone user-role-add
+
keystone tenant-list
    --user <user-id>
+
</source>
    --role <role-id>
 
    [--tenant_id <tenant-id>]
 
</source>
 
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os list role-user
+
os tenant set
     [--tenant <tenant>]
+
    [--name <new-tenant-name>]
     [<user>]
+
     [--description <new-tenant-description>]
 +
     [--enable | --disable]
 +
    <tenant>
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone user-role-list
+
keystone tenant-update
     [--user <user-id>]
+
    [--name <tenant_name>]
     [--tenant_id <tenant-id>]
+
     [--description <tenant-description>]
 +
     [--enabled <true|false>]
 +
    <tenant-id>
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os remove role-user
+
os tenant show
     [--tenant <tenant>]
+
     <tenant>
    <role> <user>
 
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone user-role-remove
+
keystone tenant-get
    --user <user-id>
+
     <tenant-id>
    --role <role-id>
 
     [--tenant_id <tenant-id>]
 
 
</source>
 
</source>
 
|}
 
|}
  
 +
==== token ====
  
====<other>====
+
{| class="wikitable"
 
+
|-
 +
! OSC Command !! Implemented !! !! Keystone command
 +
|-
 +
|
 
<source lang="bash">
 
<source lang="bash">
keystone bootstrap
+
os token show
        --pass <password>
+
    [--width <token-display-width>]
        [--user-name <user-name>]
+
</source>
        [--role-name <role-name>]
+
|| ??
        [--tenant-name <tenant-name>]
+
|| ||
 
 
## do not create in openstackclient, since it is in contribute
 
</source>
 
 
 
 
 
 
 
 
<source lang="bash">
 
<source lang="bash">
keystone discover
+
keystone token-get [--wrap <integer>]
 
 
## do not create in openstackclient, obsolete.
 
 
</source>
 
</source>
 +
|}
  
=== API v3 ===
+
==== user ====
 
 
====credential====
 
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 680: Line 782:
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os create credential
+
os user create
     [--project <project>]
+
     [--password <user-password>]
     [--type ec2|cert]
+
     [--email <user-email>]
     <user>
+
     [--tenant <tenant>]
     <data>
+
    [--enable | --disable]
 +
     <user-name>
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone credential-create
+
keystone user-create
     --user_id <user-id>
+
     --name <user-name>  
     --type <credential-type>
+
     [--tenant_id <tenant-id>]
     --data <credential-data>
+
     [--pass <pass>]
     [--project_id <project-id>]
+
    [--email <email>]
 +
     [--enabled <true|false>]
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os delete credential
+
os user delete
     <credential-id>
+
     <user>
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone credential-delete
+
keystone user-delete
     <credential-id>
+
     <user-id>
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os list credential
+
os user list
 +
    [--tenant <tenant>]
 +
    [--long]
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone credential-list
+
keystone user-list
 +
    [<tenant-id>]
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os set credential
+
os user set
     [--user <user>]
+
     [--name <new-user-name>]
     [--type ec2|cert]
+
     [--password <user-password>]
     [--data <data>]
+
     [--email <user-email>]
     [--project <project>]
+
     [--tenant <tenant>]
     <credential-id>
+
    [--enable|--disable]
 +
     <user>
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone credential-update
+
keystone user-password-update
    [--user <user>]
+
     --pass <password>
    [--type <type>]
+
     <user-id>
    [--data <data>]
 
     [--project <project>]
 
     <credential-id>
 
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os show credential
+
os user show
     <credential-id>
+
     <user>
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone credential-get
+
keystone user-get
     <credential-id>
+
     <user-id>
 
</source>
 
</source>
 
|}
 
|}
  
====domain====
+
==== user role ====
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 759: Line 864:
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os create domain
+
os user role add
     [--description <domain-description>]
+
     [--tenant <tenant>]
     [--enable | --disable]
+
     <user>
     <domain-name>
+
     <role>
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone domain-create
+
keystone user-role-add
     --name <domain-name>
+
     --user <user-id>
     [--description <domain-description>]
+
     --role <role-id>
     [--enabled <true|false>]
+
     [--tenant_id <tenant-id>]
    [--private_project_names <true|false>]
 
    [--private_user_names <true|false>]
 
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os delete domain
+
os user role list
     <domain>
+
     [--tenant <tenant>]
 +
    [<user>]
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone domain-delete
+
keystone user-role-list
     <domain-id>
+
     [--user <user-id>]
 +
    [--tenant_id <tenant-id>]
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os list domain
+
os user role remove
 +
    [--tenant <tenant>]
 +
    <user>
 +
    <role>
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone domain-list
+
keystone user-role-remove
 +
    --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 set domain
+
keystone bootstrap
    [--name <new-domain-name>]
+
        --pass <password>
    [--description <new-domain-description>]
+
        [--user-name <user-name>]
    [--enable | --disable]
+
        [--role-name <role-name>]
    <domain>
+
        [--tenant-name <tenant-name>]
 
</source>
 
</source>
|| yes
+
 
|| ||
 
 
<source lang="bash">
 
<source lang="bash">
keystone domain-update
+
keystone discover
    [--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">
 
os show domain
 
    <domain>
 
</source>
 
|| yes
 
|| ||
 
<source lang="bash">
 
keystone domain-get
 
    <domain-id>
 
</source>
 
|}
 
  
==== endpoint ====
+
=== API v3 ===
 +
 
 +
==== credential ====
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 838: Line 935:
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os create endpoint
+
os credential create
     [--region <endpoint-region>
+
     [--project <project>]
     [--enable | --disable]
+
     [--type ec2|cert]
     <service>
+
     <user>
    <interface admin|public|internal>
+
     <data>
     <url>
 
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone endpoint-create  
+
keystone credential-create
     [--region <endpoint-region>
+
     --user_id <user-id>
     [--enable | --disable]
+
     --type <credential-type>
    <service_id>
+
     --data <credential-data>
     <interface admin|public|internal>
+
     [--project_id <project-id>]
     <url>
 
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os delete endpoint
+
os credential delete
     <endpoint-id>
+
     <credential-id>
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
 +
keystone credential-delete
 +
    <credential-id>
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os list endpoint
+
os credential list
    [--long]
 
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone endpoint-list
+
keystone credential-list
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os set endpoint
+
os credential set
     [--interface <endpoint-interface>]
+
     [--user <user>]
     [--url <endpoint-url>]
+
     [--type ec2|cert]
     [--service <service-id>]
+
     [--data <data>]
     [--region <endpoint-region>]
+
     [--project <project>]
     [--enable | --disable]
+
     <credential-id>
    <endpoint>
 
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone endpoint-set
+
keystone credential-update
     [--interface <endpoint-interface>]
+
     [--user <user>]
     [--url <endpoint-url>]
+
     [--type <type>]
     [--service <service-id>]
+
     [--data <data>]
     [--region <endpoint-region>]
+
     [--project <project>]
     [--enable | --disable]
+
     <credential-id>
    <endpoint>
 
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os show endpoint
+
os credential show
     <endpoint>
+
     <credential-id>
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone endpoint-get  
+
keystone credential-get
     <endpoint>
+
     <credential-id>
 
</source>
 
</source>
 
|}
 
|}
  
====group====
+
==== domain ====
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 920: Line 1,014:
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os create group
+
os domain create
     [--domain <domain>]
+
     [--description <domain-description>]
     [--description <group-description>]
+
     [--enable | --disable]
     <group-name>
+
     <domain-name>
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone group-create
+
keystone domain-create
     --name <group-name>
+
     --name <domain-name>
     [--domain_id <domain-id>]
+
     [--description <domain-description>]
     [--description <group-description>]
+
     [--enabled <true|false>]
 +
    [--private_project_names <true|false>]
 +
    [--private_user_names <true|false>]
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os delete group
+
os domain delete
     <group>
+
     <domain>
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone group-delete
+
keystone domain-delete
     <group-id>
+
     <domain-id>
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os list group
+
os domain list
    [--long]
 
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone group-list
+
keystone domain-list
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os set group
+
os domain set
     [--name <new-group-name>]
+
     [--name <new-domain-name>]
     [--domain <domain>]
+
     [--description <new-domain-description>]
     [--description <new-group-description>]
+
     [--enable | --disable]
     <group>
+
     <domain>
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone group-update
+
keystone domain-update
     [--name <group_name>]
+
     [--name <domain_name>]
     [--domain_id <domain-id>]
+
     [--description <domain-description>]
     [--description <group-description>]
+
     [--enabled <true|false>]
     <group-id>
+
    [--private_project_names <true|false>]
 +
    [--private_user_names <true|false>]
 +
     <domain-id>
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os show group
+
os domain show
     <group>
+
     <domain>
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone group-get
+
keystone domain-get
     <group-id>
+
     <domain-id>
 
</source>
 
</source>
 
|}
 
|}
  
====policy====
+
==== endpoint ====
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 996: Line 1,093:
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os create policy
+
os endpoint create
     [--type <policy-type>]
+
     [--region <endpoint-region>
     --blob-file <blob-file>
+
     [--enable | --disable]
 +
    <service>
 +
    <interface admin|public|internal>
 +
    <url>
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone policy-create
+
keystone endpoint-create  
     --type <policy-type>
+
     [--region <endpoint-region>
     --blob <policy-blob>
+
     [--enable | --disable]
 +
    <service_id>
 +
    <interface admin|public|internal>
 +
    <url>
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os delete policy
+
os endpoint delete
     <policy-id>
+
     <endpoint-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 list policy
+
os endpoint list
     [--include-blob]
+
     [--long]
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone policy-list
+
keystone endpoint-list
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os set policy
+
os endpoint set
     [--type <policy-type>]
+
     [--interface <endpoint-interface>]
     [--blob-file<blob-file>]
+
     [--url <endpoint-url>]
     <policy-id>
+
    [--service <service-id>]
 +
     [--region <endpoint-region>]
 +
    [--enable | --disable]
 +
    <endpoint>
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone policy-update
+
keystone endpoint-set
     [--type <policy-type>]
+
     [--interface <endpoint-interface>]
     [--blob <policy-blob>]
+
     [--url <endpoint-url>]
     <policy-id>
+
     [--service <service-id>]
 +
    [--region <endpoint-region>]
 +
    [--enable | --disable]
 +
    <endpoint>
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os show policy
+
os endpoint show
     <policy-id>
+
     <endpoint>
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone policy-get
+
keystone endpoint-get  
     <policy-id>
+
     <endpoint>
 
</source>
 
</source>
 
|}
 
|}
  
====project====
+
==== group ====
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 1,068: Line 1,175:
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os create project
+
os group create
     [--domain <project-domain>]
+
     [--domain <domain>]
     [--description <project-description>]
+
     [--description <group-description>]
    [--enable | --disable]
+
     <group-name>
     <project-name>
 
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone project-create
+
keystone group-create
     [--domain_id <domain_id>]
+
     --name <group-name>
     [--description <description>]
+
     [--domain_id <domain-id>]
     [--enable | --disable]
+
     [--description <group-description>]
    <name>
 
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os delete project
+
os group delete
     <project>
+
     <group>
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
os project-delete
+
keystone group-delete
     <project_id>
+
     <group-id>
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os list project [--long]
+
os group list
 +
    [--long]
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone project-list
+
keystone group-list
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os set project
+
os group set
     [--name <new-project-name>]
+
     [--name <new-group-name>]
     [--domain <project-domain>]
+
     [--domain <domain>]
     [--description <new-project-description>]
+
     [--description <new-group-description>]
    [--enable | --disable]
+
     <group>
     <project>
 
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone project-set
+
keystone group-update
     [--name <new-project-name>]
+
     [--name <group_name>]
     [--domain <project-domain>]
+
     [--domain_id <domain-id>]
     [--description <new-project-description>]
+
     [--description <group-description>]
     [--enable | --disable]
+
     <group-id>
    <project_id>
 
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os show project
+
os group show
     <project>
+
     <group>
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone project-get
+
keystone group-get
     <project_id>
+
     <group-id>
 
</source>
 
</source>
 
|}
 
|}
  
====role====
+
==== oauth ====
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 1,147: Line 1,251:
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os add role
+
os access token create
     [--user <user> | --group <group>]
+
     --consumer-key <consumer-key>
     [--domain <domain> | --project <project>]
+
    --consumer-secret <consumer-secret>
     <role>
+
     --request-key <request-key>
 +
    --request-secret <request-secret>
 +
     --verifier <pin>
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
 +
n/a
 
</source>
 
</source>
 +
|-
 +
| look at some alternatives: || || ||
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os create role
+
os oauth token create
     <role-name>
+
     --consumer-key <consumer-key>
 +
    --consumer-secret <consumer-secret>
 +
    --request-key <request-key>
 +
    --request-secret <request-secret>
 +
    --verifier <pin>
 
</source>
 
</source>
|| yes
+
|| nyet
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
 +
* makes the token specific to oauth
 +
* add [--oauth-ver X] if versioning for oauth2 is an issue?
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os delete role
+
os oauth token create
     <role>
+
     --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">
 +
* collapse 'access token' and 'request token' into 'oauth token'?
 
</source>
 
</source>
 +
|}
 +
 +
==== policy ====
 +
 +
{| class="wikitable"
 +
|-
 +
! OSC Command !! Implemented !! !! Keystone command
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os list role
+
os policy create
 +
    [--type <policy-type>]
 +
    --blob-file <blob-file>
 
</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 list user-role
+
os policy delete
 +
    <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 list group-role
+
os policy list
 +
    [--include-blob]
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
 +
keystone policy-list
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os remove role
+
os policy set
     [--user <user> | --group <group>]
+
     [--type <policy-type>]
     [--domain <domain> | --project <project>]
+
     [--blob-file<blob-file>]
     <role>
+
     <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 set role
+
os policy show
     [--name <new-role-name>]
+
     <policy-id>
    <role>
 
</source>
 
|| yes
 
|| ||
 
<source lang="bash">
 
</source>
 
|-
 
|
 
<source lang="bash">
 
os show role
 
    <role>
 
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
 +
keystone policy-get
 +
    <policy-id>
 
</source>
 
</source>
 
|}
 
|}
  
====service====
+
==== project ====
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 1,246: Line 1,384:
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os create service
+
os project create
[--name <name>]
+
    [--domain <project-domain>]
        [--enabled <true|false>]
+
    [--description <project-description>]
        <type>
+
    [--enable | --disable]
 +
    <project-name>
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone service-create
+
keystone project-create
[--name <name>]
+
    [--domain_id <domain_id>]
        [--enabled <true|false>]
+
    [--description <description>]
        <type>
+
    [--enable | --disable]
 +
    <name>
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os delete service
+
os project delete
     <service>
+
     <project>
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone service-delete
+
os project-delete
     <service_id>
+
     <project_id>
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os list service
+
os project list
 +
    [--long]
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone service-list
+
keystone project-list
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os set service
+
os project set
     [--type <service-type>]
+
     [--name <new-project-name>]
     [--name <new-name>]
+
    [--domain <project-domain>]
 +
     [--description <new-project-description>]
 
     [--enable | --disable]
 
     [--enable | --disable]
     <service>
+
     <project>
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone service-set
+
keystone project-set
     [--type <service-type>]
+
     [--name <new-project-name>]
     [--name <new-name>]
+
    [--domain <project-domain>]
 +
     [--description <new-project-description>]
 
     [--enable | --disable]
 
     [--enable | --disable]
     <service>
+
     <project_id>
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os show service
+
os project show
     <service>
+
     <project>
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone service-get  
+
keystone project-get
     <service_id>
+
     <project_id>
 
</source>
 
</source>
 
|}
 
|}
  
====user====
+
==== role ====
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 1,321: Line 1,464:
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os create user
+
os role add
     [--password <password>]
+
     [--user <user> | --group <group>]
    [--project <project>]
+
     [--domain <domain> | --project <project>]
     [--email <user-email>]
+
     <role>
    [--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 create
     <user>
+
     <role-name>
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone user-delete
 
    <user-id>
 
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os list user
+
os role delete
     [--project <project>]
+
     <role>
    [--long]
 
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone user-list
 
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os set user
+
os role list
     [--name <new-name>]
+
</source>
     [--password <password>]
+
|| yes
    [--project <project>]
+
|| ||
     [--email <user-email>]
+
<source lang="bash">
     [--enable | --disable]
+
</source>
     <user>
+
|-
 +
|
 +
<source lang="bash">
 +
os role remove
 +
     [--user <user> | --group <group>]
 +
     [--domain <domain> | --project <project>]
 +
     <role>
 +
</source>
 +
|| yes
 +
|| ||
 +
<source lang="bash">
 +
</source>
 +
|-
 +
|
 +
<source lang="bash">
 +
os role set
 +
     [--name <new-role-name>]
 +
     <role>
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone user-update
 
    --user_id <user-id>
 
    [--name <user-name>]
 
    [--domain_id <domain-id>]
 
    [--default_project_id <project-id>]
 
    [--description <description>]
 
    [--enabled <true|false>]
 
    [--password <password>]
 
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os show user
+
os role show
     <user>
+
     <role>
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone user-get
 
    <user-id>
 
 
</source>
 
</source>
 
|}
 
|}
  
== Compute ==
+
==== service ====
 
 
 
 
{| 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"
 
{| class="wikitable"
|-
+
|-
! OSC Command !! Implemented !! !! Nova command
+
! OSC Command !! Implemented !! !! Keystone command
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os create agent
+
os service create
    <os>
+
[--name <name>]
    <architecture>
+
        [--enabled <true|false>]
    <version>
+
        <type>
    <url>
 
    <md5hash>
 
    <hypervisor>
 
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
|-
 
|
 
 
<source lang="bash">
 
<source lang="bash">
os delete agent
+
keystone service-create
    <id>
+
[--name <name>]
 +
        [--enabled <true|false>]
 +
        <type>
 
</source>
 
</source>
|| yes
 
|| ||
 
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os list agent
+
os service delete
     [--hypervisor <hypervisor>]
+
     <service>
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
|-
 
|
 
 
<source lang="bash">
 
<source lang="bash">
os set agent
+
keystone service-delete
     <id>
+
     <service_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 list service
    <aggregate>
 
    <host>
 
 
</source>
 
</source>
|| no
+
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova aggregate-add-host
+
keystone service-list
    <id>
 
    <host>
 
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os create aggregate
+
os service set
     <name>
+
     [--type <service-type>]
     <availability_zone>
+
    [--name <new-name>]
 +
    [--enable | --disable]
 +
     <service>
 
</source>
 
</source>
|| no
+
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova aggregate-create
+
keystone service-set
     <name>
+
     [--type <service-type>]
     <availability_zone>
+
    [--name <new-name>]
 +
    [--enable | --disable]
 +
     <service>
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os delete aggregate
+
os service show
     <aggregate>
+
     <service>
 
</source>
 
</source>
|| no
+
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova aggregate-delete
+
keystone service-get
     <id>
+
     <service_id>
 
</source>
 
</source>
 +
|}
 +
 +
==== user ====
 +
 +
{| class="wikitable"
 +
|-
 +
! OSC Command !! Implemented !! !! Keystone command
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os list aggregate
+
os user create
 +
    [--password <password>]
 +
    [--project <project>]
 +
    [--email <user-email>]
 +
    [--enable | --disable]
 +
    <name>
 
</source>
 
</source>
|| no
+
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova aggregate-list
+
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 remove aggregate
+
os user delete
     <aggregate>
+
     <user>
    <host>
 
 
</source>
 
</source>
|| no
+
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova aggregate-remove-host
+
keystone user-delete
     <id>
+
     <user-id>
    <host>
 
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os set aggregate
+
os user list
     [--name <new-name>]
+
     [--project <project>]
    [--zone <availability-zone>]
+
     [--long]
     [--property <key=value>]
 
    <aggregate>
 
 
</source>
 
</source>
|| no
+
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova aggregate-update
+
keystone user-list
    <id>
 
    <name>
 
    [<availability_zone>]
 
 
 
nova aggregate-set-metadata
 
    <id>
 
    <key=value>
 
    [<key=value> ...]
 
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os show aggregate
+
os user set
     <aggregate>
+
     [--name <new-name>]
</source>
+
    [--password <password>]
|| no
+
    [--project <project>]
 +
    [--email <user-email>]
 +
    [--enable | --disable]
 +
    <user>
 +
</source>
 +
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova aggregate-details
+
keystone user-update
     <id>
+
     --user_id <user-id>
 +
    [--name <user-name>]
 +
    [--domain_id <domain-id>]
 +
    [--default_project_id <project-id>]
 +
    [--description <description>]
 +
    [--enabled <true|false>]
 +
    [--password <password>]
 
</source>
 
</source>
|}
 
 
 
==== bash-completion ====
 
 
{| class="wikitable"
 
|-
 
! OSC Command !! Implemented !! !! Nova command
 
 
|-
 
|-
 
|
 
|
TBD
+
<source lang="bash">
|| no
+
os user show
 +
    <user>
 +
</source>
 +
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova bash-completion
+
keystone user-get
 +
    <user-id>
 
</source>
 
</source>
 
|}
 
|}
  
==== cloudpipe ====
+
== Compute ==
 +
 
 +
 
 +
{| class="wikitable"
 +
|-
 +
! OSC Option !! Environment Variable !! !! Nova Option !! Environment Variable
 +
|-
 +
| || || || --os-auth-system <auth-system> || OS_AUTH_SYSTEM
 +
|-
 +
| || || || --service-type <type> ||
 +
|-
 +
| || || || --service-name <name> || NOVA_SERVICE_NAME
 +
|-
 +
| || || || --volume-service-name <name> || NOVA_VOLUME_SERVICE_NAME
 +
|-
 +
| || || || --endpoint-type <type> || NOVA_ENDPOINT_TYPE
 +
|-
 +
| --os-compute-api-version <ver> || OS_COMPUTE_API_VERSION || || --os-compute-api-version <ver> || OS_COMPUTE_API_VERSION
 +
|-
 +
| || || || --bypass-url <bypass-url> ||
 +
|}
 +
 
 +
 
 +
=== API v2 (1.1) ===
 +
 
 +
==== agent ====
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 1,602: Line 1,732:
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os create cloudpipe
+
os agent create
     <project>
+
     <os>
 +
    <architecture>
 +
    <version>
 +
    <url>
 +
    <md5hash>
 +
    <hypervisor>
 
</source>
 
</source>
|| no
+
|| yes
 
|| ||
 
|| ||
 +
|-
 +
|
 
<source lang="bash">
 
<source lang="bash">
nova cloudpipe-create
+
os agent delete
     <project>
+
     <id>
 
</source>
 
</source>
 +
|| yes
 +
|| ||
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os list cloudpipe
+
os agent list  
 +
    [--hypervisor <hypervisor>]
 
</source>
 
</source>
|| no
+
|| yes
 
|| ||
 
|| ||
 +
|-
 +
|
 
<source lang="bash">
 
<source lang="bash">
nova cloudpipe-list
+
os agent set
 +
    <id>
 +
    <version>
 +
    <url>
 +
    <md5hash>
 
</source>
 
</source>
 +
|| yes
 +
|| ||
 
|}
 
|}
  
==== console ====
+
 
 +
==== aggregate ====
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 1,631: Line 1,780:
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os show console-log
+
os aggregate add host
     [--lines <num-lines>]
+
     <aggregate>
     <server>
+
     <host>
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova console-log
+
nova aggregate-add-host
     [--length <length>]
+
     <id>
     <server>
+
     <host>
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os show console-url
+
os aggregate create
     [--novnc | --xvpvnc | --spice]
+
     [--zone <availability-zone>]
     <server>
+
    [--property <key=value>]
 +
     <name>
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova get-vnc-console
+
nova aggregate-create
     <server>
+
     <name>
     <console_type>
+
     [<availability_zone>]
 
</source>
 
</source>
|}
+
|-
 
+
|
'''credentials'''
 
 
 
 
<source lang="bash">
 
<source lang="bash">
nova credentials
+
os aggregate delete
 
+
    <aggregate>
os show credentials
 
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
'''diagnostics'''
 
 
 
 
<source lang="bash">
 
<source lang="bash">
nova diagnostics <server>
+
nova aggregate-delete
 
+
    <id>
os show diagnostics ...
 
 
</source>
 
</source>
 
+
|-
 
+
|
'''dns'''
 
 
 
 
<source lang="bash">
 
<source lang="bash">
nova dns-create [--type <type>] <ip> <name> <domain>
+
os aggregate list
 
+
    [--long]
os create dns ...
 
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova dns-delete <domain> <name>
+
nova aggregate-list
 
 
os delete dns ...
 
 
</source>
 
</source>
 
+
|-
 
+
|
 
<source lang="bash">
 
<source lang="bash">
nova dns-list [--ip <ip>] [--name <name>] <domain>
+
os aggregate remove host
 
+
    <aggregate>
os list dns ...
+
    <host>
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
'''dns-domain'''
 
 
 
 
<source lang="bash">
 
<source lang="bash">
nova dns-create-private-domain [--availability_zone <availability_zone>]
+
nova aggregate-remove-host
                              <domain>
+
    <id>
 
+
    <host>
os create dns-domain [--private] ...
 
 
</source>
 
</source>
 
+
|-
 
+
|
'''dns-public-domain'''
 
 
 
 
<source lang="bash">
 
<source lang="bash">
nova dns-create-public-domain [--project <project>] <domain>
+
os aggregate set
 
+
    [--name <new-name>]
os create dns-domain [--public] ...
+
    [--zone <availability-zone>]
 +
    [--property <key=value>]
 +
    <aggregate>
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova dns-delete-domain <domain>
+
nova aggregate-update
 +
    <id>
 +
    <name>
 +
    [<availability_zone>]
  
os delete dns-domain ...
+
nova aggregate-set-metadata
 +
    <id>
 +
    <key=value>
 +
    [<key=value> ...]
 
</source>
 
</source>
 
+
|-
 
+
|
 +
<source lang="bash">
 +
os aggregate show
 +
    <aggregate>
 +
</source>
 +
|| yes
 +
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova dns-domains
+
nova aggregate-details
 
+
    <id>
os list dns-domains
 
 
</source>
 
</source>
 +
|}
  
 +
==== bash-completion ====
  
'''endpoints'''
+
{| class="wikitable"
 
+
|-
 +
! OSC Command !! Implemented !! !! Nova command
 +
|-
 +
|
 +
TBD
 +
|| no
 +
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova endpoints
+
nova bash-completion
 
 
os list endpoints
 
 
 
# does this overlap with keystone?
 
 
</source>
 
</source>
 +
|}
  
==== fixed-ip ====
+
==== cloudpipe ====
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 1,750: Line 1,902:
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os add fixed-ip
+
os create cloudpipe
     <network>
+
     <project>
    <server>
 
 
</source>
 
</source>
|| yes
+
|| no
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova add-fixed-ip
+
nova cloudpipe-create
    <server>
+
     <project>
     <network_id>
 
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os remove fixed-ip
+
os list cloudpipe
    <ip-address>
 
    <server>
 
 
</source>
 
</source>
|| yes
+
|| no
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova remove-fixed-ip
+
nova cloudpipe-list
    <server>
 
    <address>
 
 
</source>
 
</source>
 
|}
 
|}
  
 
+
==== console ====
==== flavor ====
 
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 1,786: Line 1,931:
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os create flavor
+
os console log show
     [--id <id>]
+
     [--lines <num-lines>]
    [--ram <size-mb>]
+
     <server>
    [--disk <size-gb>]
 
    [--ephemeral-disk <size-gb>]
 
    [--swap <size-mb>]
 
    [--vcpus <num-cpu>]
 
    [--rxtx-factor <factor>]
 
    [--public | --private]
 
     <name>
 
 
</source>
 
</source>
||
+
|| yes
 +
|| ||
 
<source lang="bash">
 
<source lang="bash">
(partial)
+
nova console-log
default: auto
+
     [--length <length>]
default: 256M
+
     <server>
default: 0G
+
</source>
default: 0G
 
default: 0G
 
default: 1
 
default: 1
 
default: public
 
 
 
</source>
 
|| ||
 
<source lang="bash">
 
nova flavor-create
 
    [--ephemeral <ephemeral>]
 
    [--swap <swap>]
 
     [--rxtx-factor <factor>]
 
     <name>
 
    <id>
 
    <ram>
 
    <disk>
 
    <vcpus>
 
</source>
 
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os delete flavor
+
os console url show
     <flavor>
+
    [--novnc | --xvpvnc | --spice]
 +
     <server>
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova flavor-delete
+
nova get-vnc-console
     <id>
+
    <server>
 +
     <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 flavor
+
os diagnostics show
 +
    <server>
 
</source>
 
</source>
|| yes
+
|| no
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova flavor-list
+
nova diagnostics
</source>
+
     <server>
|-
 
|
 
<source lang="bash">
 
os show flavor
 
     <flavor>
 
 
</source>
 
</source>
|| yes
 
|| ||
 
 
|}
 
|}
  
 +
==== dns ====
  
==== floating-ip ====
+
''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,863: Line 1,991:
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os add floating-ip
+
os create dns
     <ip-address>
+
    [--type <type>]
     <server>
+
    <ip>
 +
     <name>
 +
     <domain>
 
</source>
 
</source>
|| yes
+
|| no
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova add-floating-ip
+
nova dns-create
     <server>
+
    [--type <type>]
     <address>
+
    <ip>
 +
     <name>
 +
     <domain>
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os create floating-ip
+
os delete dns
     [<pool>]
+
     <domain>
 +
    <name>
 
</source>
 
</source>
|| yes
+
|| no
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova floating-ip-create
+
nova dns-delete
     [<floating_ip_pool>]
+
    <domain>
 +
     <name>
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os delete floating-ip
+
os list dns
     <ip-address>
+
    [--ip <ip>]
 +
    [--name <name>]
 +
     <domain>
 
</source>
 
</source>
|| yes
+
|| no
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova floating-ip-delete
+
nova dns-list
     <address>
+
    [--ip <ip>]
 +
    [--name <name>]
 +
     <domain>
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os list floating-ip
+
os create dns-domain
 +
    [--project <project>]
 +
    [--availability-zone <availability-zone>]
 +
    [--public | --private]
 +
    <domain>
 
</source>
 
</source>
|| yes
+
|| no
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova floating-ip-list
+
nova dns-create-private-domain
 +
    [--availability_zone <availability_zone>]
 +
    <domain>
 +
 
 +
nova dns-create-public-domain
 +
    [--project <project>]
 +
    <domain>
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os remove floating-ip
+
os delete dns-domain
     <ip-address>
+
     <domain>
    <server>
 
 
</source>
 
</source>
|| yes
+
|| no
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova remove-floating-ip
+
nova dns-delete-domain
     <server>
+
     <domain>
    <address>
 
 
</source>
 
</source>
|}
 
 
 
==== floating-ip-pool ====
 
 
 
{| class="wikitable"
 
|-
 
! OSC Command !! Implemented !! !! Nova command
 
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os list floating-ip-pool
+
os list dns-domains
 
</source>
 
</source>
|| yes
+
|| no
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova floating-ip-pool-list
+
nova dns-domains
 
</source>
 
</source>
 
|}
 
|}
  
 +
==== endpoints ====
  
==== host ====
+
''Totally duplicates Identity catalog command''
 
 
 
{| class="wikitable"
 
{| class="wikitable"
 
|-
 
|-
Line 1,952: Line 2,089:
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os list host
+
os endpoint list
    [--zone <availability-zone>]
 
 
</source>
 
</source>
|| yes
+
|| no
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova host-action
+
nova endpoints
    [--action <action>]
 
    <hostname>
 
 
</source>
 
</source>
 +
|}
 +
 +
==== fixed-ip ====
 +
 +
{| class="wikitable"
 +
|-
 +
! OSC Command !! Implemented !! !! Nova command
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os set host
+
os ip fixed add
     ...
+
     <network>
 +
    <server>
 
</source>
 
</source>
|| no
+
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova host-update
+
nova add-fixed-ip
    [--status <status>]
+
     <server>
     [--maintenance <maintenance_mode>]
+
     <network_id>
     <hostname>
 
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os show host
+
os ip fixed remove
     <host>
+
     <ip-address>
 +
    <server>
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
|}
+
<source lang="bash">
 
+
nova remove-fixed-ip
 
+
    <server>
==== hypervisor ====
+
     <address>
 
 
{| class="wikitable"
 
|-
 
! OSC Command !! Implemented !! !! Nova command
 
|-
 
|
 
<source lang="bash">
 
os list hypervisor
 
     [--matching <hostname>]
 
 
</source>
 
</source>
|| yes
 
|| ||
 
|-
 
|
 
<source lang="bash">
 
os show hypervisor
 
    <id>
 
</source>
 
|| yes
 
|| ||
 
 
|}
 
|}
  
  
==== keypair ====
+
==== flavor ====
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 2,019: Line 2,142:
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os create keypair
+
os flavor create
     [--public-key <file>]
+
     [--id <id>]
 +
    [--ram <size-mb>]
 +
    [--disk <size-gb>]
 +
    [--ephemeral-disk <size-gb>]
 +
    [--swap <size-mb>]
 +
    [--vcpus <num-cpu>]
 +
    [--rxtx-factor <factor>]
 +
    [--public | --private]
 
     <name>
 
     <name>
 
</source>
 
</source>
|| yes
+
||
|| ||
 
 
<source lang="bash">
 
<source lang="bash">
nova keypair-add
+
(partial)
     [--pub_key <pub_key>]
+
default: auto
 +
default: 256M
 +
default: 0G
 +
default: 0G
 +
default: 0G
 +
default: 1
 +
default: 1
 +
default: public
 +
 
 +
</source>
 +
|| ||
 +
<source lang="bash">
 +
nova flavor-create
 +
    [--ephemeral <ephemeral>]
 +
    [--swap <swap>]
 +
     [--rxtx-factor <factor>]
 
     <name>
 
     <name>
 +
    <id>
 +
    <ram>
 +
    <disk>
 +
    <vcpus>
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os delete keypair
+
os flavor delete
     <name>
+
     <flavor>
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova keypair-delete
+
nova flavor-delete  
     <name>
+
     <id>
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os list keypair
+
os flavor list
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova keypair-list
+
nova flavor-list
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os show keypair
+
os flavor show
    [--public-key]
+
     <flavor>
     <name>
 
 
</source>
 
</source>
 
|| yes
 
|| yes
Line 2,064: Line 2,211:
  
  
'''limits'''
+
==== floating-ip ====
  
<source lang="bash">
+
{| class="wikitable"
nova absolute-limits
+
|-
 
+
! OSC Command !! Implemented !! !! Nova command
os show limits --absolute
+
|-
## is there any other kind?
+
|
 +
<source lang="bash">
 +
os ip floating add
 +
    <ip-address>
 +
    <server>
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
'''quota'''
 
 
 
 
<source lang="bash">
 
<source lang="bash">
nova quota-defaults <tenant_id>
+
nova add-floating-ip
nova quota-show <tenant_id>
+
    <server>
 
+
    <address>
os show quota <tenant> [--defaults]
 
 
</source>
 
</source>
 
+
|-
 
+
|
 
<source lang="bash">
 
<source lang="bash">
nova quota-update [--instances <instances>]
+
os ip floating create
                  [--cores <cores>]
+
    [<pool>]
                  [--ram <ram>]
 
                  [--volumes <volumes>]
 
                  [--gigabytes <gigabytes>]
 
                  [--floating-ips <floating_ips>]
 
                  [--metadata-items <metadata_items>]
 
                  [--injected-files <injected_files>]
 
                  [--injected-file-content-bytes <injected_file_content_bytes>]
 
                  <tenant_id>
 
 
 
os set quota ...
 
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
'''quota-class'''
 
 
 
 
<source lang="bash">
 
<source lang="bash">
nova quota-class-show <class>
+
nova floating-ip-create
 
+
    [<floating_ip_pool>]
os show quota-class ...
 
 
</source>
 
</source>
 
+
|-
 
+
|
 
<source lang="bash">
 
<source lang="bash">
nova quota-class-update [--instances <instances>]
+
os ip floating delete
                        [--cores <cores>]
+
    <ip-address>
                        [--ram <ram>]
 
                        [--volumes <volumes>]
 
                        [--gigabytes <gigabytes>]
 
                        [--floating-ips <floating_ips>]
 
                        [--metadata-items <metadata_items>]
 
                        [--injected-files <injected_files>]
 
                        [--injected-file-content-bytes <injected_file_content_bytes>]
 
                        <class>
 
 
 
os set quota-class ...
 
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
'''rate-limits'''
 
 
 
 
<source lang="bash">
 
<source lang="bash">
nova rate-limits
+
nova floating-ip-delete
 
+
    <address>
os show rate-limits
 
 
</source>
 
</source>
 
 
'''resource'''
 
 
<source lang="bash">
 
nova describe-resource <hostname>
 
 
os show resource ...
 
</source>
 
 
 
==== secgroup ====
 
 
{| class="wikitable"
 
|-
 
! OSC Command !! Implemented !! !! Nova command
 
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os add secgroup
+
os ip floating list
    <secgroup>
 
    <server>
 
 
</source>
 
</source>
|| no
+
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova add-secgroup
+
nova floating-ip-list
    <server>
 
    <secgroup>
 
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os create secgroup
+
os ip floating remove
     [--description <description>]
+
     <ip-address>
     <name>
+
     <server>
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova secgroup-create
+
nova remove-floating-ip
     <name>
+
     <server>
     <description>
+
     <address>
 
</source>
 
</source>
 +
|}
 +
 +
 +
==== floating-ip-pool ====
 +
 +
 +
{| class="wikitable"
 +
|-
 +
! OSC Command !! Implemented !! !! Nova command
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os delete secgroup
+
os ip floating pool list
    <secgroup>
 
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova secgroup-delete
+
nova floating-ip-pool-list
    <secgroup>
 
 
</source>
 
</source>
 +
|}
 +
 +
 +
==== host ====
 +
 +
{| class="wikitable"
 +
|-
 +
! OSC Command !! Implemented !! !! Nova command
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os list secgroup
+
os host list
     [--all-tenants]
+
     [--zone <availability-zone>]
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova secgroup-list
+
nova host-action
    [--all-tenants [<0|1>]]
+
    [--action <action>]
 +
    <hostname>
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os remove secgroup
+
os host set
     <secgroup>
+
     ...
    <server>
 
 
</source>
 
</source>
 
|| no
 
|| no
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova remove-secgroup
+
nova host-update
     <server>
+
     [--status <status>]
     <secgroup>
+
    [--maintenance <maintenance_mode>]
 +
    <hostname>
 +
</source>
 +
|-
 +
|
 +
<source lang="bash">
 +
os host show
 +
     <host>
 
</source>
 
</source>
 +
|| yes
 +
|| ||
 
|}
 
|}
  
==== secgroup-group-rule ====
+
 
 +
==== hypervisor ====
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 2,224: Line 2,351:
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os create secgroup-group-rule
+
os hypervisor list
     [--proto <protocol>]
+
     [--matching <hostname>]
    [--port <port>:<port>]
 
    <source-group>
 
    <secgroup>
 
 
</source>
 
</source>
|| no
+
|| yes
 
|| ||
 
|| ||
<source lang="bash">
 
nova secgroup-add-group-rule
 
    [--ip_proto <ip_proto>]
 
    [--from_port <from_port>]
 
    [--to_port <to_port>]
 
    <secgroup>
 
    <source_group>
 
</source>
 
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os delete secgroup-group-rule
+
os hypervisor show
     [--proto <protocol>]
+
     <id>
    [--port <port>:<port>]
 
    <source-group>
 
    <secgroup>
 
 
</source>
 
</source>
|| no
+
|| yes
 
|| ||
 
|| ||
<source lang="bash">
+
|}
nova secgroup-delete-group-rule
+
 
    [--ip_proto <ip_proto>]
 
    [--from_port <from_port>]
 
    [--to_port <to_port>]
 
    <secgroup>
 
    <source_group>
 
</source>
 
|}
 
  
==== secgroup-rule ====
+
==== keypair ====
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 2,269: Line 2,375:
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os create secgroup-rule
+
os keypair create
    [--proto <proto>]
+
     [--public-key <file>]
    [--src-ip <ip-address>]
+
     <name>
    [--src-port <port>]
 
     [--dst-port <port>]
 
     <secgroup>
 
 
</source>
 
</source>
|| no
+
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova secgroup-add-rule
+
nova keypair-add
    <secgroup>
+
     [--pub_key <pub_key>]
    <ip_proto>
+
     <name>
    <from_port>
 
     <to_port>
 
     <cidr>
 
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os delete secgroup-rule
+
os keypair delete
     [--proto <proto>]
+
     <name>
    [--src-ip <ip-address>]
 
    [--src-port <port>]
 
    [--dst-port <port>]
 
    <secgroup>
 
 
</source>
 
</source>
|| no
+
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova secgroup-delete-rule
+
nova keypair-delete
    <secgroup>
+
     <name>
    <ip_proto>
 
    <from_port>
 
    <to_port>
 
     <cidr>
 
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os list secgroup-rule
+
os keypair list
    <secgroup>
 
 
</source>
 
</source>
|| no
+
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova secgroup-list-rules
+
nova keypair-list
     <secgroup>
+
</source>
 +
|-
 +
|
 +
<source lang="bash">
 +
os keypair show
 +
    [--public-key]
 +
     <name>
 
</source>
 
</source>
 +
|| yes
 +
|| ||
 
|}
 
|}
  
====server====
+
 
 +
==== 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,328: Line 2,437:
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os create server
+
os show resource
     --image <image>
+
     <hostname>
    --flavor <flavor>
+
</source>
    [--security-group <security-group-list> [...] ]
+
|| no
    [--key-name <key-name>]
+
|| ||
     [--meta-data <key=value> [...] ]
+
<source lang="bash">
    [--file <dest-filename=source-filename>] [...] ]
+
nova describe-resource
    [--user-data <user-data>]
+
     <hostname>
    [--availability-zone <zone-name>]
+
</source>
    [--block-device-mapping <dev-name=mapping> [...] ]
+
|}
     [--nic <net-id=net-uuid,v4-fixed-ip=ip-addr> [...] ]
+
 
     [--hint <key=value> [...] ]
+
==== secgroup ====
    [--config-drive <value>|True ]
+
 
    [--min <count>]
+
{| class="wikitable"
     [--max <count>]
+
|-
    [--wait]
+
! OSC Command !! Implemented !! !! Nova command
     <server-name>
+
|-
 +
|
 +
<source lang="bash">
 +
os secgroup add
 +
 
 +
(see server add secgroup)
 +
</source>
 +
|| no
 +
|| ||
 +
<source lang="bash">
 +
nova add-secgroup
 +
     <server>
 +
     <secgroup>
 +
</source>
 +
|-
 +
|
 +
<source lang="bash">
 +
os secgroup create
 +
     [--description <description>]
 +
     <name>
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova boot
+
nova secgroup-create
    [--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>
 
     <name>
 +
    <description>
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os delete server
+
os secgroup delete
     <server>
+
     <group>
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova delete
+
nova secgroup-delete
     <server>
+
     <secgroup>
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os list server
+
os secgroup list
    [--reservation-id <reservation-id>]
+
     [--all-projects]
    [--ip <ip-regex>]
 
    [--ip6 <ip6-regex>]
 
    [--name <name-regex>]
 
    [--instance-name <instance-name-regex>]
 
    [--status <status>]
 
    [--flavor <flavor>]
 
    [--image <image>]
 
    [--host <hostname>]
 
     [--all-tenants]
 
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova list
+
nova secgroup-list
    [--reservation_id <reservation_id>]
+
    [--all-tenants [<0|1>]]
    [--ip <ip_regexp>]
+
</source>
    [--ip6 <ip6_regexp>]
 
    [--name <name_regexp>]
 
    [--instance_name <name_regexp>]
 
    [--status <status>]
 
    [--flavor <flavor>] [--image <image>]
 
    [--host <hostname>]
 
    [--all_tenants [<0|1>]]
 
</source>
 
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os lock server
+
os secgroup remove
    <server>
+
 
 +
(see server remove secgroup)
 
</source>
 
</source>
 
|| no
 
|| no
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova lock
+
nova remove-secgroup
 
     <server>
 
     <server>
 +
    <secgroup>
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os migrate server
+
os secgroup set
     --live
+
     [--name <new-name>]
    [--block_migrate]
+
     [--description [<new-description>]
     [--disk_over_commit]
+
     <group>
    <server>
 
    <host>
 
 
 
os migrate server
 
    [--wait]
 
     <server>
 
 
</source>
 
</source>
|| no
+
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova live-migration
+
nova secgroup-update
    [--block_migrate]
+
     <secgroup>
    [--disk_over_commit]
+
    <name>
     <server>
+
     <description>
<host>
+
</source>
 
+
|-
nova migrate
+
|
    [--poll]
 
     <server>
 
</source>
 
|-
 
|
 
 
<source lang="bash">
 
<source lang="bash">
os pause server
+
os secgroup show
     <server>
+
     <group>
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova pause
+
n/a
    <server>
 
 
</source>
 
</source>
 +
|}
 +
 +
==== secgroup-group-rule ====
 +
 +
{| class="wikitable"
 +
|-
 +
! OSC Command !! Implemented !! !! Nova command
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os reboot server
+
os secgroup group rule create
     [--hard | --soft]
+
     [--proto <protocol>]
     [--wait]
+
     [--port <port>:<port>]
     <server>
+
     <source-group>
 +
    <secgroup>
 
</source>
 
</source>
|| yes
+
|| no
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova reboot
+
nova secgroup-add-group-rule
     [--hard]
+
     [--ip_proto <ip_proto>]
     [--poll]
+
     [--from_port <from_port>]
     <server>
+
    [--to_port <to_port>]
 +
    <secgroup>
 +
     <source_group>
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os rebuild server
+
os secgroup group rule delete
     --image <image>
+
     [--proto <protocol>]
     [--password <password>]  
+
     [--port <port>:<port>]
     [--wait]
+
     <source-group>
     <server>
+
     <secgroup>
 
</source>
 
</source>
|| yes
+
|| no
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova rebuild
+
nova secgroup-delete-group-rule
     [--rebuild_password <rebuild_password>]  
+
     [--ip_proto <ip_proto>]
     [--poll]
+
     [--from_port <from_port>]
     <server>
+
    [--to_port <to_port>]
     <image>
+
     <secgroup>
 +
     <source_group>
 
</source>
 
</source>
 +
|}
 +
 +
==== secgroup-rule ====
 +
 +
{| class="wikitable"
 +
|-
 +
! OSC Command !! Implemented !! !! Nova command
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os rename server
+
os secgroup rule create
     <server>
+
     [--proto <proto>]
     <new-name>
+
     [--src-ip <ip-address>]
 +
    [--dst-port <port-range>]
 +
    <group>
 
</source>
 
</source>
 
|| no
 
|| no
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova rename
+
nova secgroup-add-rule
     <server>
+
     <secgroup>
     <name>
+
     <ip_proto>
 +
    <from_port>
 +
    <to_port>
 +
    <cidr>
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os rescue server
+
os secgroup rule delete
     <server>
+
     [--proto <proto>]
 +
    [--src-ip <ip-address>]
 +
    [--dst-port <port-range>]
 +
    <group>
 
</source>
 
</source>
 
|| no
 
|| no
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova rescue
+
nova secgroup-delete-rule
     <server>
+
     <secgroup>
 +
    <ip_proto>
 +
    <from_port>
 +
    <to_port>
 +
    <cidr>
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os resize server
+
os secgroup rule list
     --flavor <flavor>
+
     <group>
    [--wait]
 
    <server>
 
 
</source>
 
</source>
 
|| no
 
|| no
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova resize
+
nova secgroup-list-rules
    [--poll]
+
     <secgroup>
    <server>
 
     <flavor>
 
 
</source>
 
</source>
 +
|}
 +
 +
====server====
 +
 +
{| class="wikitable"
 +
|-
 +
! OSC Command !! Implemented !! !! Nova command
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os resize server
+
os server add secgroup
    --confirm
 
 
     <server>
 
     <server>
 +
    <group>
 
</source>
 
</source>
 
|| no
 
|| no
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova resize-confirm
+
nova add-secgroup
 
     <server>
 
     <server>
 +
    <secgroup>
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os resume server
+
os server create
     <server>
+
    --image <image>
 +
    --flavor <flavor>
 +
    [--security-group <security-group-list> [...] ]
 +
    [--key-name <key-name>]
 +
    [--meta-data <key=value> [...] ]
 +
    [--file <dest-filename=source-filename>] [...] ]
 +
    [--user-data <user-data>]
 +
    [--availability-zone <zone-name>]
 +
    [--block-device-mapping <dev-name=mapping> [...] ]
 +
    [--nic <net-id=net-uuid,v4-fixed-ip=ip-addr> [...] ]
 +
    [--hint <key=value> [...] ]
 +
    [--config-drive <value>|True ]
 +
    [--min <count>]
 +
    [--max <count>]
 +
    [--wait]
 +
     <server-name>
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova resume
+
nova boot
     <server>
+
     [--flavor <flavor>]
 +
    [--image <image>]
 +
    [--meta <key=value>]
 +
    [--file <dst-path=src-path>]
 +
    [--key_name <key_name>]
 +
    [--user_data <user-data>]
 +
    [--availability_zone <availability-zone>]
 +
    [--security_groups <security_groups>]
 +
    [--block_device_mapping <dev_name=mapping>]
 +
    [--hint <key=value>]
 +
    [--nic <net-id=net-uuid,v4-fixed-ip=ip-addr>]
 +
    [--config-drive <value>]
 +
    [--poll]
 +
    <name>
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os set server
+
os server delete
    --meta-data <key=value>
+
     <server>
    [--meta-data <key=value>] ...
 
    <server>
 
os unset server
 
    --meta-data <key>
 
    [--meta-data <key>] ...
 
     <server>
 
 
</source>
 
</source>
|| no
+
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova meta
+
nova delete
 
     <server>
 
     <server>
    <action>
 
    <key=value>
 
    [<key=value> ...]
 
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os set server
+
os server list
     --root-password
+
     [--reservation-id <reservation-id>]
     <server>
+
     [--ip <ip-regex>]
</source>
+
    [--ip6 <ip6-regex>]
|| no
+
    [--name <name-regex>]
|| ||
+
    [--instance-name <instance-name-regex>]
<source lang="bash">
+
     [--status <status>]
nova root-password
+
    [--flavor <flavor>]
     <server>
+
    [--image <image>]
</source>
+
     [--host <hostname>]
|-
+
    [--all-tenants]
|
 
<source lang="bash">
 
os show server
 
     <server>
 
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova show
+
nova list
     <server>
+
     [--reservation_id <reservation_id>]
 +
    [--ip <ip_regexp>]
 +
    [--ip6 <ip6_regexp>]
 +
    [--name <name_regexp>]
 +
    [--instance_name <name_regexp>]
 +
    [--status <status>]
 +
    [--flavor <flavor>] [--image <image>]
 +
    [--host <hostname>]
 +
    [--all_tenants [<0|1>]]
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os ssh server
+
os server lock
    [--port PORT]
 
    --private]
 
    [--ipv6]
 
    [--login <login>]
 
 
     <server>
 
     <server>
 
</source>
 
</source>
Line 2,617: Line 2,759:
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova ssh
+
nova lock
    [--port PORT]
 
    [--private]
 
    [--ipv6]
 
    [--login <login>]
 
 
     <server>
 
     <server>
 
</source>
 
</source>
Line 2,627: Line 2,765:
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os suspend server
+
os server migrate
 +
    --live
 +
    [--block_migrate]
 +
    [--disk_over_commit]
 +
    <server>
 +
    <host>
 +
 
 +
os server migrate
 +
    [--wait]
 
     <server>
 
     <server>
 
</source>
 
</source>
|| yes
+
|| no
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova suspend
+
nova live-migration
 +
    [--block_migrate]
 +
    [--disk_over_commit]
 
     <server>
 
     <server>
</source>
+
<host>
 +
 
 +
nova migrate
 +
    [--poll]
 +
    <server>
 +
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os unlock server
+
os server pause
 
     <server>
 
     <server>
 
</source>
 
</source>
|| no
+
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova unlock
+
nova pause
 
     <server>
 
     <server>
 
</source>
 
</source>
Line 2,651: Line 2,804:
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os unpause server
+
os server reboot
 +
    [--hard | --soft]
 +
    [--wait]
 
     <server>
 
     <server>
 
</source>
 
</source>
Line 2,657: Line 2,812:
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova unpause
+
nova reboot
 +
    [--hard]
 +
    [--poll]
 
     <server>
 
     <server>
 
</source>
 
</source>
Line 2,663: Line 2,820:
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os unrescue server
+
os server rebuild
 +
    --image <image>
 +
    [--password <password>]
 +
    [--wait]
 
     <server>
 
     <server>
 
</source>
 
</source>
|| no
+
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova unrescue
+
nova rebuild
 +
    [--rebuild_password <rebuild_password>]
 +
    [--poll]
 
     <server>
 
     <server>
 +
    <image>
 
</source>
 
</source>
|}
+
|-
 
+
|
 
 
'''usage'''
 
 
 
 
<source lang="bash">
 
<source lang="bash">
nova usage-list [--start <start>] [--end <end>]
+
os server remove secgroup
 
+
    <server>
os list usage ...
+
    <group>
 
</source>
 
</source>
 
+
|| no
 
+
|| ||
'''volume'''
 
 
 
 
<source lang="bash">
 
<source lang="bash">
nova volume-attach <server> <volume> <device>
+
nova remove-secgroup
 
+
    <server>
os attach volume ...
+
    <secgroup>
 
</source>
 
</source>
 
+
|-
 +
|
 
<source lang="bash">
 
<source lang="bash">
nova volume-detach <server> <volume>
+
os server rename
 
+
    <server>
os detach volume ...
+
    <new-name>
 
</source>
 
</source>
 
+
|| no
 
+
|| ||
'''x509-cert'''
 
 
 
 
<source lang="bash">
 
<source lang="bash">
nova x509-create-cert [<private_key_file>] [<x509_cert>]
+
nova rename
 
+
    <server>
os create x509-cert ...
+
    <name>
 
</source>
 
</source>
 
+
|-
 
+
|
'''x509-root-cert'''
 
 
 
 
<source lang="bash">
 
<source lang="bash">
nova x509-get-root-cert [<filename>]
+
os server rescue
 
+
    <server>
os show x509-root-cert ...
+
</source>
 +
|| no
 +
|| ||
 +
<source lang="bash">
 +
nova rescue
 +
    <server>
 
</source>
 
</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-endpoint-type <type> || OS_ENDPOINT_TYPE
 
|-
 
| --os-token <token> || OS_TOKEN || || --os-auth-token <token> || OS_AUTH_TOKEN
 
|-
 
| --os-url <url> || OS_URL || || --os-image-url <url> || OS_IMAGE_URL
 
|-
 
|  ||  || || --os-cacert <file> || OS_CACERT
 
|-
 
|  ||  || || --cert-file <file> || CERT_FILE
 
|-
 
|  ||  || || --key-file <key-file> || KEY_FILE
 
|-
 
|  ||  || || --no-ssl-compression ||
 
|-
 
|}
 
 
 
=== API v1 ===
 
 
'''image'''
 
 
{| class="wikitable"
 
|-
 
! OSC Command !! Implemented !! !! Glance command
 
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os create image
+
os server resize
     [--id <id>]
+
     --flavor <flavor>
    [--store <store>]
+
     [--wait]
    [--container-format <format>]
+
     <server>
    [--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>
 
</source>
|| yes
+
|| no
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
glance image-create
+
nova resize
    [--id <IMAGE_ID>]
+
     [--poll]
    [--name <NAME>]
+
     <server>
    [--disk-format <CONTAINER_FORMAT>]
+
     <flavor>
    [--container-format <DISK_FORMAT>]
 
    [--owner <TENANT_ID>]
 
    [--size <SIZE>]
 
     [--min-disk <DISK_GB>]
 
     [--min-ram <DISK_RAM>]
 
     [--location <IMAGE_URL>]
 
    [--checksum <CHECKSUM>]
 
    [--copy-from <IMAGE_URL>]
 
    [--public] [--protected]
 
    [--property <key=value>]
 
 
</source>
 
</source>
|}
 
 
=== API v2 ===
 
 
'''image'''
 
 
{| class="wikitable"
 
|-
 
! OSC Command !! Implemented !! !! Glance command
 
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os delete image
+
os server resize
     <id>
+
    --confirm
 +
     <server>
 
</source>
 
</source>
|| yes
+
|| no
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
glance image-delete
+
nova resize-confirm
     <IMAGE_ID>
+
     <server>
 
</source>
 
</source>
|}
+
|-
 
+
|
 
 
 
 
 
<source lang="bash">
 
<source lang="bash">
glance image-list
+
os server resume
 
+
    <server>
os list image ...
 
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
 
<source lang="bash">
 
<source lang="bash">
glance image-show <IMAGE_ID>
+
nova resume
 
+
    <server>
os show image ...
 
 
</source>
 
</source>
 
+
|-
 
+
|
 
<source lang="bash">
 
<source lang="bash">
glance member-images [options] <MEMBER>
+
os server set
 
+
    --meta-data <key=value>
os list image --member <member> [options]
+
    [--meta-data <key=value>] ...
</source>
+
    <server>
 
+
os unset server
 
+
    --meta-data <key>
 +
    [--meta-data <key>] ...
 +
    <server>
 +
</source>
 +
|| no
 +
|| ||
 
<source lang="bash">
 
<source lang="bash">
glance show [options] <ID>
+
nova meta
 
+
    <server>
os show image ...
+
    <action>
 +
    <key=value>
 +
    [<key=value> ...]
 
</source>
 
</source>
 
+
|-
 
+
|
 
<source lang="bash">
 
<source lang="bash">
glance update [options] <ID> <field1=value1 field2=value2 ...>
+
os server set
 
+
    --root-password
os set image ...
+
    <server>
 
</source>
 
</source>
 
+
|| no
 
+
|| ||
'''image-member'''
 
 
 
 
<source lang="bash">
 
<source lang="bash">
glance member-create [--can-share] <IMAGE_ID> <TENANT_ID>
+
nova root-password
 
+
    <server>
os create image-member ...
 
 
</source>
 
</source>
 
+
|-
 
+
|
 
<source lang="bash">
 
<source lang="bash">
glance member-delete <IMAGE_ID> <TENANT_ID>
+
os server show
 
+
    <server>
os list image-member <image> [options]
 
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
 
<source lang="bash">
 
<source lang="bash">
glance member-delete [options] <ID> <MEMBER>
+
nova show
 
+
    <server>
os delete image-member ...
 
 
</source>
 
</source>
 
+
|-
 
+
|
 
<source lang="bash">
 
<source lang="bash">
glance member-list [--image-id <IMAGE_ID>] [--tenant-id <TENANT_ID>]
+
os server ssh
 
+
    [--port PORT]
os list image-member ...
+
    --private]
 +
    [--ipv6]
 +
    [--login <login>]
 +
    <server>
 +
</source>
 +
|| no
 +
|| ||
 +
<source lang="bash">
 +
nova ssh
 +
    [--port PORT]
 +
    [--private]
 +
    [--ipv6]
 +
    [--login <login>]
 +
    <server>
 
</source>
 
</source>
 
== Volume ==
 
 
 
{| class="wikitable"
 
|-
 
! Cinder Option !!  Environment Variable !!  !!  OSC Option !!  Environment Variable
 
|-
 
| --os-volume-api-version <ver> || OS_VOLUME_API_VERSION ||  || --os-volume-api-version <ver> || OS_VOLUME_API_VERSION
 
|-
 
| --service-type <type> ||  ||  ||  ||
 
|-
 
| --service-name <name> || CINDER_SERVICE_NAME ||  ||  ||
 
|-
 
| --volume-service-name <name> || CINDER_VOLUME_SERVICE_NAME ||  ||  ||
 
|-
 
| --endpoint-type <type> || CINDER_ENDPOINT_TYPE ||  ||  ||
 
|-
 
| --retries <int> ||  ||  ||  ||
 
|-
 
|}
 
 
 
=== API v1.0 ===
 
 
==== quota ====
 
 
{| class="wikitable"
 
|-
 
! OSC Command !! Implemented !! !! Cinder command
 
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os list quota
+
os server suspend
     <tenant>
+
     <server>
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
 +
nova suspend
 +
    <server>
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os set quota
+
os server unlock
     [--volumes] <new-volumes>]
+
     <server>
    [--gigabytes <new-gigabytes>]
 
    <tenant>
 
 
</source>
 
</source>
|| yes
+
|| no
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
cinder quota-update
+
nova unlock
     [--volumes <volumes>]
+
     <server>
    [--snapshots <snapshots>]
 
    [--gigabytes <gigabytes>]
 
    <tenant_id>
 
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os show quota
+
os server unpause
     <tenant>
+
     <server>
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
cinder quota-show
+
nova unpause
     <tenant_id>
+
    <server>
 +
</source>
 +
|-
 +
|
 +
<source lang="bash">
 +
os server unrescue
 +
    <server>
 +
</source>
 +
|| no
 +
|| ||
 +
<source lang="bash">
 +
nova unrescue
 +
     <server>
 
</source>
 
</source>
 
|}
 
|}
  
==== snapshot ====
+
==== usage ====
  
 
{| class="wikitable"
 
{| class="wikitable"
 
|-
 
|-
! OSC Command !! Implemented !! !! Cinder command
+
! OSC Command !! Implemented !! !! Keystone command
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os create snapshot
+
os usage list
    --name <name>
+
     [--start <start>]
     [--description <description>]
+
     [--end <end>]
     [--force]
 
    <volume>
 
 
</source>
 
</source>
|| yes
+
|| no
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
cinder snapshot-create
+
nova usage-list
     --force <True|False>
+
     [--start <start>]
     --display-name <display-name>
+
     [--end <end>]
    --display-description <display-description>
 
    <volume-id>
 
 
</source>
 
</source>
|-
+
|}
 +
 
 +
 
 +
==== volume ====
 +
 
 +
{| class="wikitable"
 +
|-
 +
! OSC Command !! Implemented !! !! Keystone command
 +
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os delete snapshot
+
os volume attach
     <snapshot>
+
     <volume>
 +
    <server>
 +
    <device>
 
</source>
 
</source>
|| yes
+
|| no
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
cinder snapshot-delete
+
nova volume-attach
     <snapshot-id>
+
     <server>
 +
    <volume>
 +
    <device>
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os list snapshot
+
os volume detach
 +
    <server>
 +
    <volume>
 
</source>
 
</source>
|| yes (no opts yet)
+
|| no
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
cinder snapshot-list
+
nova volume-detach
     --all-tenants [<0|1>]
+
     <server>
     --display-name <display-name>
+
     <volume>
    --status <status>
 
    --volume-id <volume-id>
 
 
</source>
 
</source>
|-
+
|}
|
+
 
<source lang="bash">
+
 
os set snapshot
+
==== x509-cert ====
    [--name <new-name>]
+
 
    [--description <new-description>]
+
See [[#credentials|credentials]] in the [[#Cross_API|cross API section]].
    <snapshot>
+
 
</source>
+
==== x509-root-cert ====
|| yes
+
 
|| ||
+
See [[#credentials|credentials]] in the [[#Cross_API|cross API section]].
<source lang="bash">
 
cinder snapshot-rename
 
    --display-description <display-description>
 
    --display-name <display-name>
 
    <snapshot-id>
 
</source>
 
|-
 
|
 
<source lang="bash">
 
os show snapshot
 
    <snapshot>
 
</source>
 
|| yes
 
|| ||
 
<source lang="bash">
 
cinder snapshot-show
 
    <snapshot-id>
 
</source>
 
|}
 
  
==== volume ====
+
== Image ==
  
 
{| class="wikitable"
 
{| class="wikitable"
|-
+
|-  
! OSC Command !! Implemented !! !! Cinder command
+
! 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
<source lang="bash">
+
|-  
os create volume
+
|  ||  || || --os-service-type <type> || OS_SERVICE_TYPE
    --size <size>
+
|-
    [--description <description>]
+
|  ||  || || --os-endpoint-type <type> || OS_ENDPOINT_TYPE
    [--volume-type <volume-type>]
+
|-  
    [--snapshot-id <snapshot-id>]
+
| --os-token <token> || OS_TOKEN || || --os-auth-token <token> || OS_AUTH_TOKEN
    [--source <volid>]
+
|-  
    [--image <image-id>]
+
| --os-url <url> || OS_URL || || --os-image-url <url> || OS_IMAGE_URL
    [--availability-zone <availability-zone>]
+
|-
    [--metadata <key=value>]
+
|| || || --os-cacert <file> || OS_CACERT
    [--user <user>]          # admin only
+
|-  
    [--project <project>]    # admin only
+
|  ||  || || --cert-file <file> || CERT_FILE
    <name>
+
|-  
</source>
+
|  ||  || || --key-file <key-file> || KEY_FILE
|| yes
+
|-  
|| ||
+
|  ||  || || --no-ssl-compression ||
<source lang="bash">
+
|-  
cinder create
+
|}
    [--snapshot-id <snapshot-id>]
+
 
    [--source-volid <source-volid>]
+
 
    [--image-id <image-id>]
+
=== API v1 ===
    [--display-name <display-name>]
+
 
    [--display-description <display-description>]
+
==== image ====
    [--volume-type <volume-type>]
+
 
    [--availability-zone <availability-zone>]
+
{| class="wikitable"
    [--metadata <key=value>]
+
|-
    <size>
+
! OSC Command !! Implemented !! !! Glance command
</source>
 
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os delete volume
+
os image create
     [--force]
+
     [--id <id>]
     <volume>
+
    [--store <store>]
 +
    [--container-format <format>]
 +
    [--disk-format <format>]
 +
    [--owner <tenant>]
 +
    [--size <size-bytes>]
 +
    [--min-disk <disk-gb>]
 +
    [--min-ram <ram-mg>]
 +
    [--location <image-url>]
 +
    [--copy-from <image-url>]
 +
    [--file <local-filename>]
 +
    [--checksum <checksum>]
 +
    [--protected | --unprotected]
 +
    [--public | --private]
 +
    [--property <key=value>]
 +
     <name>
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
cinder delete
+
glance image-create
     <volume-id>
+
    [--id <IMAGE_ID>]
 
+
    [--name <NAME>]
cinder force-delete
+
    [--disk-format <DISK_FORMAT>]
     <volume-id>
+
     [--container-format <CONTAINER_FORMAT>]
 +
    [--owner <TENANT_ID>]
 +
    [--size <SIZE>]
 +
    [--min-disk <DISK_GB>]
 +
    [--min-ram <DISK_RAM>]
 +
    [--location <IMAGE_URL>]
 +
     [--checksum <CHECKSUM>]
 +
    [--copy-from <IMAGE_URL>]
 +
    [--is-public [True|False]]
 +
    [--is-protected [True|False]]
 +
    [--property <key=value>]
 +
    [--human-readable]
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os list volume
+
os image delete
     [--name <name>]
+
     <image>
    [--status <status>]
 
    [--long]
 
    [--all-tenants]          # admin only
 
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
cinder list
+
glance image-delete
    --all-tenants [<0|1>]
+
     <IMAGE_ID>
    --display-name <display-name>
 
     --status <status>
 
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os set volume
+
os image list
     [--name <new-name>]
+
     [--page-size <size>]
    [--description <new-description>]
 
    [--metadata <key=value>]
 
    <volume>
 
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
cinder metadata
+
glance image-list
    <volume-id>
 
    <action>
 
    <key=value>
 
 
 
cinder rename
 
    --display-description <display-description>
 
    <volume-id>
 
    <display-name>
 
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os show volume
+
os image save
     <volume>
+
     [--file <filename>]
 +
    <image>
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
cinder show
+
glance image-download
     <volume-id>
+
    [--file <FILE>]
 +
     <IMAGE>
 +
</source>
 +
|-
 +
|
 +
<source lang="bash">
 +
os image set
 +
    [--name <name>]
 +
    [--owner <tenant>]
 +
    [--min-disk <disk-gb>]
 +
    [--min-ram <ram-mg>]
 +
    [--protected | --unprotected]
 +
    [--public | --private]
 +
    [--property <key=value>]
 +
    <image>
 +
</source>
 +
|| yes
 +
|| ||
 +
<source lang="bash">
 +
glance image-update
 +
    [--name <NAME>]
 +
    [--disk-format <DISK_FORMAT>]
 +
    [--container-format <CONTAINER_FORMAT>]
 +
    [--owner <TENANT_ID>]
 +
    [--size <SIZE>]
 +
    [--min-disk <DISK_GB>]
 +
    [--min-ram <DISK_RAM>]
 +
    [--location <IMAGE_URL>]
 +
    [--file <FILE>]
 +
    [--checksum <CHECKSUM>]
 +
    [--copy-from <IMAGE_URL>]
 +
    [--is-public [True|False]]
 +
    [--is-protected [True|False]]
 +
    [--property <key=value>]
 +
    [--purge-props]
 +
    [--human-readable]
 +
    <IMAGE>
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os unset volume
+
os image show
     [--metadata <key=value>]
+
     <image>
    <volume>
 
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
 +
glance image-show
 +
    [--human-readable]
 +
    <IMAGE>
 
</source>
 
</source>
 
|}
 
|}
  
==== volume-type ====
+
=== API v2 ===
 +
 
 +
==== image ====
  
 
{| class="wikitable"
 
{| class="wikitable"
 
|-
 
|-
! OSC Command !! Implemented !! !! Cinder command
+
! OSC Command !! Implemented !! !! Glance command
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os create volume-type
+
os image delete
     <name>
+
    <image>
</source>
+
</source>
|| yes
+
|| yes
|| ||
+
|| ||
<source lang="bash">
+
<source lang="bash">
cinder type-create
+
glance image-delete
     <type-name>
+
    <IMAGE_ID>
</source>
+
</source>
|-
+
|-
|
+
|
<source lang="bash">
+
<source lang="bash">
os delete volume-type
+
os image list
     <volume-type>
+
    [--page-size <size>]
</source>
+
</source>
|| yes
+
|| yes
|| ||
+
|| ||
<source lang="bash">
+
<source lang="bash">
cinder type-delete
+
glance image-list
     <type-id>
+
</source>
</source>
+
|-
|-
+
|
|
+
<source lang="bash">
<source lang="bash">
+
</source>
os list volume-type
+
|| no
     [--long]
+
|| ||
</source>
+
<source lang="bash">
|| yes
+
glance member-images
|| ||
+
    [options]
<source lang="bash">
+
    <MEMBER>
cinder type-list  
+
</source>
 
+
|-
cinder extra-specs-list
+
|
</source>
+
<source lang="bash">
|-
+
os image save
|
+
    [--file <filename>]
<source lang="bash">
+
    <image>
os set volume-type
+
</source>
     [--metadata <key=value>]
+
|| yes
 +
|| ||
 +
<source lang="bash">
 +
glance image-download
 +
    [--file <FILE>]
 +
    <IMAGE>
 +
</source>
 +
|-
 +
|
 +
<source lang="bash">
 +
os image set
 +
    [--id <id>]
 +
    [--store <store>]
 +
    [--container-format <format>]
 +
    [--disk-format <format>]
 +
    [--owner <tenant>]
 +
    [--size <size-bytes>]
 +
    [--min-disk <disk-gb>]
 +
    [--min-ram <ram-mg>]
 +
    [--location <image-url>]
 +
    [--copy-from <image-url>]
 +
    [--file <local-filename>]
 +
    [--checksum <checksum>]
 +
    [--protected | --unprotected]
 +
    [--public | --private]
 +
    [--property <key=value>]
 +
    <name>
 +
</source>
 +
|| no
 +
|| ||
 +
<source lang="bash">
 +
glance image-update
 +
    [--name <NAME>]
 +
    [--disk-format <DISK_FORMAT>]
 +
    [--container-format <CONTAINER_FORMAT>]
 +
    [--owner <TENANT_ID>]
 +
    [--size <SIZE>]
 +
    [--min-disk <DISK_GB>]
 +
    [--min-ram <DISK_RAM>]
 +
    [--location <IMAGE_URL>]
 +
    [--file <FILE>]
 +
    [--checksum <CHECKSUM>]
 +
    [--copy-from <IMAGE_URL>]
 +
    [--is-public [True|False]]
 +
    [--is-protected [True|False]]
 +
    [--property <key=value>]
 +
    [--purge-props]
 +
    [--human-readable]
 +
    <IMAGE>
 +
</source>
 +
|-
 +
|
 +
<source lang="bash">
 +
os image show
 +
    <image>
 +
</source>
 +
|| yes
 +
|| ||
 +
<source lang="bash">
 +
glance image-show
 +
    [--human-readable]
 +
    <IMAGE>
 +
</source>
 +
|}
 +
 
 +
 
 +
==== image-member ====
 +
 
 +
Need to discuss the future of these commands with markwash...
 +
 
 +
<source lang="bash">
 +
glance member-create [--can-share] <IMAGE_ID> <TENANT_ID>
 +
 
 +
os create image-member ...
 +
</source>
 +
 
 +
 
 +
<source lang="bash">
 +
glance member-delete <IMAGE_ID> <TENANT_ID>
 +
 
 +
os list image-member <image> [options]
 +
</source>
 +
 
 +
 
 +
<source lang="bash">
 +
glance member-delete [options] <ID> <MEMBER>
 +
 
 +
os delete image-member ...
 +
</source>
 +
 
 +
 
 +
<source lang="bash">
 +
glance member-list [--image-id <IMAGE_ID>] [--tenant-id <TENANT_ID>]
 +
 
 +
os list image-member ...
 +
</source>
 +
 
 +
== Volume ==
 +
 
 +
{| class="wikitable"
 +
|-
 +
! Cinder Option !!  Environment Variable !!  !!  OSC Option !!  Environment Variable
 +
|-
 +
| --os-volume-api-version <ver> || OS_VOLUME_API_VERSION ||  || --os-volume-api-version <ver> || OS_VOLUME_API_VERSION
 +
|-
 +
| --service-type <type> ||  ||  ||  ||
 +
|-
 +
| --service-name <name> || CINDER_SERVICE_NAME ||  ||  ||
 +
|-
 +
| --volume-service-name <name> || CINDER_VOLUME_SERVICE_NAME ||  ||  ||
 +
|-
 +
| --endpoint-type <type> || CINDER_ENDPOINT_TYPE ||  ||  ||
 +
|-
 +
| --retries <int> ||  ||  ||  ||
 +
|-
 +
|}
 +
 
 +
 
 +
=== API v1.0 ===
 +
 
 +
==== limits ====
 +
 
 +
See [[#limits|limits]] in the [[#Cross_API|cross API section]].
 +
 
 +
==== quota ====
 +
 
 +
See [[#quota|quota]] in the [[#Cross_API|cross API section]].
 +
 
 +
==== snapshot ====
 +
 
 +
{| class="wikitable"
 +
|-
 +
! OSC Command !! Implemented !! !! Cinder command
 +
|-
 +
|
 +
<source lang="bash">
 +
os snapshot create
 +
    --name <name>
 +
    [--description <description>]
 +
    [--force]
 +
    <volume>
 +
</source>
 +
|| yes
 +
|| ||
 +
<source lang="bash">
 +
cinder snapshot-create
 +
    --force <True|False>
 +
    --display-name <display-name>
 +
    --display-description <display-description>
 +
    <volume-id>
 +
</source>
 +
|-
 +
|
 +
<source lang="bash">
 +
os snapshot delete
 +
    <snapshot>
 +
</source>
 +
|| yes
 +
|| ||
 +
<source lang="bash">
 +
cinder snapshot-delete
 +
    <snapshot-id>
 +
</source>
 +
|-
 +
|
 +
<source lang="bash">
 +
os snapshot list
 +
</source>
 +
|| yes (no opts yet)
 +
|| ||
 +
<source lang="bash">
 +
cinder snapshot-list
 +
    --all-tenants [<0|1>]
 +
    --display-name <display-name>
 +
     --status <status>
 +
    --volume-id <volume-id>
 +
</source>
 +
|-
 +
|
 +
<source lang="bash">
 +
os snapshot set
 +
    [--name <new-name>]
 +
    [--description <new-description>]
 +
    <snapshot>
 +
</source>
 +
|| yes
 +
|| ||
 +
<source lang="bash">
 +
cinder snapshot-rename
 +
    --display-description <display-description>
 +
    --display-name <display-name>
 +
    <snapshot-id>
 +
</source>
 +
|-
 +
|
 +
<source lang="bash">
 +
os snapshot show
 +
    <snapshot>
 +
</source>
 +
|| yes
 +
|| ||
 +
<source lang="bash">
 +
cinder snapshot-show
 +
    <snapshot-id>
 +
</source>
 +
|}
 +
 
 +
==== volume ====
 +
 
 +
{| class="wikitable"
 +
|-
 +
! OSC Command !! Implemented !! !! Cinder command
 +
|-
 +
|
 +
<source lang="bash">
 +
os volume create
 +
    --size <size>
 +
    [--description <description>]
 +
    [--volume-type <volume-type>]
 +
    [--snapshot-id <snapshot-id>]
 +
    [--source <volid>]
 +
    [--image <image-id>]
 +
    [--availability-zone <availability-zone>]
 +
    [--property <key=value>]
 +
    [--user <user>]          # admin only
 +
    [--project <project>]    # admin only
 +
    <name>
 +
</source>
 +
|| yes
 +
|| ||
 +
<source lang="bash">
 +
cinder create
 +
     [--snapshot-id <snapshot-id>]
 +
    [--source-volid <source-volid>]
 +
    [--image-id <image-id>]
 +
    [--display-name <display-name>]
 +
    [--display-description <display-description>]
 +
    [--volume-type <volume-type>]
 +
    [--availability-zone <availability-zone>]
 +
    [--metadata <key=value>]
 +
    <size>
 +
</source>
 +
|-
 +
|
 +
<source lang="bash">
 +
os volume delete
 +
    [--force]
 +
    <volume>
 +
</source>
 +
|| yes
 +
|| ||
 +
<source lang="bash">
 +
cinder delete
 +
    <volume-id>
 +
 
 +
cinder force-delete
 +
    <volume-id>
 +
</source>
 +
|-
 +
|
 +
<source lang="bash">
 +
os volume list
 +
    [--name <name>]
 +
    [--status <status>]
 +
    [--long]
 +
    [--all-tenants]          # admin only
 +
</source>
 +
|| yes
 +
|| ||
 +
<source lang="bash">
 +
cinder list
 +
    --all-tenants [<0|1>]
 +
    --display-name <display-name>
 +
    --status <status>
 +
</source>
 +
|-
 +
|
 +
<source lang="bash">
 +
os volume set
 +
    [--name <new-name>]
 +
    [--description <new-description>]
 +
    [--property <key=value>]
 +
    <volume>
 +
</source>
 +
|| yes
 +
|| ||
 +
<source lang="bash">
 +
cinder metadata
 +
    <volume-id>
 +
    <action>
 +
    <key=value>
 +
 
 +
cinder rename
 +
    --display-description <display-description>
 +
    <volume-id>
 +
    <display-name>
 +
</source>
 +
|-
 +
|
 +
<source lang="bash">
 +
os volume show
 +
    <volume>
 +
</source>
 +
|| yes
 +
|| ||
 +
<source lang="bash">
 +
cinder show
 +
    <volume-id>
 +
</source>
 +
|-
 +
|
 +
<source lang="bash">
 +
os volume unset
 +
    [--property <key=value>]
 +
    <volume>
 +
</source>
 +
|| yes
 +
|| ||
 +
<source lang="bash">
 +
</source>
 +
|}
 +
 
 +
==== volume-type ====
 +
 
 +
{| class="wikitable"
 +
|-
 +
! OSC Command !! Implemented !! !! Cinder command
 +
|-
 +
|
 +
<source lang="bash">
 +
os volume type create
 +
    [--property <key=value>]
 +
    <name>
 +
</source>
 +
|| yes
 +
|| ||
 +
<source lang="bash">
 +
cinder type-create
 +
    <type-name>
 +
</source>
 +
|-
 +
|
 +
<source lang="bash">
 +
os volume type delete
 +
     <volume-type>
 +
</source>
 +
|| yes
 +
|| ||
 +
<source lang="bash">
 +
cinder type-delete
 +
     <type-id>
 +
</source>
 +
|-
 +
|
 +
<source lang="bash">
 +
os volume type list
 +
     [--long]
 +
</source>
 +
|| yes
 +
|| ||
 +
<source lang="bash">
 +
cinder type-list  
 +
 
 +
cinder extra-specs-list
 +
</source>
 +
|-
 +
|
 +
<source lang="bash">
 +
os volume type set
 +
     [--property <key=value>]
 
     <volume-type>
 
     <volume-type>
 
</source>
 
</source>
Line 3,203: 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,219: 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,373: 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>
<