Jump to: navigation, search

Difference between revisions of "UnifiedCLI/Mapping"

(Add compute fixed-ip and floating-ip)
(Redirected page to OpenStackClient/Commands)
 
(104 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> ||
 
|-
 
|}
 
  
 +
''[consider rolling the ec2 creds into this too]''
  
=== API v2.0 ===
+
{| class="wikitable"
 
 
====catalog====
 
 
 
{| class="wikitable"
 
 
|-
 
|-
 
! OSC Command !! Implemented !! !! Keystone command
 
! OSC Command !! Implemented !! !! Keystone command
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>
 +
|| no
 +
|| ||
 +
<source lang="bash">
 +
nova x509-create-cert
 +
     [<pk-file>]
 +
    [<x509-cert>]
 +
</source>
 +
|-
 +
|
 +
<source lang="bash">
 +
os credentials show
 +
    [--token]
 +
    [--user]
 +
    [--x509 [--root]]
 
</source>
 
</source>
|| yes
+
|| 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>
|| no
+
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone ec2-credentials-create
+
nova absolute-limits
    [--user <user-id>]
+
     [--reserved]
     [--tenant_id <tenant-id>]
+
 
## are both args really optional?
+
nova rate-limits
</source>
+
 
|-
+
cinder absolute-limits
|
 
<source lang="bash">
 
os delete ec2-credentials
 
    <access-key>
 
  
## what changes if --user is not provided?
+
cinder rate-limits
</source>
 
|| no
 
|| ||
 
<source lang="bash">
 
keystone ec2-credentials-delete
 
    [--user <user-id>]
 
    --access <access-key>
 
 
</source>
 
</source>
 +
|}
 +
 +
==== quota ====
 +
 +
{| class="wikitable"
 
|-
 
|-
 +
! OSC Command !! Implemented !! !! Keystone command
 +
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os list ec2-credentials
+
os quota set
     [--user <user-id>]
+
    # 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>
 
</source>
 
</source>
|| no
+
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone ec2-credentials-list
+
nova quota-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>]
 +
    <tenant_id>
 +
 
 +
cinder quota-update
 +
    [--volumes <volumes>]
 +
    [--snapshots <snapshots>]
 +
    [--gigabytes <gigabytes>]
 +
    <tenant_id>
 
</source>
 
</source>
|-
+
|-  
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os show ec2-credentials
+
os quota set
     <access-key>
+
    --class
 +
    # Compute settings
 +
    [--cores <num-cores>]
 +
    [--fixed-ips <num-fixed-ips>]
 +
    [--floating-ips <num-floating-ips>]
 +
     [--injected-file-size <injected-file-bytes>]
 +
    [--injected-files <num-injected-files>]
 +
    [--instances <num-instances>]
 +
    [--key-pairs <num-key-pairs>]
 +
    [--properties <num-properties>]
 +
    [--ram <ram-mb>]
 +
 
 +
    # Volume settings
 +
    [--gigabytes <new-gigabytes>]
 +
    [--snapshots <new-snapshots>]
 +
    [--volumes <new-volumes>]
  
## what changes if --user is not provided?
+
    <class>
 
</source>
 
</source>
|| no
+
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone ec2-credentials-get
+
nova quota-class-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>]
 +
     <class>
 +
 
 +
cinder quota-class-update
 +
    [--volumes <volumes>]
 +
    [--snapshots <snapshots>]
 +
    [--gigabytes <gigabytes>]
 +
    <tenant_id>
 +
</source>
 +
|-
 +
|
 +
<source lang="bash">
 +
os quota show
 +
    [--default]
 +
    <project>
 
</source>
 
</source>
|}
+
|| yes
 +
|| ||
 +
<source lang="bash">
 +
nova quota-show
 +
    [--tenant <tenant-id>]
  
 +
cinder quota-show
 +
    <tenant_id>
  
==== endpoint ====
+
nova quota-defaults
 +
    <tenant_id>
  
{| class="wikitable"
+
cinder quota-defaults
|-
+
    <tenant_id>
! OSC Command !! Implemented !! !! Keystone command
+
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os create endpoint
+
os quota show
     [--region <endpoint-region>
+
     --class
    [--publicurl <public-url>]
+
     <class>
    [--adminurl <admin-url>]
 
    [--internalurl <internal-url>]
 
     <service>
 
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone endpoint-create
+
nova quota-class-show
     [--region <endpoint-region>]
+
    <class>
    [--service_id <service-id>]
+
 
    [--publicurl <public-url>]
+
cinder quota-class-show
    [--adminurl <admin-url>]
+
     <class>
    [--internalurl <internal-url>]
+
</source>
</source>
+
|}
 +
 
 +
== Identity ==
 +
 
 +
{| class="wikitable"
 +
|-
 +
! OSC Option !!  Environment Variable !!  !!  Keystone Option !!  Environment Variable
 +
|-
 +
| --os-identity-api-version <ver> || OS_IDENTITY_API_VERSION ||  || --os-identity-api-version <ver> || OS_IDENTITY_API_VERSION
 +
|-
 +
| --os-token <token> || OS_TOKEN || || --os-token <token> || OS_SERVICE_TOKEN
 +
|-
 +
| --os-url <url> || OS_URL || || --os-endpoint <url> || OS_SERVICE_ENDPOINT
 +
|-
 +
|  ||  || || --os-cert <file> || OS_CERT
 +
|-  
 +
|  ||  || || --os-key <key-file> || OS_KEY
 +
|-
 +
|  ||  || || --os-cache || OS_CACHE
 +
|-
 +
|  ||  || || --force-new-token ||
 +
|-
 +
|  ||  || || --stale-duration <seconds> ||
 +
|-
 +
|}
 +
 
 +
=== API v2.0 ===
 +
 
 +
==== catalog ====
 +
 
 +
{| class="wikitable"
 +
|-
 +
! OSC Command !! Implemented !! !! Keystone command
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os delete endpoint
+
os catalog show
     <endpoint-id>
+
     [--service <service>]
 
</source>
 
</source>
|| yes
+
|| no
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone endpoint-delete
+
keystone catalog
     <endpoint-id>
+
     [--service <service-type>]
 
</source>
 
</source>
 +
|}
 +
 +
==== ec2 credentials ====
 +
 +
{| class="wikitable"
 +
|-
 +
! OSC Command !! Implemented !! !! Keystone command
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os list endpoint
+
os ec2 credentials create
     [--long]
+
     [--project <project>]
 +
    [--user <user>]
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone endpoint-list
+
keystone ec2-credentials-create
 +
    [--user <user-id>]
 +
    [--tenant_id <tenant-id>]
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os show endpoint
+
os ec2 credentials delete
     [--type <endpoint-type>]
+
     [--user <user>]
    [--attr <endpoint-attribute>]  
+
     <access-key>
     [--value <endpoint-value>]
 
    [--all]
 
    <service>
 
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone endpoint-get
+
keystone ec2-credentials-delete
    --service <service-type>
+
     [--user <user-id>]  
     [--endpoint_type <endpoint-type>]
+
     --access <access-key>
     [--attr <service-attribute>]
+
</source>
    [--value <value>]
 
</source>
 
|}
 
 
 
 
 
====role====
 
 
 
{| class="wikitable"
 
|-
 
! OSC Command !! Implemented !! !! Keystone command
 
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os create role
+
os ec2 credentials list
     <role-name>
+
     [--user <user>]
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone role-create --name
+
keystone ec2-credentials-list
     <role-name>
+
     [--user <user-id>]
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os delete role
+
os ec2 credentials show
     <role>
+
     [--user <user>]
 +
    <access-key>
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone role-delete
+
keystone ec2-credentials-get
     <role-id>
+
     [--user <user-id>]
 +
    --access <access-key>
 
</source>
 
</source>
 +
|}
 +
 +
==== endpoint ====
 +
 +
{| class="wikitable"
 +
|-
 +
! OSC Command !! Implemented !! !! Keystone command
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os list role
+
os endpoint create
 +
    --publicurl <public-url>
 +
    [--adminurl <admin-url>]
 +
    [--internalurl <internal-url>]
 +
    [--region <endpoint-region>]
 +
    <service>
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone role-list
+
keystone endpoint-create
 +
    [--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 show role
+
os endpoint delete
     <role>
+
     <endpoint-id>
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone role-get
+
keystone endpoint-delete
     <role-id>
+
     <endpoint-id>
 
</source>
 
</source>
|}
 
 
 
====service====
 
 
{| class="wikitable"
 
|-
 
! OSC Command !! Implemented !! !! Keystone command
 
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os create service
+
os endpoint list
     [--type <service-type>]
+
     [--long]
    [--description <service-description>]
 
    <service-name>
 
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone service-create
+
keystone endpoint-list
    --name <name>
 
    --type <type>
 
    [--description <service-description>]
 
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os delete service
+
os endpoint show
     <service>
+
    [--type <endpoint-type>]
 +
    [--attr <endpoint-attribute>]
 +
    [--value <endpoint-value>]
 +
    [--all]
 +
     <service-type>
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone service-delete
+
keystone endpoint-get
     <service-id>
+
    --service <service-type>
 +
     [--endpoint_type <endpoint-type>]
 +
    [--attr <service-attribute>]
 +
    [--value <value>]
 
</source>
 
</source>
 +
|}
 +
 +
==== role ====
 +
 +
{| class="wikitable"
 +
|-
 +
! OSC Command !! Implemented !! !! Keystone command
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os list service [--long]
+
os role create
 +
    <role-name>
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone service-list
+
keystone role-create --name
 +
    <role-name>
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os show service
+
os role delete
     <service>
+
     <role>
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone service-get
+
keystone role-delete
     <service-id>
+
     <role-id>
 
</source>
 
</source>
|}
 
 
 
====tenant====
 
 
{| class="wikitable"
 
|-
 
! OSC Command !! Implemented !! !! Keystone command
 
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os create tenant
+
os role list
    [--description <tenant-description>]
 
    [--enable | --disable]
 
    <tenant-name>
 
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone tenant-create
+
keystone role-list
    --name <tenant-name>
 
    [--description <tenant-description>]
 
    [--enabled <true|false>]
 
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os delete tenant
+
os role show
     <tenant>
+
     <role>
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone tenant-delete
+
keystone role-get
     <tenant-id>
+
     <role-id>
 
</source>
 
</source>
 +
|}
 +
 +
==== service ====
 +
 +
{| class="wikitable"
 +
|-
 +
! OSC Command !! Implemented !! !! Keystone command
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os list tenant
+
os service create
     [--long]
+
     [--type <service-type>]
 +
    [--description <service-description>]
 +
    <service-name>
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone tenant-list
+
keystone service-create
 +
    --name <name>
 +
    --type <type>
 +
    [--description <service-description>]
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os set tenant
+
os service delete
     [--name <new-tenant-name>]
+
     <service>
    [--description <new-tenant-description>]
 
    [--enable | --disable]
 
    <tenant>
 
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone tenant-update
+
keystone service-delete
    [--name <tenant_name>]
+
     <service-id>
    [--description <tenant-description>]
 
    [--enabled <true|false>]
 
     <tenant-id>
 
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os show tenant
+
os service list
     <tenant>
+
     [--long]
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone tenant-get
+
keystone service-list
    <tenant-id>
 
 
</source>
 
</source>
|}
 
 
 
==== token ====
 
 
{| class="wikitable"
 
|-
 
! OSC Command !! Implemented !! !! Keystone command
 
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os show token
+
os service show
     [--width <token-display-width>]
+
     [--catalog]
 +
    <service>
 
</source>
 
</source>
|| ??
+
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone token-get [--wrap <integer>]
+
keystone service-get
 +
    <service-id>
 
</source>
 
</source>
 
|}
 
|}
  
 
+
==== tenant ====
====user====
 
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 524: Line 688:
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os create user
+
os tenant create
     [--password <user-password>]
+
     [--description <description>]
    [--email <user-email>]
 
    [--tenant <tenant>]
 
 
     [--enable | --disable]
 
     [--enable | --disable]
     <user-name>
+
     <tenant-name>
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone user-create
+
keystone tenant-create
     --name <user-name>  
+
     --name <tenant-name>
     [--tenant_id <tenant-id>]
+
     [--description <tenant-description>]
    [--pass <pass>]
 
    [--email <email>]
 
 
     [--enabled <true|false>]
 
     [--enabled <true|false>]
 
</source>
 
</source>
Line 544: Line 704:
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os delete user
+
os tenant delete
     <user>
+
     <tenant>
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone user-delete
+
keystone tenant-delete
     <user-id>
+
     <tenant>
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os list user
+
os tenant list
    [--tenant <tenant>]
 
 
     [--long]
 
     [--long]
 
</source>
 
</source>
Line 563: Line 722:
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone user-list
+
keystone tenant-list
    [<tenant-id>]
 
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os set user
+
os tenant set
     [--name <new-user-name>]
+
     [--name <new-tenant-name>]
     [--password <user-password>]
+
     [--description <new-tenant-description>]
    [--email <user-email>]
+
     [--enable | --disable]
    [--tenant <tenant>]
+
     <tenant>
     [--enable|--disable]
 
     <user>
 
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone user-password-update
+
keystone tenant-update
     --pass <password>
+
    [--name <tenant_name>]
     <user-id>
+
    [--description <tenant-description>]
 +
     [--enabled <true|false>]
 +
     <tenant-id>
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os show user
+
os tenant show
     <user>
+
     <tenant>
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone user-get
+
keystone tenant-get
     <user-id>
+
     <tenant-id>
 
</source>
 
</source>
 
|}
 
|}
  
 
+
==== token ====
====user-role====
 
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 607: Line 764:
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os add role-user
+
os token show
     [--tenant <tenant>]
+
     [--width <token-display-width>]
    <role> <user>
 
 
</source>
 
</source>
|| yes
+
|| ??
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone user-role-add
+
keystone token-get [--wrap <integer>]
    --user <user-id>
 
    --role <role-id>
 
    [--tenant_id <tenant-id>]
 
 
</source>
 
</source>
 +
|}
 +
 +
==== user ====
 +
 +
{| class="wikitable"
 +
|-
 +
! OSC Command !! Implemented !! !! Keystone command
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os list role-user
+
os user create
 +
    [--password <user-password>]
 +
    [--email <user-email>]
 
     [--tenant <tenant>]
 
     [--tenant <tenant>]
     [<user>]
+
     [--enable | --disable]
 +
    <user-name>
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone user-role-list
+
keystone user-create
     [--user <user-id>]
+
     --name <user-name>  
 
     [--tenant_id <tenant-id>]
 
     [--tenant_id <tenant-id>]
 +
    [--pass <pass>]
 +
    [--email <email>]
 +
    [--enabled <true|false>]
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os remove role-user
+
os user delete
     [--tenant <tenant>]
+
     <user>
    <role> <user>
 
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone user-role-remove
+
keystone user-delete
     --user <user-id>
+
     <user-id>
    --role <role-id>
 
    [--tenant_id <tenant-id>]
 
 
</source>
 
</source>
|}
+
|-
 
+
|
 
 
'''<other>'''
 
 
 
 
<source lang="bash">
 
<source lang="bash">
keystone bootstrap
+
os user list
        --pass <password>
+
    [--tenant <tenant>]
        [--user-name <user-name>]
+
    [--long]
        [--role-name <role-name>]
 
        [--tenant-name <tenant-name>]
 
 
 
##TBD
 
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
 
 
 
<source lang="bash">
 
<source lang="bash">
keystone discover
+
keystone user-list
 
+
    [<tenant-id>]
##TBD
 
 
</source>
 
</source>
 
=== API v3 ===
 
 
====credential====
 
 
{| class="wikitable"
 
|-
 
! OSC Command !! Implemented !! !! Keystone command
 
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os create credential
+
os user set
     [--project <project>]
+
     [--name <new-user-name>]
     [--type ec2|cert]
+
    [--password <user-password>]
 +
    [--email <user-email>]
 +
     [--tenant <tenant>]
 +
    [--enable|--disable]
 
     <user>
 
     <user>
    <data>
 
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone credential-create
+
keystone user-password-update
    --user_id <user-id>
+
     --pass <password>
    --type <credential-type>
+
     <user-id>
     --data <credential-data>
 
     [--project_id <project-id>]
 
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os delete credential
+
os user show
     <credential-id>
+
     <user>
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone credential-delete
+
keystone user-get
     <credential-id>
+
     <user-id>
 
</source>
 
</source>
 +
|}
 +
 +
==== user role ====
 +
 +
{| class="wikitable"
 +
|-
 +
! OSC Command !! Implemented !! !! Keystone command
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os list credential
+
os user role add
 +
    [--tenant <tenant>]
 +
    <user>
 +
    <role>
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone credential-list
+
keystone user-role-add
 +
    --user <user-id>
 +
    --role <role-id>
 +
    [--tenant_id <tenant-id>]
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os set credential
+
os user role list
    [--user <user>]
+
     [--tenant <tenant>]
     [--type <type>]
+
     [<user>]
     [--data <data>]
 
    [--project <project>]
 
    <credential-id>
 
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone credential-update
+
keystone user-role-list
     [--user <user>]
+
     [--user <user-id>]
    [--type <type>]
+
     [--tenant_id <tenant-id>]
    [--data <data>]
 
     [--project <project>]
 
    <credential-id>
 
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os show credential
+
os user role remove
     <credential-id>
+
     [--tenant <tenant>]
 +
    <user>
 +
    <role>
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone credential-get
+
keystone user-role-remove
     <credential-id>
+
    --user <user-id>
 +
     --role <role-id>
 +
    [--tenant_id <tenant-id>]
 
</source>
 
</source>
 
|}
 
|}
  
====domain====
+
==== <other> ====
 +
 
 +
These keystone commands are not planned for re-implementation in OpenStackClient
 +
 
 +
<source lang="bash">
 +
keystone bootstrap
 +
        --pass <password>
 +
        [--user-name <user-name>]
 +
        [--role-name <role-name>]
 +
        [--tenant-name <tenant-name>]
 +
</source>
 +
 
 +
<source lang="bash">
 +
keystone discover
 +
</source>
 +
 
 +
=== API v3 ===
 +
 
 +
==== credential ====
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 760: Line 935:
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os create domain
+
os credential create
     [--description <domain-description>]
+
     [--project <project>]
     [--enable | --disable]
+
     [--type ec2|cert]
     <domain-name>
+
     <user>
 +
    <data>
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone domain-create
+
keystone credential-create
     --name <domain-name>
+
     --user_id <user-id>
     [--description <domain-description>]
+
     --type <credential-type>
     [--enabled <true|false>]
+
     --data <credential-data>
     [--private_project_names <true|false>]
+
     [--project_id <project-id>]
    [--private_user_names <true|false>]
 
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os delete domain
+
os credential delete
     <domain>
+
     <credential-id>
 
</source>
 
</source>
|| in progress
+
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone domain-delete
+
keystone credential-delete
     <domain-id>
+
     <credential-id>
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os list domain
+
os credential list
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone domain-list
+
keystone credential-list
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os set domain
+
os credential set
     [--name <new-domain-name>]
+
     [--user <user>]
     [--description <new-domain-description>]
+
    [--type ec2|cert]
     [--enable | --disable]
+
     [--data <data>]
     <domain>
+
     [--project <project>]
 +
     <credential-id>
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone domain-update
+
keystone credential-update
     [--name <domain_name>]
+
     [--user <user>]
     [--description <domain-description>]
+
     [--type <type>]
    [--enabled <true|false>]
+
     [--data <data>]
     [--private_project_names <true|false>]
+
     [--project <project>]
     [--private_user_names <true|false>]
+
     <credential-id>
     <domain-id>
 
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os show domain
+
os credential show
     <domain>
+
     <credential-id>
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone domain-get
+
keystone credential-get
     <domain-id>
+
     <credential-id>
 
</source>
 
</source>
 
|}
 
|}
  
==== endpoint ====
+
==== domain ====
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 839: Line 1,014:
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os create endpoint
+
os domain create
     [--region <endpoint-region>
+
     [--description <domain-description>]
 
     [--enable | --disable]
 
     [--enable | --disable]
     <service>
+
     <domain-name>
    <endpoint-interface>
 
    <endpoint-url>
 
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
 +
keystone domain-create
 +
    --name <domain-name>
 +
    [--description <domain-description>]
 +
    [--enabled <true|false>]
 +
    [--private_project_names <true|false>]
 +
    [--private_user_names <true|false>]
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os delete endpoint
+
os domain delete
     <endpoint-id>
+
     <domain>
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
 +
keystone domain-delete
 +
    <domain-id>
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os list endpoint
+
os domain list
    [--long]
 
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
 +
keystone domain-list
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os set endpoint
+
os domain set
     [--interface <endpoint-interface>]
+
     [--name <new-domain-name>]
    [--url <endpoint-url>]
+
     [--description <new-domain-description>]
     [--service <service-id>]
 
    [--region <endpoint-region>]
 
 
     [--enable | --disable]
 
     [--enable | --disable]
     <endpoint>
+
     <domain>
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
 +
keystone domain-update
 +
    [--name <domain_name>]
 +
    [--description <domain-description>]
 +
    [--enabled <true|false>]
 +
    [--private_project_names <true|false>]
 +
    [--private_user_names <true|false>]
 +
    <domain-id>
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os show endpoint
+
os domain show
     <endpoint>
+
     <domain>
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
 +
keystone domain-get
 +
    <domain-id>
 
</source>
 
</source>
 
|}
 
|}
  
====group====
+
==== endpoint ====
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 905: Line 1,093:
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os create group
+
os endpoint create
     [--domain <domain>]
+
     [--region <endpoint-region>
     [--description <group-description>]
+
     [--enable | --disable]
     <group-name>
+
    <service>
 +
    <interface admin|public|internal>
 +
     <url>
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone group-create
+
keystone endpoint-create  
     --name <group-name>
+
     [--region <endpoint-region>
     [--domain_id <domain-id>]
+
     [--enable | --disable]
     [--description <group-description>]
+
    <service_id>
 +
    <interface admin|public|internal>
 +
     <url>
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os delete group
+
os endpoint delete
     <group>
+
     <endpoint-id>
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone group-delete
 
    <group-id>
 
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os list group
+
os endpoint list
 
     [--long]
 
     [--long]
 
</source>
 
</source>
Line 939: Line 1,129:
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone group-list
+
keystone endpoint-list
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os set group
+
os endpoint set
     [--name <new-group-name>]
+
     [--interface <endpoint-interface>]
     [--domain <domain>]
+
    [--url <endpoint-url>]
     [--description <new-group-description>]
+
     [--service <service-id>]
     <group>
+
     [--region <endpoint-region>]
 +
    [--enable | --disable]
 +
     <endpoint>
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone group-update
+
keystone endpoint-set
     [--name <group_name>]
+
     [--interface <endpoint-interface>]
     [--domain_id <domain-id>]
+
    [--url <endpoint-url>]
     [--description <group-description>]
+
     [--service <service-id>]
     <group-id>
+
     [--region <endpoint-region>]
 +
    [--enable | --disable]
 +
     <endpoint>
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os show group
+
os endpoint show
     <group>
+
     <endpoint>
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone group-get
+
keystone endpoint-get  
     <group-id>
+
     <endpoint>
 
</source>
 
</source>
 
|}
 
|}
  
====policy====
+
==== group ====
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 981: Line 1,175:
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os create policy
+
os group create
     [--type <policy-type>]
+
     [--domain <domain>]
     --blob <policy-blob>
+
     [--description <group-description>]
 +
    <group-name>
 
</source>
 
</source>
|| in progress
+
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone policy-create
+
keystone group-create
     --type <policy-type>
+
     --name <group-name>
     --blob <policy-blob>
+
     [--domain_id <domain-id>]
 +
    [--description <group-description>]
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os delete policy
+
os group delete
     <policy-id>
+
     <group>
 
</source>
 
</source>
|| in progress
+
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone policy-delete
+
keystone group-delete
     <policy-id>
+
     <group-id>
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os list policy
+
os group list
     [--include-blob]
+
     [--long]
 
</source>
 
</source>
|| in progress
+
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone policy-list
+
keystone group-list
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os set policy
+
os group set
     [--type <policy-type>]
+
     [--name <new-group-name>]
     [--blob <policy-blob>]
+
     [--domain <domain>]
     <policy-id>
+
    [--description <new-group-description>]
 +
     <group>
 
</source>
 
</source>
|| in progress
+
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone policy-update
+
keystone group-update
     [--type <policy-type>]
+
     [--name <group_name>]
     [--blob <policy-blob>]
+
    [--domain_id <domain-id>]
     <policy-id>
+
     [--description <group-description>]
 +
     <group-id>
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os show policy
+
os group show
     <policy-id>
+
     <group>
 
</source>
 
</source>
|| in progress
+
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone policy-get
+
keystone group-get
     <policy-id>
+
     <group-id>
 
</source>
 
</source>
 
|}
 
|}
  
 
+
==== oauth ====
====project====
 
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 1,054: Line 1,251:
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os create project
+
os access token create
     [--domain <project-domain>]
+
     --consumer-key <consumer-key>
     [--description <project-description>]
+
     --consumer-secret <consumer-secret>
     [--enable | --disable]
+
     --request-key <request-key>
     <project-name>
+
     --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 delete project
+
os oauth token create
     <project>
+
     --consumer-key <consumer-key>
 +
    --consumer-secret <consumer-secret>
 +
    --request-key <request-key>
 +
    --request-secret <request-secret>
 +
    --verifier <pin>
 
</source>
 
</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 list project [--long]
+
os oauth token create
 +
    --access
 +
    --consumer-key <consumer-key>
 +
    --consumer-secret <consumer-secret>
 +
    --request-key <request-key>
 +
    --request-secret <request-secret>
 +
    --verifier <pin>
 +
 
 +
os oauth token create
 +
    --request
 +
    --consumer-key <consumer-key>
 +
    --roles <roles>
 
</source>
 
</source>
|| yes
+
|| nyet
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
 +
* 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 set project
+
os policy create
     [--name <new-project-name>]
+
     [--type <policy-type>]
     [--domain <project-domain>]
+
     --blob-file <blob-file>
    [--description <new-project-description>]
 
    [--enable | --disable]
 
    <project>
 
 
</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 show project
+
os policy delete
     <project>
+
     <policy-id>
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
 +
keystone policy-delete
 +
    <policy-id>
 
</source>
 
</source>
|}
 
 
 
====role====
 
 
{| class="wikitable"
 
 
|-
 
|-
! OSC Command !! Implemented !! !! Keystone command
+
|
|-
 
|
 
 
<source lang="bash">
 
<source lang="bash">
os add role
+
os policy list
     [--user <user> | --group <group>]
+
     [--include-blob]
    [--domain <domain> | --project <project>]
 
    <role>
 
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
 +
keystone policy-list
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os create role
+
os policy set
     <role-name>
+
    [--type <policy-type>]
 +
    [--blob-file<blob-file>]
 +
     <policy-id>
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
 +
keystone policy-update
 +
    [--type <policy-type>]
 +
    [--blob <policy-blob>]
 +
    <policy-id>
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os delete role
+
os policy show
     <role>
+
     <policy-id>
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
 +
keystone policy-get
 +
    <policy-id>
 
</source>
 
</source>
 +
|}
 +
 +
==== project ====
 +
 +
{| class="wikitable"
 +
|-
 +
! OSC Command !! Implemented !! !! Keystone command
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os list role
+
os project create
 +
    [--domain <project-domain>]
 +
    [--description <project-description>]
 +
    [--enable | --disable]
 +
    <project-name>
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
 +
keystone project-create
 +
    [--domain_id <domain_id>]
 +
    [--description <description>]
 +
    [--enable | --disable]
 +
    <name>
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os set role
+
os project delete
     [--name <new-role-name>]
+
     <project>
    <role>
 
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
 +
os project-delete
 +
    <project_id>
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os show role
+
os project list
     <role>
+
     [--long]
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
 +
keystone project-list
 
</source>
 
</source>
|}
 
 
====service====
 
 
{| class="wikitable"
 
|-
 
! OSC Command !! Implemented !! !! Keystone command
 
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os create service
+
os project set
[--name <name>]
+
    [--name <new-project-name>]
        [--enabled <true|false>]
+
    [--domain <project-domain>]
        <type>
+
    [--description <new-project-description>]
 +
    [--enable | --disable]
 +
    <project>
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
 +
keystone project-set
 +
    [--name <new-project-name>]
 +
    [--domain <project-domain>]
 +
    [--description <new-project-description>]
 +
    [--enable | --disable]
 +
    <project_id>
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os delete service
+
os project show
     <service>
+
     <project>
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
 +
keystone project-get
 +
    <project_id>
 
</source>
 
</source>
 +
|}
 +
 +
==== role ====
 +
 +
{| class="wikitable"
 +
|-
 +
! OSC Command !! Implemented !! !! Keystone command
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os list service
+
os role add
 +
    [--user <user> | --group <group>]
 +
    [--domain <domain> | --project <project>]
 +
    <role>
 
</source>
 
</source>
 
|| yes
 
|| yes
Line 1,218: Line 1,476:
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os set service
+
os role create
     [--type <service-type>]
+
     <role-name>
    [--name <new-name>]
 
    [--enable | --disable]
 
    <service>
 
 
</source>
 
</source>
 
|| yes
 
|| yes
Line 1,231: Line 1,486:
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os show service
+
os role delete
     <service>
+
     <role>
 
</source>
 
</source>
 
|| yes
 
|| yes
Line 1,238: Line 1,493:
 
<source lang="bash">
 
<source lang="bash">
 
</source>
 
</source>
|}
 
 
====user====
 
 
{| class="wikitable"
 
|-
 
! OSC Command !! Implemented !! !! Keystone command
 
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os create user
+
os role list
    [--password <password>]
 
    [--project <project>]
 
    [--email <user-email>]
 
    [--enable | --disable]
 
    <name>
 
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone user-create
 
    --name <user-name>
 
    [--domain_id <domain-id>]
 
    [--default_project_id <project-id>]
 
    [--description <description>]
 
    [--enabled <true|false>]
 
    [--password <password>]
 
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os delete user
+
os role remove
     <user>
+
    [--user <user> | --group <group>]
 +
     [--domain <domain> | --project <project>]
 +
    <role>
 
</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 set
     [--project <project>]
+
     [--name <new-role-name>]
     [--long]
+
     <role>
 
</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 show
     [--name <new-name>]
+
     <role>
    [--password <password>]
+
</source>
    [--project <project>]
+
|| yes
    [--email <user-email>]
+
|| ||
    [--enable | --disable]
+
<source lang="bash">
    <user>
+
</source>
 +
|}
 +
 
 +
==== service ====
 +
 
 +
{| class="wikitable"
 +
|-
 +
! OSC Command !! Implemented !! !! Keystone command
 +
|-
 +
|
 +
<source lang="bash">
 +
os service create
 +
[--name <name>]
 +
        [--enabled <true|false>]
 +
        <type>
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone user-update
+
keystone service-create
    --user_id <user-id>
+
[--name <name>]
    [--name <user-name>]
+
        [--enabled <true|false>]
    [--domain_id <domain-id>]
+
        <type>
    [--default_project_id <project-id>]
 
    [--description <description>]
 
    [--enabled <true|false>]
 
    [--password <password>]
 
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os show user
+
os service delete
     <user>
+
     <service>
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
keystone user-get
+
keystone service-delete
     <user-id>
+
     <service_id>
 
</source>
 
</source>
|}
 
 
== Compute ==
 
 
 
{| class="wikitable"
 
|-
 
! OSC Option !! Environment Variable !! !! Nova Option !! Environment Variable
 
|-
 
| || || || --os-auth-system <auth-system> || OS_AUTH_SYSTEM
 
|-
 
| || || || --service-type <type> ||
 
|-
 
| || || || --service-name <name> || NOVA_SERVICE_NAME
 
|-
 
| || || || --volume-service-name <name> || NOVA_VOLUME_SERVICE_NAME
 
|-
 
| || || || --endpoint-type <type> || NOVA_ENDPOINT_TYPE
 
|-
 
| --os-compute-api-version <ver> || OS_COMPUTE_API_VERSION || || --os-compute-api-version <ver> || OS_COMPUTE_API_VERSION
 
|-
 
| || || || --bypass-url <bypass-url> ||
 
|}
 
 
 
=== API v2 (1.1) ===
 
 
==== agent ====
 
 
{| class="wikitable"
 
|-
 
! OSC Command !! Implemented !! !! Nova command
 
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os create agent
+
os list service
    <os>
+
</source>
    <architecture>
+
|| yes
    <version>
+
|| ||
    <url>
+
<source lang="bash">
    <md5hash>
+
keystone service-list
    <hypervisor>
 
 
</source>
 
</source>
|| yes
 
|| ||
 
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os delete agent
+
os service set
     <id>
+
     [--type <service-type>]
 +
    [--name <new-name>]
 +
    [--enable | --disable]
 +
    <service>
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
|-
 
|
 
 
<source lang="bash">
 
<source lang="bash">
os list agent
+
keystone service-set
     [--hypervisor <hypervisor>]
+
    [--type <service-type>]
 +
     [--name <new-name>]
 +
    [--enable | --disable]
 +
    <service>
 
</source>
 
</source>
|| yes
 
|| ||
 
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os set agent
+
os service show
     <id>
+
     <service>
    <version>
 
    <url>
 
    <md5hash>
 
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
|}
 
 
 
'''aggregate'''
 
 
 
<source lang="bash">
 
<source lang="bash">
nova aggregate-create <name> <availability_zone>
+
keystone service-get
 
+
    <service_id>
os create aggregate ...
 
 
</source>
 
</source>
 +
|}
  
 +
==== user ====
  
 +
{| class="wikitable"
 +
|-
 +
! OSC Command !! Implemented !! !! Keystone command
 +
|-
 +
|
 
<source lang="bash">
 
<source lang="bash">
nova aggregate-delete <id>
+
os user create
 
+
    [--password <password>]
os delete aggregate ...
+
    [--project <project>]
 +
    [--email <user-email>]
 +
    [--enable | --disable]
 +
    <name>
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova aggregate-details <id>
+
keystone user-create
 
+
    --name <user-name>
os show aggregate ...
+
    [--domain_id <domain-id>]
 +
    [--default_project_id <project-id>]
 +
    [--description <description>]
 +
    [--enabled <true|false>]
 +
    [--password <password>]
 
</source>
 
</source>
 
+
|-
 
+
|
 
<source lang="bash">
 
<source lang="bash">
nova aggregate-list
+
os user delete
 
+
    <user>
os list aggregate
 
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova aggregate-update <id> <name> [<availability_zone>]
+
keystone user-delete
 
+
    <user-id>
os set aggregate ...
 
 
</source>
 
</source>
 
+
|-
 
+
|
 
<source lang="bash">
 
<source lang="bash">
nova aggregate-set-metadata <id> <key=value> [<key=value> ...]
+
os user list
 
+
    [--project <project>]
os set aggregate --metadata ...
+
    [--long]
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
'''aggregate-host'''
 
 
 
 
<source lang="bash">
 
<source lang="bash">
nova aggregate-add-host <id> <host>
+
keystone user-list
 
 
os add aggregate-host ...
 
 
</source>
 
</source>
 
+
|-
 
+
|
 
<source lang="bash">
 
<source lang="bash">
nova aggregate-remove-host <id> <host>
+
os user set
 
+
    [--name <new-name>]
os remove aggregate-host ...
+
    [--password <password>]
 +
    [--project <project>]
 +
    [--email <user-email>]
 +
    [--enable | --disable]
 +
    <user>
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
'''bash-completion'''
 
 
 
 
<source lang="bash">
 
<source lang="bash">
nova bash-completion
+
keystone user-update
 
+
    --user_id <user-id>
os show bash-completion
+
    [--name <user-name>]
</source>
+
    [--domain_id <domain-id>]
 
+
    [--default_project_id <project-id>]
 
+
    [--description <description>]
'''cloudpipe'''
+
    [--enabled <true|false>]
 
+
    [--password <password>]
<source lang="bash">
 
nova cloudpipe-create <project>
 
 
 
os create cloudpipe ...
 
 
</source>
 
</source>
 
+
|-
 
+
|
 
<source lang="bash">
 
<source lang="bash">
nova cloudpipe-list
+
os user show
 
+
    <user>
os list cloudpipe
 
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
'''console'''
 
 
 
 
<source lang="bash">
 
<source lang="bash">
nova console-log [--length <length>] <server>
+
keystone user-get
 
+
    <user-id>
os show console ...
 
 
</source>
 
</source>
 +
|}
  
 +
== Compute ==
  
<source lang="bash">
 
nova get-vnc-console <server> <console_type>
 
  
os show console [--vnc] ...
+
{| class="wikitable"
</source>
+
|-
 
+
! OSC Option !! Environment Variable !! !! Nova Option !! Environment Variable
 
+
|-
'''credentials'''
+
| || || || --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> ||
 +
|}
  
<source lang="bash">
 
nova credentials
 
  
os show credentials
+
=== API v2 (1.1) ===
</source>
 
  
 +
==== agent ====
  
'''diagnostics'''
+
{| class="wikitable"
 
+
|-
 +
! OSC Command !! Implemented !! !! Nova command
 +
|-
 +
|
 
<source lang="bash">
 
<source lang="bash">
nova diagnostics <server>
+
os agent create
 
+
    <os>
os show diagnostics ...
+
    <architecture>
 +
    <version>
 +
    <url>
 +
    <md5hash>
 +
    <hypervisor>
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
'''dns'''
+
|-
 
+
|
 
<source lang="bash">
 
<source lang="bash">
nova dns-create [--type <type>] <ip> <name> <domain>
+
os agent delete
 
+
    <id>
os create dns ...
 
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
 +
|-
 +
|
 
<source lang="bash">
 
<source lang="bash">
nova dns-delete <domain> <name>
+
os agent list
 
+
    [--hypervisor <hypervisor>]
os delete dns ...
 
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
 +
|-
 +
|
 
<source lang="bash">
 
<source lang="bash">
nova dns-list [--ip <ip>] [--name <name>] <domain>
+
os agent set
 
+
    <id>
os list dns ...
+
    <version>
 +
    <url>
 +
    <md5hash>
 
</source>
 
</source>
 +
|| yes
 +
|| ||
 +
|}
  
  
'''dns-domain'''
+
==== aggregate ====
  
 +
{| class="wikitable"
 +
|-
 +
! OSC Command !! Implemented !! !! Nova command
 +
|-
 +
|
 
<source lang="bash">
 
<source lang="bash">
nova dns-create-private-domain [--availability_zone <availability_zone>]
+
os aggregate add host
                              <domain>
+
    <aggregate>
 
+
    <host>
os create dns-domain [--private] ...
 
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
'''dns-public-domain'''
 
 
 
 
<source lang="bash">
 
<source lang="bash">
nova dns-create-public-domain [--project <project>] <domain>
+
nova aggregate-add-host
 
+
    <id>
os create dns-domain [--public] ...
+
    <host>
 
</source>
 
</source>
 
+
|-
 
+
|
 
<source lang="bash">
 
<source lang="bash">
nova dns-delete-domain <domain>
+
os aggregate create
 
+
    [--zone <availability-zone>]
os delete dns-domain ...
+
    [--property <key=value>]
 +
    <name>
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova dns-domains
+
nova aggregate-create
 
+
    <name>
os list dns-domains
+
    [<availability_zone>]
 
</source>
 
</source>
 
+
|-
 
+
|
'''endpoints'''
 
 
 
 
<source lang="bash">
 
<source lang="bash">
nova endpoints
+
os aggregate delete
 
+
    <aggregate>
os list endpoints
+
</source>
 
+
|| yes
# does this overlap with keystone?
+
|| ||
 +
<source lang="bash">
 +
nova aggregate-delete
 +
    <id>
 
</source>
 
</source>
 
 
==== fixed-ip ====
 
 
{| class="wikitable"
 
|-
 
! OSC Command !! Implemented !! !! Nova command
 
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os add fixed-ip
+
os aggregate list
     <network>
+
     [--long]
    <server>
 
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova add-fixed-ip
+
nova aggregate-list
    <server>
 
    <network_id>
 
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os remove fixed-ip
+
os aggregate remove host
     <ip-address>
+
     <aggregate>
     <server>
+
     <host>
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova remove-fixed-ip
+
nova aggregate-remove-host
     <server>
+
     <id>
     <address>
+
     <host>
 
</source>
 
</source>
|}
 
 
 
==== flavor ====
 
 
{| class="wikitable"
 
|-
 
! OSC Command !! Implemented !! !! Nova command
 
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os create flavor
+
os aggregate set
     [--id <id>]
+
     [--name <new-name>]
    [--ram <size-mb>]
+
     [--zone <availability-zone>]
     [--disk <size-gb>]
+
     [--property <key=value>]
     [--ephemeral-disk <size-gb>]
+
     <aggregate>
    [--swap <size-mb>]
+
</source>
    [--vcpus <num-cpu>]
+
|| yes
    [--rxtx-factor <factor>]
 
    [--public | --private]
 
     <name>
 
</source>
 
||
 
<source lang="bash">
 
(partial)
 
default: auto
 
default: 256M
 
default: 0G
 
default: 0G
 
default: 0G
 
default: 1
 
default: 1
 
default: public
 
 
 
</source>
 
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova flavor-create
+
nova aggregate-update
     [--ephemeral <ephemeral>]
+
     <id>
    [--swap <swap>]
 
    [--rxtx-factor <factor>]
 
 
     <name>
 
     <name>
 +
    [<availability_zone>]
 +
 +
nova aggregate-set-metadata
 
     <id>
 
     <id>
     <ram>
+
     <key=value>
     <disk>
+
     [<key=value> ...]
    <vcpus>
 
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os delete flavor
+
os aggregate show
     <flavor>
+
     <aggregate>
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova flavor-delete
+
nova aggregate-details
 
     <id>
 
     <id>
 
</source>
 
</source>
|-
+
|}
 +
 
 +
==== bash-completion ====
 +
 
 +
{| class="wikitable"
 +
|-
 +
! OSC Command !! Implemented !! !! Nova command
 +
|-
 +
|
 +
TBD
 +
|| no
 +
|| ||
 +
<source lang="bash">
 +
nova bash-completion
 +
</source>
 +
|}
 +
 
 +
==== cloudpipe ====
 +
 
 +
{| class="wikitable"
 +
|-
 +
! OSC Command !! Implemented !! !! Nova command
 +
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os list flavor
+
os create cloudpipe
 +
    <project>
 
</source>
 
</source>
|| yes
+
|| no
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova flavor-list
+
nova cloudpipe-create
 +
    <project>
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os show flavor
+
os list cloudpipe
    <flavor>
 
 
</source>
 
</source>
|| yes
+
|| no
 
|| ||
 
|| ||
 +
<source lang="bash">
 +
nova cloudpipe-list
 +
</source>
 
|}
 
|}
  
 
+
==== console ====
=== floating-ip ====
 
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 1,707: Line 1,931:
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os add floating-ip
+
os console log show
     <ip-address>
+
     [--lines <num-lines>]
 
     <server>
 
     <server>
 
</source>
 
</source>
Line 1,714: Line 1,938:
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova add-floating-ip
+
nova console-log
 +
    [--length <length>]
 
     <server>
 
     <server>
    <address>
 
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os create floating-ip
+
os console url show
     [<pool>]
+
    [--novnc | --xvpvnc | --spice]
 +
     <server>
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova floating-ip-create
+
nova get-vnc-console
     [<floating_ip_pool>]
+
     <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 delete floating-ip
+
os diagnostics show
     <ip-address>
+
     <server>
 
</source>
 
</source>
|| yes
+
|| no
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova floating-ip-delete
+
nova diagnostics
     <address>
+
     <server>
 
</source>
 
</source>
 +
|}
 +
 +
==== dns ====
 +
 +
''These commands need some attention...an IP shouldn't be required for all record types.  They need to be more DNS-y.  Zone anyone?''
 +
{| class="wikitable"
 +
|-
 +
! OSC Command !! Implemented !! !! Nova command
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os list floating-ip
+
os create dns
 +
    [--type <type>]
 +
    <ip>
 +
    <name>
 +
    <domain>
 
</source>
 
</source>
|| yes
+
|| no
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova floating-ip-list
+
nova dns-create
 +
    [--type <type>]
 +
    <ip>
 +
    <name>
 +
    <domain>
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os remove floating-ip
+
os delete dns
     <ip-address>
+
     <domain>
     <server>
+
     <name>
 
</source>
 
</source>
|| yes
+
|| no
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova remove-floating-ip
+
nova dns-delete
     <server>
+
     <domain>
     <address>
+
     <name>
 
</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
 +
    [--ip <ip>]
 +
    [--name <name>]
 +
    <domain>
 
</source>
 
</source>
|| yes
+
|| no
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova floating-ip-pool-list
+
nova dns-list
 +
    [--ip <ip>]
 +
    [--name <name>]
 +
    <domain>
 
</source>
 
</source>
|}
 
 
 
==== host ====
 
 
{| class="wikitable"
 
|-
 
! OSC Command !! Implemented !! !! Nova command
 
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os list host
+
os create dns-domain
     [--zone <availability-zone>]
+
    [--project <project>]
 +
     [--availability-zone <availability-zone>]
 +
    [--public | --private]
 +
    <domain>
 
</source>
 
</source>
|| yes
+
|| no
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova host-action
+
nova dns-create-private-domain
     [--action <action>]
+
    [--availability_zone <availability_zone>]
     <hostname>
+
    <domain>
 +
 
 +
nova dns-create-public-domain
 +
     [--project <project>]
 +
     <domain>
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os set host
+
os delete dns-domain
     ...
+
     <domain>
 
</source>
 
</source>
 
|| no
 
|| no
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova host-update
+
nova dns-delete-domain
    [--status <status>]
+
     <domain>
    [--maintenance <maintenance_mode>]
 
     <hostname>
 
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os show host
+
os list dns-domains
    <host>
 
 
</source>
 
</source>
|| yes
+
|| no
 
|| ||
 
|| ||
 +
<source lang="bash">
 +
nova dns-domains
 +
</source>
 
|}
 
|}
  
 +
==== endpoints ====
  
==== hypervisor ====
+
''Totally duplicates Identity catalog command''
 
 
 
{| class="wikitable"
 
{| class="wikitable"
 
|-
 
|-
Line 1,839: Line 2,089:
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os list hypervisor
+
os endpoint list
    [--matching <hostname>]
 
 
</source>
 
</source>
|| yes
+
|| no
 
|| ||
 
|| ||
|-
 
|
 
 
<source lang="bash">
 
<source lang="bash">
os show hypervisor
+
nova endpoints
    <id>
 
 
</source>
 
</source>
|| yes
 
|| ||
 
 
|}
 
|}
  
 
+
==== fixed-ip ====
==== keypair ====
 
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 1,863: Line 2,106:
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os create keypair
+
os ip fixed add
     [--public-key <file>]
+
     <network>
     <name>
+
     <server>
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova keypair-add
+
nova add-fixed-ip
     [--pub_key <pub_key>]
+
     <server>
     <name>
+
     <network_id>
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os delete keypair
+
os ip fixed remove
     <name>
+
     <ip-address>
 +
    <server>
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova keypair-delete
+
nova remove-fixed-ip
     <name>
+
    <server>
 +
     <address>
 
</source>
 
</source>
 +
|}
 +
 +
 +
==== flavor ====
 +
 +
{| class="wikitable"
 
|-
 
|-
|
+
! OSC Command !! Implemented !! !! Nova command
<source lang="bash">
 
os list keypair
 
</source>
 
|| yes
 
|| ||
 
<source lang="bash">
 
nova keypair-list
 
</source>
 
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os show keypair
+
os flavor create
     [--public-key]
+
    [--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
+
||
|| ||
 
|}
 
 
 
 
 
'''limits'''
 
 
 
 
<source lang="bash">
 
<source lang="bash">
nova absolute-limits
+
(partial)
 +
default: auto
 +
default: 256M
 +
default: 0G
 +
default: 0G
 +
default: 0G
 +
default: 1
 +
default: 1
 +
default: public
  
os show limits --absolute
 
## is there any other kind?
 
 
</source>
 
</source>
 
+
|| ||
 
 
'''quota'''
 
 
 
 
<source lang="bash">
 
<source lang="bash">
nova quota-defaults <tenant_id>
+
nova flavor-create
nova quota-show <tenant_id>
+
    [--ephemeral <ephemeral>]
 
+
    [--swap <swap>]
os show quota <tenant> [--defaults]
+
    [--rxtx-factor <factor>]
</source>
+
    <name>
 
+
    <id>
 
+
    <ram>
 +
    <disk>
 +
    <vcpus>
 +
</source>
 +
|-
 +
|
 
<source lang="bash">
 
<source lang="bash">
nova quota-update [--instances <instances>]
+
os flavor delete
                  [--cores <cores>]
+
    <flavor>
                  [--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 flavor-delete
 
+
    <id>
os show quota-class ...
 
 
</source>
 
</source>
 
+
|-
 
+
|
 
<source lang="bash">
 
<source lang="bash">
nova quota-class-update [--instances <instances>]
+
os flavor list
                        [--cores <cores>]
 
                        [--ram <ram>]
 
                        [--volumes <volumes>]
 
                        [--gigabytes <gigabytes>]
 
                        [--floating-ips <floating_ips>]
 
                        [--metadata-items <metadata_items>]
 
                        [--injected-files <injected_files>]
 
                        [--injected-file-content-bytes <injected_file_content_bytes>]
 
                        <class>
 
 
 
os set quota-class ...
 
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
'''rate-limits'''
 
 
 
 
<source lang="bash">
 
<source lang="bash">
nova rate-limits
+
nova flavor-list
 
 
os show rate-limits
 
 
</source>
 
</source>
 
+
|-
 
+
|
'''resource'''
 
 
 
 
<source lang="bash">
 
<source lang="bash">
nova describe-resource <hostname>
+
os flavor show
 
+
    <flavor>
os show resource ...
 
 
</source>
 
</source>
 +
|| yes
 +
|| ||
 +
|}
  
  
==== secgroup ====
+
==== floating-ip ====
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 1,995: Line 2,219:
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os create secgroup ...
+
os ip floating add
 +
    <ip-address>
 +
    <server>
 
</source>
 
</source>
|| no
+
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova secgroup-create <name> <description>
+
nova add-floating-ip
 +
    <server>
 +
    <address>
 
</source>
 
</source>
|}
+
|-
 
+
|
 
 
 
<source lang="bash">
 
<source lang="bash">
nova secgroup-delete <secgroup>
+
os ip floating create
 
+
    [<pool>]
os delete secgroup ...
 
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova secgroup-list
+
nova floating-ip-create
 
+
    [<floating_ip_pool>]
os list secgroup
 
 
</source>
 
</source>
 
+
|-
 
+
|
'''secgroup-group-rule'''
 
 
 
 
<source lang="bash">
 
<source lang="bash">
nova secgroup-add-group-rule [--ip_proto <ip_proto>]
+
os ip floating delete
                            [--from_port <from_port>]
+
    <ip-address>
                            [--to_port <to_port>]
+
</source>
                            <secgroup> <source_group>
+
|| yes
 
+
|| ||
os create secgroup-group-rule
+
<source lang="bash">
 +
nova floating-ip-delete
 +
    <address>
 
</source>
 
</source>
 
+
|-
 
+
|
 
<source lang="bash">
 
<source lang="bash">
nova secgroup-delete-group-rule [--ip_proto <ip_proto>]
+
os ip floating list
                                [--from_port <from_port>]
 
                                [--to_port <to_port>]
 
                                <secgroup> <source_group>
 
 
 
os delete secgroup-group-rule ...
 
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
'''secgroup-rule'''
 
 
 
 
<source lang="bash">
 
<source lang="bash">
nova secgroup-add-rule <secgroup> <ip_proto> <from_port> <to_port> <cidr>
+
nova floating-ip-list
 
 
os create secgroup-rule
 
 
</source>
 
</source>
 
+
|-
 
+
|
 
<source lang="bash">
 
<source lang="bash">
nova secgroup-delete-rule <secgroup> <ip_proto> <from_port> <to_port> <cidr>
+
os ip floating remove
 
+
    <ip-address>
os delete secgroup-rule
+
    <server>
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova secgroup-list-rules <secgroup>
+
nova remove-floating-ip
 
+
    <server>
os list secgroup-rule ...
+
    <address>
 
</source>
 
</source>
 +
|}
 +
 +
 +
==== floating-ip-pool ====
  
====server====
 
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 2,071: Line 2,290:
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os create server
+
os ip floating pool list
    --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 boot
+
nova floating-ip-pool-list
    [--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>
 +
|}
 +
 +
 +
==== host ====
 +
 +
{| class="wikitable"
 +
|-
 +
! OSC Command !! Implemented !! !! Nova command
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os delete server
+
os host list
     <server>
+
     [--zone <availability-zone>]
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova delete
+
nova host-action
     <server>
+
     [--action <action>]
 +
    <hostname>
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os list server
+
os host set
    [--reservation-id <reservation-id>]
+
     ...
    [--ip <ip-regex>]
 
    [--ip6 <ip6-regex>]
 
    [--name <name-regex>]
 
    [--instance-name <instance-name-regex>]
 
    [--status <status>]
 
    [--flavor <flavor>]
 
    [--image <image>]
 
    [--host <hostname>]
 
     [--all-tenants]
 
 
</source>
 
</source>
|| yes
+
|| no
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova list
+
nova host-update
    [--reservation_id <reservation_id>]
+
     [--status <status>]  
    [--ip <ip_regexp>]
+
     [--maintenance <maintenance_mode>]
    [--ip6 <ip6_regexp>]
+
     <hostname>
    [--name <name_regexp>]
+
</source>
    [--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 host show
     <server>
+
     <host>
 
</source>
 
</source>
|| no
+
|| yes
 
|| ||
 
|| ||
 +
|}
 +
 +
 +
==== hypervisor ====
 +
 +
{| class="wikitable"
 +
|-
 +
! OSC Command !! Implemented !! !! Nova command
 +
|-
 +
|
 
<source lang="bash">
 
<source lang="bash">
nova lock
+
os hypervisor list
     <server>
+
     [--matching <hostname>]
 
</source>
 
</source>
 +
|| yes
 +
|| ||
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os migrate server
+
os hypervisor show
    --live
+
     <id>
    [--block_migrate]
 
    [--disk_over_commit]
 
    <server>
 
    <host>
 
 
 
os migrate server
 
    [--wait]
 
     <server>
 
 
</source>
 
</source>
|| no
+
|| yes
 
|| ||
 
|| ||
<source lang="bash">
+
|}
nova live-migration
+
 
    [--block_migrate]
+
 
    [--disk_over_commit]
+
==== keypair ====
    <server>
 
<host>
 
  
nova migrate
+
{| class="wikitable"
    [--poll]
+
|-
    <server>
+
! OSC Command !! Implemented !! !! Nova command
</source>
 
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os pause server
+
os keypair create
     <server>
+
     [--public-key <file>]
 +
    <name>
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova pause
+
nova keypair-add
     <server>
+
     [--pub_key <pub_key>]
 +
    <name>
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os reboot server
+
os keypair delete
    [--hard | --soft]
+
     <name>
    [--wait]
 
     <server>
 
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova reboot
+
nova keypair-delete
    [--hard]
+
     <name>
    [--poll]
 
     <server>
 
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os rebuild server
+
os keypair list
    --image <image>
 
    [--password <password>]
 
    [--wait]
 
    <server>
 
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova rebuild
+
nova keypair-list
    [--rebuild_password <rebuild_password>]
 
    [--poll]
 
    <server>
 
    <image>
 
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os rename server
+
os keypair show
     <server>
+
     [--public-key]
     <new-name>
+
     <name>
 
</source>
 
</source>
|| no
+
|| yes
 
|| ||
 
|| ||
<source lang="bash">
+
|}
nova rename
+
 
    <server>
+
 
    <name>
+
==== limits ====
</source>
+
 
 +
See [[#limits|limits]] in the [[#Cross_API|cross API section]].
 +
 
 +
==== quota ====
 +
 
 +
See [[#quota|quota]] in the [[#Cross_API|cross API section]].
 +
 
 +
 
 +
==== resource ====
 +
 
 +
{| class="wikitable"
 +
|-
 +
! OSC Command !! Implemented !! !! Nova command
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os rescue server
+
os show resource
     <server>
+
     <hostname>
 
</source>
 
</source>
 
|| no
 
|| no
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova rescue
+
nova describe-resource
     <server>
+
     <hostname>
 
</source>
 
</source>
 +
|}
 +
 +
==== secgroup ====
 +
 +
{| class="wikitable"
 +
|-
 +
! OSC Command !! Implemented !! !! Nova command
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os resize server
+
os secgroup add
    --flavor <flavor>
+
 
    [--wait]
+
(see server add secgroup)
    <server>
 
 
</source>
 
</source>
 
|| no
 
|| no
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova resize
+
nova add-secgroup
    [--poll]
 
 
     <server>
 
     <server>
     <flavor>
+
     <secgroup>
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os resize server
+
os secgroup create
     --confirm
+
     [--description <description>]
     <server>
+
     <name>
 
</source>
 
</source>
|| no
+
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova resize-confirm
+
nova secgroup-create
     <server>
+
     <name>
 +
    <description>
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os resume server
+
os secgroup delete
     <server>
+
     <group>
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova resume
+
nova secgroup-delete
     <server>
+
     <secgroup>
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os set server
+
os secgroup list
    --meta-data <key=value>
+
     [--all-projects]
    [--meta-data <key=value>] ...
+
</source>
    <server>
+
|| yes
os unset server
+
|| ||
    --meta-data <key>
 
     [--meta-data <key>] ...
 
    <server>
 
</source>
 
|| no
 
|| ||
 
 
<source lang="bash">
 
<source lang="bash">
nova meta
+
nova secgroup-list
    <server>
+
    [--all-tenants [<0|1>]]
    <action>
 
    <key=value>
 
    [<key=value> ...]
 
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os set server
+
os secgroup remove
    --root-password
+
 
    <server>
+
(see server remove secgroup)
 
</source>
 
</source>
 
|| no
 
|| no
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova root-password
+
nova remove-secgroup
 
     <server>
 
     <server>
 +
    <secgroup>
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os show server
+
os secgroup set
     <server>
+
     [--name <new-name>]
 +
    [--description [<new-description>]
 +
    <group>
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova show
+
nova secgroup-update
     <server>
+
     <secgroup>
 +
    <name>
 +
    <description>
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os ssh server
+
os secgroup show
    [--port PORT]
+
     <group>
    --private]
 
    [--ipv6]
 
    [--login <login>]
 
     <server>
 
 
</source>
 
</source>
|| no
+
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova ssh
+
n/a
    [--port PORT]
+
</source>
    [--private]
+
|}
    [--ipv6]
+
 
    [--login <login>]
+
==== secgroup-group-rule ====
    <server>
+
 
</source>
+
{| class="wikitable"
 +
|-
 +
! OSC Command !! Implemented !! !! Nova command
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os suspend server
+
os secgroup group rule create
     <server>
+
     [--proto <protocol>]
 +
    [--port <port>:<port>]
 +
    <source-group>
 +
    <secgroup>
 
</source>
 
</source>
|| yes
+
|| no
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova suspend
+
nova secgroup-add-group-rule
     <server>
+
     [--ip_proto <ip_proto>]
 +
    [--from_port <from_port>]
 +
    [--to_port <to_port>]
 +
    <secgroup>
 +
    <source_group>
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os unlock server
+
os secgroup group rule delete
     <server>
+
     [--proto <protocol>]
 +
    [--port <port>:<port>]
 +
    <source-group>
 +
    <secgroup>
 
</source>
 
</source>
 
|| no
 
|| no
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova unlock
+
nova secgroup-delete-group-rule
     <server>
+
     [--ip_proto <ip_proto>]
 +
    [--from_port <from_port>]
 +
    [--to_port <to_port>]
 +
    <secgroup>
 +
    <source_group>
 
</source>
 
</source>
 +
|}
 +
 +
==== secgroup-rule ====
 +
 +
{| class="wikitable"
 +
|-
 +
! OSC Command !! Implemented !! !! Nova command
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os unpause server
+
os secgroup rule create
     <server>
+
     [--proto <proto>]
 +
    [--src-ip <ip-address>]
 +
    [--dst-port <port-range>]
 +
    <group>
 
</source>
 
</source>
|| yes
+
|| no
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
nova unpause
+
nova secgroup-add-rule
     <server>
+
     <secgroup>
 +
    <ip_proto>
 +
    <from_port>
 +
    <to_port>
 +
    <cidr>
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os unrescue 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 unrescue
+
nova secgroup-delete-rule
     <server>
+
     <secgroup>
 +
    <ip_proto>
 +
    <from_port>
 +
    <to_port>
 +
    <cidr>
 
</source>
 
</source>
|}
+
|-
 
+
|
 
 
'''usage'''
 
 
 
 
<source lang="bash">
 
<source lang="bash">
nova usage-list [--start <start>] [--end <end>]
+
os secgroup rule list
 
+
    <group>
os list usage ...
 
 
</source>
 
</source>
 
+
|| no
 
+
|| ||
'''volume'''
 
 
 
 
<source lang="bash">
 
<source lang="bash">
nova volume-attach <server> <volume> <device>
+
nova secgroup-list-rules
 +
    <secgroup>
 +
</source>
 +
|}
  
os attach volume ...
+
====server====
</source>
 
  
 +
{| class="wikitable"
 +
|-
 +
! OSC Command !! Implemented !! !! Nova command
 +
|-
 +
|
 
<source lang="bash">
 
<source lang="bash">
nova volume-detach <server> <volume>
+
os server add secgroup
 
+
    <server>
os detach volume ...
+
    <group>
 
</source>
 
</source>
 
+
|| no
 
+
|| ||
'''x509-cert'''
 
 
 
 
<source lang="bash">
 
<source lang="bash">
nova x509-create-cert [<private_key_file>] [<x509_cert>]
+
nova add-secgroup
 
+
    <server>
os create x509-cert ...
+
    <secgroup>
 
</source>
 
</source>
 
+
|-
 
+
|
'''x509-root-cert'''
 
 
 
 
<source lang="bash">
 
<source lang="bash">
nova x509-get-root-cert [<filename>]
+
os server create
 
+
    --image <image>
os show x509-root-cert ...
+
    --flavor <flavor>
</source>
+
    [--security-group <security-group-list> [...] ]
 
+
    [--key-name <key-name>]
== Image ==
+
    [--meta-data <key=value> [...] ]
 
+
    [--file <dest-filename=source-filename>] [...] ]
 
+
    [--user-data <user-data>]
{| class="wikitable"
+
    [--availability-zone <zone-name>]
|-  
+
    [--block-device-mapping <dev-name=mapping> [...] ]
! OSC Option !!  Environment Variable !!  !!  Glance Option !!  Environment Variable
+
    [--nic <net-id=net-uuid,v4-fixed-ip=ip-addr> [...] ]
|-  
+
    [--hint <key=value> [...] ]
| --os-image-api-version <ver> || OS_IMAGE_API_VERSION ||  || --os-image-api-version <ver> || OS_IMAGE_API_VERSION
+
    [--config-drive <value>|True ]
|-  
+
    [--min <count>]
|  ||  || || --os-service-type <type> || OS_SERVICE_TYPE
+
    [--max <count>]
|-  
+
    [--wait]
|  ||  || || --os-endpoint-type <type> || OS_ENDPOINT_TYPE
+
    <server-name>
|-  
+
</source>
| --os-token <token> || OS_TOKEN || || --os-auth-token <token> || OS_AUTH_TOKEN
+
|| yes
|-  
+
|| ||
| --os-url <url> || OS_URL || || --os-image-url <url> || OS_IMAGE_URL
+
<source lang="bash">
|-  
+
nova boot
|  ||  || || --os-cacert <file> || OS_CACERT
+
    [--flavor <flavor>]
|-  
+
    [--image <image>]
|  ||  || || --cert-file <file> || CERT_FILE
+
    [--meta <key=value>]
|-
+
    [--file <dst-path=src-path>]
|  ||  || || --key-file <key-file> || KEY_FILE
+
    [--key_name <key_name>]
|-  
+
    [--user_data <user-data>]
|  ||  || || --no-ssl-compression ||
+
    [--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>]
=== API v1 ===
+
    [--config-drive <value>]
 
+
    [--poll]
'''image'''
+
    <name>
 
+
</source>
{| class="wikitable"
 
|-
 
! OSC Command !! Implemented !! !! Glance command
 
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os create image
+
os server delete
     [--id <id>]
+
     <server>
    [--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">
glance image-create
+
nova delete
     [--id <IMAGE_ID>]
+
     <server>
    [--name <NAME>]
 
    [--disk-format <CONTAINER_FORMAT>]
 
    [--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 list
     <id>
+
    [--reservation-id <reservation-id>]
 +
    [--ip <ip-regex>]
 +
    [--ip6 <ip6-regex>]
 +
    [--name <name-regex>]
 +
    [--instance-name <instance-name-regex>]
 +
    [--status <status>]
 +
    [--flavor <flavor>]
 +
    [--image <image>]
 +
     [--host <hostname>]
 +
    [--all-tenants]
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
glance image-delete
+
nova list
     <IMAGE_ID>
+
    [--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">
glance image-list
+
os server lock
 
+
    <server>
os list image ...
 
 
</source>
 
</source>
 
+
|| no
 
+
|| ||
 
<source lang="bash">
 
<source lang="bash">
glance image-show <IMAGE_ID>
+
nova lock
 
+
    <server>
os show image ...
 
 
</source>
 
</source>
 
+
|-
 
+
|
 
<source lang="bash">
 
<source lang="bash">
glance member-images [options] <MEMBER>
+
os server migrate
 +
    --live
 +
    [--block_migrate]
 +
    [--disk_over_commit]
 +
    <server>
 +
    <host>
  
os list image --member <member> [options]
+
os server migrate
 +
    [--wait]
 +
    <server>
 
</source>
 
</source>
 
+
|| no
 
+
|| ||
 
<source lang="bash">
 
<source lang="bash">
glance show [options] <ID>
+
nova live-migration
 +
    [--block_migrate]  
 +
    [--disk_over_commit]
 +
    <server>
 +
<host>
  
os show image ...
+
nova migrate
 +
    [--poll]
 +
    <server>
 
</source>
 
</source>
 
+
|-
 
+
|
 
<source lang="bash">
 
<source lang="bash">
glance update [options] <ID> <field1=value1 field2=value2 ...>
+
os server pause
 
+
    <server>
os set image ...
 
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
'''image-member'''
 
 
 
 
<source lang="bash">
 
<source lang="bash">
glance member-create [--can-share] <IMAGE_ID> <TENANT_ID>
+
nova pause
 
+
    <server>
os create image-member ...
 
 
</source>
 
</source>
 
+
|-
 
+
|
 
<source lang="bash">
 
<source lang="bash">
glance member-delete <IMAGE_ID> <TENANT_ID>
+
os server reboot
 
+
    [--hard | --soft]
os list image-member <image> [options]
+
    [--wait]
 +
    <server>
 
</source>
 
</source>
 
+
|| yes
 
+
|| ||
 
<source lang="bash">
 
<source lang="bash">
glance member-delete [options] <ID> <MEMBER>
+
nova reboot
 
+
    [--hard]
os delete image-member ...
+
    [--poll]
 +
    <server>
 
</source>
 
</source>
 
+
|-
 
+
|
 
<source lang="bash">
 
<source lang="bash">
glance member-list [--image-id <IMAGE_ID>] [--tenant-id <TENANT_ID>]
+
os server rebuild
 
+
    --image <image>
os list image-member ...
+
    [--password <password>]  
 +
    [--wait]
 +
    <server>
 +
</source>
 +
|| yes
 +
|| ||
 +
<source lang="bash">
 +
nova rebuild
 +
    [--rebuild_password <rebuild_password>]  
 +
    [--poll]
 +
    <server>
 +
    <image>
 +
</source>
 +
|-
 +
|
 +
<source lang="bash">
 +
os server remove secgroup
 +
    <server>
 +
    <group>
 +
</source>
 +
|| no
 +
|| ||
 +
<source lang="bash">
 +
nova remove-secgroup
 +
    <server>
 +
    <secgroup>
 
</source>
 
</source>
 
== 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 rename
     <tenant>
+
     <server>
 +
    <new-name>
 
</source>
 
</source>
|| yes
+
|| no
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
 +
nova rename
 +
    <server>
 +
    <name>
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os set quota
+
os server rescue
     [--volumes] <new-volumes>]
+
     <server>
    [--gigabytes <new-gigabytes>]
 
    <tenant>
 
 
</source>
 
</source>
|| yes
+
|| no
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
cinder quota-update
+
nova rescue
     [--volumes <volumes>]
+
     <server>
    [--snapshots <snapshots>]
 
    [--gigabytes <gigabytes>]
 
    <tenant_id>
 
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os show quota
+
os server resize
     <tenant>
+
     --flavor <flavor>
 +
    [--wait]
 +
    <server>
 
</source>
 
</source>
|| yes
+
|| no
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
cinder quota-show
+
nova resize
     <tenant_id>
+
    [--poll]
 +
    <server>
 +
     <flavor>
 
</source>
 
</source>
|}
 
 
==== snapshot ====
 
 
{| class="wikitable"
 
|-
 
! OSC Command !! Implemented !! !! Cinder command
 
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os create snapshot
+
os server resize
     --name <name>
+
     --confirm
    [--description <description>]
+
     <server>
    [--force]
 
     <volume>
 
 
</source>
 
</source>
|| yes
+
|| no
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
cinder snapshot-create
+
nova resize-confirm
     --force <True|False>
+
     <server>
    --display-name <display-name>
 
    --display-description <display-description>
 
    <volume-id>
 
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os delete snapshot
+
os server resume
     <snapshot>
+
     <server>
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
cinder snapshot-delete
+
nova resume
     <snapshot-id>
+
     <server>
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os list snapshot
+
os server set
 +
    --meta-data <key=value>
 +
    [--meta-data <key=value>] ...
 +
    <server>
 +
os unset server
 +
    --meta-data <key>
 +
    [--meta-data <key>] ...
 +
    <server>
 
</source>
 
</source>
|| yes (no opts yet)
+
|| no
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
cinder snapshot-list
+
nova meta
     --all-tenants [<0|1>]
+
     <server>
     --display-name <display-name>
+
     <action>
     --status <status>
+
     <key=value>
     --volume-id <volume-id>
+
     [<key=value> ...]
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os set snapshot
+
os server set
     [--name <new-name>]
+
     --root-password
    [--description <new-description>]
+
     <server>
     <snapshot>
 
 
</source>
 
</source>
|| yes
+
|| no
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
cinder snapshot-rename
+
nova root-password
     --display-description <display-description>
+
     <server>
    --display-name <display-name>
 
    <snapshot-id>
 
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os show snapshot
+
os server show
     <snapshot>
+
     <server>
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
cinder snapshot-show
+
nova show
     <snapshot-id>
+
     <server>
 
</source>
 
</source>
|}
 
 
==== volume ====
 
 
{| class="wikitable"
 
|-
 
! OSC Command !! Implemented !! !! Cinder command
 
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os create volume
+
os server ssh
    --size <size>
+
     [--port PORT]
     [--description <description>]
+
     --private]
     [--volume-type <volume-type>]
+
     [--ipv6]
     [--snapshot-id <snapshot-id>]
+
     [--login <login>]
     [--source <volid>]
+
     <server>
    [--image <image-id>]
 
    [--availability-zone <availability-zone>]
 
    [--metadata <key=value>]
 
    [--user <user>]          # admin only
 
    [--project <project>]    # admin only
 
     <name>
 
 
</source>
 
</source>
|| yes
+
|| no
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
cinder create
+
nova ssh
     [--snapshot-id <snapshot-id>]
+
     [--port PORT]
    [--source-volid <source-volid>]
+
     [--private]
    [--image-id <image-id>]
+
     [--ipv6]
    [--display-name <display-name>]
+
     [--login <login>]
    [--display-description <display-description>]
+
     <server>
     [--volume-type <volume-type>]
 
     [--availability-zone <availability-zone>]
 
     [--metadata <key=value>]
 
     <size>
 
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os delete volume
+
os server suspend
    [--force]
+
     <server>
     <volume>
 
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
cinder delete
+
nova suspend
     <volume-id>
+
     <server>
 
 
cinder force-delete
 
    <volume-id>
 
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os list volume
+
os server unlock
     [--name <name>]
+
     <server>
    [--status <status>]
 
    [--long]
 
    [--all-tenants]          # admin only
 
 
</source>
 
</source>
|| yes
+
|| no
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
cinder list
+
nova unlock
     --all-tenants [<0|1>]
+
     <server>
    --display-name <display-name>
 
    --status <status>
 
 
</source>
 
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os set volume
+
os server unpause
     [--name <new-name>]
+
     <server>
    [--description <new-description>]
 
    [--metadata <key=value>]
 
    <volume>
 
 
</source>
 
</source>
 
|| yes
 
|| yes
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
cinder metadata
+
nova unpause
     <volume-id>
+
     <server>
    <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 server unrescue
     <volume>
+
     <server>
 
</source>
 
</source>
|| yes
+
|| no
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
cinder show
+
nova unrescue
     <volume-id>
+
     <server>
 
</source>
 
</source>
 +
|}
 +
 +
==== usage ====
 +
 +
{| class="wikitable"
 +
|-
 +
! OSC Command !! Implemented !! !! Keystone command
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os unset volume
+
os usage list
     [--metadata <key=value>]
+
     [--start <start>]
     <volume>
+
     [--end <end>]
 
</source>
 
</source>
|| yes
+
|| no
 
|| ||
 
|| ||
 
<source lang="bash">
 
<source lang="bash">
 +
nova usage-list
 +
    [--start <start>]
 +
    [--end <end>]
 
</source>
 
</source>
 
|}
 
|}
  
==== volume-type ====
+
 
 +
==== volume ====
  
 
{| class="wikitable"
 
{| class="wikitable"
 
|-
 
|-
! OSC Command !! Implemented !! !! Cinder command
+
! OSC Command !! Implemented !! !! Keystone command
 +
|-
 +
|
 +
<source lang="bash">
 +
os volume attach
 +
    <volume>
 +
    <server>
 +
    <device>
 +
</source>
 +
|| no
 +
|| ||
 +
<source lang="bash">
 +
nova volume-attach
 +
    <server>
 +
    <volume>
 +
    <device>
 +
</source>
 
|-
 
|-
 
|
 
|
 
<source lang="bash">
 
<source lang="bash">
os create volume-type
+
os volume detach
 +
    <server>
 +
    <volume>
 +
</source>
 +
|| no
 +
|| ||
 +
<source lang="bash">
 +
nova volume-detach
 +
    <server>
 +
    <volume>
 +
</source>
 +
|}
 +
 
 +
 
 +
==== x509-cert ====
 +
 
 +
See [[#credentials|credentials]] in the [[#Cross_API|cross API section]].
 +
 
 +
==== x509-root-cert ====
 +
 
 +
See [[#credentials|credentials]] in the [[#Cross_API|cross API section]].
 +
 
 +
== Image ==
 +
 
 +
{| class="wikitable"
 +
|-
 +
! OSC Option !!  Environment Variable !!  !!  Glance Option !!  Environment Variable
 +
|-
 +
| --os-image-api-version <ver> || OS_IMAGE_API_VERSION ||  || --os-image-api-version <ver> || OS_IMAGE_API_VERSION
 +
|-
 +
|  ||  || || --os-service-type <type> || OS_SERVICE_TYPE
 +
|-
 +
|  ||  || || --os-endpoint-type <type> || OS_ENDPOINT_TYPE
 +
|-
 +
| --os-token <token> || OS_TOKEN || || --os-auth-token <token> || OS_AUTH_TOKEN
 +
|-
 +
| --os-url <url> || OS_URL || || --os-image-url <url> || OS_IMAGE_URL
 +
|-
 +
|  ||  || || --os-cacert <file> || OS_CACERT
 +
|-
 +
|  ||  || || --cert-file <file> || CERT_FILE
 +
|-
 +
|  ||  || || --key-file <key-file> || KEY_FILE
 +
|-
 +
|  ||  || || --no-ssl-compression ||
 +
|-
 +
|}
 +
 
 +
 
 +
=== API v1 ===
 +
 
 +
==== image ====
 +
 
 +
{| class="wikitable"
 +
|-
 +
! OSC Command !! Implemented !! !! Glance command
 +
|-
 +
|
 +
<source lang="bash">
 +
os image create
 +
    [--id <id>]
 +
    [--store <store>]
 +
    [--container-format <format>]
 +
    [--disk-format <format>]
 +
    [--owner <tenant>]
 +
    [--size <size-bytes>]
 +
    [--min-disk <disk-gb>]
 +
    [--min-ram <ram-mg>]
 +
    [--location <image-url>]
 +
    [--copy-from <image-url>]
 +
    [--file <local-filename>]
 +
    [--checksum <checksum>]
 +
    [--protected | --unprotected]
 +
    [--public | --private]
 +
    [--property <key=value>]
 
     <name>
 
     <name>
</source>
+
</source>
|| yes
+
|| yes
|| ||
+
|| ||
<source lang="bash">
+
<source lang="bash">
cinder type-create
+
glance image-create
     <type-name>
+
    [--id <IMAGE_ID>]
</source>
+
    [--name <NAME>]
|-
+
    [--disk-format <DISK_FORMAT>]
|
+
    [--container-format <CONTAINER_FORMAT>]
<source lang="bash">
+
    [--owner <TENANT_ID>]
os delete volume-type
+
    [--size <SIZE>]
     <volume-type>
+
    [--min-disk <DISK_GB>]
</source>
+
    [--min-ram <DISK_RAM>]
|| yes
+
    [--location <IMAGE_URL>]
|| ||
+
    [--checksum <CHECKSUM>]
<source lang="bash">
+
    [--copy-from <IMAGE_URL>]
cinder type-delete
+
    [--is-public [True|False]]
     <type-id>
+
    [--is-protected [True|False]]
</source>
+
    [--property <key=value>]
|-
+
    [--human-readable]
|
+
</source>
<source lang="bash">
+
|-
os list volume-type
+
|
     [--long]
+
<source lang="bash">
</source>
+
os image delete
|| yes
+
    <image>
|| ||
+
</source>
<source lang="bash">
+
|| yes
cinder type-list  
+
|| ||
 
+
<source lang="bash">
cinder extra-specs-list
+
glance image-delete
</source>
+
    <IMAGE_ID>
|-
+
</source>
|
+
|-
<source lang="bash">
+
|
os set volume-type
+
<source lang="bash">
     [--metadata <key=value>]
+
os image list
 +
    [--page-size <size>]
 +
</source>
 +
|| yes
 +
|| ||
 +
<source lang="bash">
 +
glance image-list
 +
</source>
 +
|-
 +
|
 +
<source lang="bash">
 +
os image save
 +
    [--file <filename>]
 +
    <image>
 +
</source>
 +
|| yes
 +
|| ||
 +
<source lang="bash">
 +
glance image-download
 +
    [--file <FILE>]
 +
    <IMAGE>
 +
</source>
 +
|-
 +
|
 +
<source lang="bash">
 +
os image set
 +
    [--name <name>]
 +
    [--owner <tenant>]
 +
    [--min-disk <disk-gb>]
 +
    [--min-ram <ram-mg>]
 +
    [--protected | --unprotected]
 +
    [--public | --private]
 +
    [--property <key=value>]
 +
    <image>
 +
</source>
 +
|| yes
 +
|| ||
 +
<source lang="bash">
 +
glance image-update
 +
    [--name <NAME>]
 +
    [--disk-format <DISK_FORMAT>]
 +
    [--container-format <CONTAINER_FORMAT>]
 +
    [--owner <TENANT_ID>]
 +
    [--size <SIZE>]
 +
    [--min-disk <DISK_GB>]
 +
    [--min-ram <DISK_RAM>]
 +
    [--location <IMAGE_URL>]
 +
    [--file <FILE>]
 +
    [--checksum <CHECKSUM>]
 +
    [--copy-from <IMAGE_URL>]
 +
    [--is-public [True|False]]
 +
    [--is-protected [True|False]]
 +
    [--property <key=value>]
 +
    [--purge-props]
 +
    [--human-readable]
 +
    <IMAGE>
 +
</source>
 +
|-
 +
|
 +
<source lang="bash">
 +
os image show
 +
    <image>
 +
</source>
 +
|| yes
 +
|| ||
 +
<source lang="bash">
 +
glance image-show
 +
    [--human-readable]
 +
    <IMAGE>
 +
</source>
 +
|}
 +
 
 +
=== API v2 ===
 +
 
 +
==== image ====
 +
 
 +
{| class="wikitable"
 +
|-
 +
! OSC Command !! Implemented !! !! Glance command
 +
|-
 +
|
 +
<source lang="bash">
 +
os image delete
 +
    <image>
 +
</source>
 +
|| yes
 +
|| ||
 +
<source lang="bash">
 +
glance image-delete
 +
    <IMAGE_ID>
 +
</source>
 +
|-
 +
|
 +
<source lang="bash">
 +
os image list
 +
    [--page-size <size>]
 +
</source>
 +
|| yes
 +
|| ||
 +
<source lang="bash">
 +
glance image-list
 +
</source>
 +
|-
 +
|
 +
<source lang="bash">
 +
</source>
 +
|| no
 +
|| ||
 +
<source lang="bash">
 +
glance member-images
 +
    [options]
 +
    <MEMBER>
 +
</source>
 +
|-
 +
|
 +
<source lang="bash">
 +
os image save
 +
    [--file <filename>]
 +
    <image>
 +
</source>
 +
|| yes
 +
|| ||
 +
<source lang="bash">
 +
glance image-download
 +
    [--file <FILE>]
 +
    <IMAGE>
 +
</source>
 +
|-
 +
|
 +
<source lang="bash">
 +
os image set
 +
    [--id <id>]
 +
    [--store <store>]
 +
    [--container-format <format>]
 +
    [--disk-format <format>]
 +
    [--owner <tenant>]
 +
    [--size <size-bytes>]
 +
    [--min-disk <disk-gb>]
 +
    [--min-ram <ram-mg>]
 +
    [--location <image-url>]
 +
    [--copy-from <image-url>]
 +
    [--file <local-filename>]
 +
    [--checksum <checksum>]
 +
    [--protected | --unprotected]
 +
    [--public | --private]
 +
    [--property <key=value>]
 +
    <name>
 +
</source>
 +
|| no
 +
|| ||
 +
<source lang="bash">
 +
glance image-update
 +
    [--name <NAME>]
 +
    [--disk-format <DISK_FORMAT>]
 +
    [--container-format <CONTAINER_FORMAT>]
 +
    [--owner <TENANT_ID>]
 +
    [--size <SIZE>]
 +
    [--min-disk <DISK_GB>]
 +
    [--min-ram <DISK_RAM>]
 +
    [--location <IMAGE_URL>]
 +
    [--file <FILE>]
 +
    [--checksum <CHECKSUM>]
 +
    [--copy-from <IMAGE_URL>]
 +
    [--is-public [True|False]]
 +
    [--is-protected [True|False]]
 +
    [--property <key=value>]
 +
    [--purge-props]
 +
    [--human-readable]
 +
    <IMAGE>
 +
</source>
 +
|-
 +
|
 +
<source lang="bash">
 +
os image show
 +
    <image>
 +
</source>
 +
|| yes
 +
|| ||
 +
<source lang="bash">
 +
glance image-show
 +
    [--human-readable]
 +
    <IMAGE>
 +
</source>
 +
|}
 +
 
 +
 
 +
==== image-member ====
 +
 
 +
Need to discuss the future of these commands with markwash...
 +
 
 +
<source lang="bash">
 +
glance member-create [--can-share] <IMAGE_ID> <TENANT_ID>
 +
 
 +
os create image-member ...
 +
</source>
 +
 
 +
 
 +
<source lang="bash">
 +
glance member-delete <IMAGE_ID> <TENANT_ID>
 +
 
 +
os list image-member <image> [options]
 +
</source>
 +
 
 +
 
 +
<source lang="bash">
 +
glance member-delete [options] <ID> <MEMBER>
 +
 
 +
os delete image-member ...
 +
</source>
 +
 
 +
 
 +
<source lang="bash">
 +
glance member-list [--image-id <IMAGE_ID>] [--tenant-id <TENANT_ID>]
 +
 
 +
os list image-member ...
 +
</source>
 +
 
 +
== Volume ==
 +
 
 +
{| class="wikitable"
 +
|-
 +
! Cinder Option !!  Environment Variable !!  !!  OSC Option !!  Environment Variable
 +
|-
 +
| --os-volume-api-version <ver> || OS_VOLUME_API_VERSION ||  || --os-volume-api-version <ver> || OS_VOLUME_API_VERSION
 +
|-
 +
| --service-type <type> ||  ||  ||  ||
 +
|-
 +
| --service-name <name> || CINDER_SERVICE_NAME ||  ||  ||
 +
|-
 +
| --volume-service-name <name> || CINDER_VOLUME_SERVICE_NAME ||  ||  ||
 +
|-
 +
| --endpoint-type <type> || CINDER_ENDPOINT_TYPE ||  ||  ||
 +
|-
 +
| --retries <int> ||  ||  ||  ||
 +
|-
 +
|}
 +
 
 +
 
 +
=== API v1.0 ===
 +
 
 +
==== limits ====
 +
 
 +
See [[#limits|limits]] in the [[#Cross_API|cross API section]].
 +
 
 +
==== quota ====
 +
 
 +
See [[#quota|quota]] in the [[#Cross_API|cross API section]].
 +
 
 +
==== snapshot ====
 +
 
 +
{| class="wikitable"
 +
|-
 +
! OSC Command !! Implemented !! !! Cinder command
 +
|-
 +
|
 +
<source lang="bash">
 +
os snapshot create
 +
    --name <name>
 +
    [--description <description>]
 +
    [--force]
 +
    <volume>
 +
</source>
 +
|| yes
 +
|| ||
 +
<source lang="bash">
 +
cinder snapshot-create
 +
    --force <True|False>
 +
    --display-name <display-name>
 +
    --display-description <display-description>
 +
    <volume-id>
 +
</source>
 +
|-
 +
|
 +
<source lang="bash">
 +
os snapshot delete
 +
    <snapshot>
 +
</source>
 +
|| yes
 +
|| ||
 +
<source lang="bash">
 +
cinder snapshot-delete
 +
    <snapshot-id>
 +
</source>
 +
|-
 +
|
 +
<source lang="bash">
 +
os snapshot list
 +
</source>
 +
|| yes (no opts yet)
 +
|| ||
 +
<source lang="bash">
 +
cinder snapshot-list
 +
    --all-tenants [<0|1>]
 +
    --display-name <display-name>
 +
    --status <status>
 +
    --volume-id <volume-id>
 +
</source>
 +
|-
 +
|
 +
<source lang="bash">
 +
os snapshot set
 +
    [--name <new-name>]
 +
    [--description <new-description>]
 +
    <snapshot>
 +
</source>
 +
|| yes
 +
|| ||
 +
<source lang="bash">
 +
cinder snapshot-rename
 +
    --display-description <display-description>
 +
    --display-name <display-name>
 +
    <snapshot-id>
 +
</source>
 +
|-
 +
|
 +
<source lang="bash">
 +
os snapshot show
 +
    <snapshot>
 +
</source>
 +
|| yes
 +
|| ||
 +
<source lang="bash">
 +
cinder snapshot-show
 +
    <snapshot-id>
 +
</source>
 +
|}
 +
 
 +
==== volume ====
 +
 
 +
{| class="wikitable"
 +
|-
 +
! OSC Command !! Implemented !! !! Cinder command
 +
|-
 +
|
 +
<source lang="bash">
 +
os volume create
 +
    --size <size>
 +
    [--description <description>]
 +
    [--volume-type <volume-type>]
 +
    [--snapshot-id <snapshot-id>]
 +
    [--source <volid>]
 +
    [--image <image-id>]
 +
    [--availability-zone <availability-zone>]
 +
    [--property <key=value>]
 +
    [--user <user>]          # admin only
 +
    [--project <project>]    # admin only
 +
    <name>
 +
</source>
 +
|| yes
 +
|| ||
 +
<source lang="bash">
 +
cinder create
 +
     [--snapshot-id <snapshot-id>]
 +
    [--source-volid <source-volid>]
 +
    [--image-id <image-id>]
 +
    [--display-name <display-name>]
 +
    [--display-description <display-description>]
 +
    [--volume-type <volume-type>]
 +
    [--availability-zone <availability-zone>]
 +
    [--metadata <key=value>]
 +
    <size>
 +
</source>
 +
|-
 +
|
 +
<source lang="bash">
 +
os volume delete
 +
    [--force]
 +
    <volume>
 +
</source>
 +
|| yes
 +
|| ||
 +
<source lang="bash">
 +
cinder delete
 +
    <volume-id>
 +
 
 +
cinder force-delete
 +
    <volume-id>
 +
</source>
 +
|-
 +
|
 +
<source lang="bash">
 +
os volume list
 +
    [--name <name>]
 +
    [--status <status>]
 +
    [--long]
 +
    [--all-tenants]          # admin only
 +
</source>
 +
|| yes
 +
|| ||
 +
<source lang="bash">
 +
cinder list
 +
    --all-tenants [<0|1>]
 +
    --display-name <display-name>
 +
    --status <status>
 +
</source>
 +
|-
 +
|
 +
<source lang="bash">
 +
os volume set
 +
    [--name <new-name>]
 +
    [--description <new-description>]
 +
    [--property <key=value>]
 +
    <volume>
 +
</source>
 +
|| yes
 +
|| ||
 +
<source lang="bash">
 +
cinder metadata
 +
    <volume-id>
 +
    <action>
 +
    <key=value>
 +
 
 +
cinder rename
 +
    --display-description <display-description>
 +
    <volume-id>
 +
    <display-name>
 +
</source>
 +
|-
 +
|
 +
<source lang="bash">
 +
os volume show
 +
    <volume>
 +
</source>
 +
|| yes
 +
|| ||
 +
<source lang="bash">
 +
cinder show
 +
    <volume-id>
 +
</source>
 +
|-
 +
|
 +
<source lang="bash">
 +
os volume unset
 +
    [--property <key=value>]
 +
    <volume>
 +
</source>
 +
|| yes
 +
|| ||
 +
<source lang="bash">
 +
</source>
 +
|}
 +
 
 +
==== volume-type ====
 +
 
 +
{| class="wikitable"
 +
|-
 +
! OSC Command !! Implemented !! !! Cinder command
 +
|-
 +
|
 +
<source lang="bash">
 +
os volume type create
 +
    [--property <key=value>]
 +
    <name>
 +
</source>
 +
|| yes
 +
|| ||
 +
<source lang="bash">
 +
cinder type-create
 +
    <type-name>
 +
</source>
 +
|-
 +
|
 +
<source lang="bash">
 +
os volume type delete
 +
     <volume-type>
 +
</source>
 +
|| yes
 +
|| ||
 +
<source lang="bash">
 +
cinder type-delete
 +
     <type-id>
 +
</source>
 +
|-
 +
|
 +
<source lang="bash">
 +
os volume type list
 +
     [--long]
 +
</source>
 +
|| yes
 +
|| ||
 +
<source lang="bash">
 +
cinder type-list  
 +
 
 +
cinder extra-specs-list
 +
</source>
 +
|-
 +
|
 +
<source lang="bash">
 +
os volume type set
 +
     [--property <key=value>]
 
     <volume-type>
 
     <volume-type>
 
</source>
 
</source>
Line 2,946: 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 2,962: 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,116: Line 3,863:
 
set port <tenant> <network> <port> <params>
 
set port <tenant> <network> <port> <params>
 
</source>
 
</source>
 
  
 
= Options =
 
= Options =

Latest revision as of 02:10, 19 July 2013

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

OpenStackClient Commands

Part of the UnifiedCLI proposal

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

Command Structure

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

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

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


Command Arguments

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

Other

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

Verbs

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

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


Objects

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


Global Options

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

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


Common Options

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

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


Command Mapping Summary

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

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


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


Cross API

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

credentials

[consider rolling the ec2 creds into this too]

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

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

limits

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

nova rate-limits

cinder absolute-limits

cinder rate-limits

quota

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

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

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

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

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

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

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

cinder quota-show
    <tenant_id>

nova quota-defaults
    <tenant_id>

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

cinder quota-class-show
    <class>

Identity

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

API v2.0

catalog

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

ec2 credentials

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

endpoint

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

role

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

service

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

tenant

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

token

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

user

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

user role

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

<other>

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

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

API v3

credential

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

domain

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

endpoint

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

group

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

oauth

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

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

policy

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

project

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

role

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

service

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

user

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

Compute

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


API v2 (1.1)

agent

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


aggregate

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

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

bash-completion

OSC Command Implemented Nova command

TBD

no
nova bash-completion

cloudpipe

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

console

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

credentials

See credentials in the cross API section.

diagnostics

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

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

dns

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

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

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

endpoints

Totally duplicates Identity catalog command

OSC Command Implemented Nova command
os endpoint list
no
nova endpoints

fixed-ip

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


flavor

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


floating-ip

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


floating-ip-pool

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


host

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


hypervisor

OSC Command Implemented Nova command
os hypervisor list
    [--matching &