Jump to: navigation, search

Difference between revisions of "OpenStackClient/Commands"

(Load Balancer)
(Replaced content with "''[Note: The former content of this page was removed on 23Mar2016 as it was over 15 months out of date. The current information that was formerly on this page can be foun...")
 
(105 intermediate revisions by 7 users not shown)
Line 1: Line 1:
__TOC__
+
''[Note: The former content of this page was removed on 23Mar2016 as it was over 15 months out of dateThe current information that was formerly on this page can be found at  [http://docs.openstack.org/developer/python-openstackclient/command-list.html OpenStack Documentation]'']
 
 
= Command Structure =
 
 
 
The detailed command structure is described in [[OpenStackClient/HumanInterfaceGuidelines#Command_Structure]].
 
 
 
== Command Arguments ==
 
 
 
* 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).
 
 
 
 
 
== 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>container</code> - [[#Object|Object]] - [[#container|container]]
 
* <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>object</code> - [[#Object|Object]] - [[#object|object]]
 
* <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]]
 
 
 
== Actions ==
 
 
 
The actions used by OpenStackClient are defined below to provide a consistent meaning to each action.  Many of them have logical opposite actions.  Those actions with an opposite action are noted in parens if applicable.
 
 
 
* <code>authorize</code> - authorize a token (used in OAuth)
 
* <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>) - deprecated; use <code>add</code>/<code>remove</code>
 
* <code>create</code> (<code>delete</code>) - create a new occurrance of the specified object
 
* <code>delete</code> (<code>create</code>) - delete a specific occurrance of the specified object
 
* <code>detach</code> (<code>attach</code>) - deprecated; use <code>add</code>/<code>remove</code>
 
* <code>list</code> - display summary information about multiple objects
 
* <code>lock</code> (<code>unlock</code>)
 
* <code>migrate</code> - move a server to a different host; <code><nowiki>--live</nowiki></code> performs a live migration if possible
 
* <code>pause</code> (<code>unpause</code>) - stop a server and leave it in memory
 
* <code>reboot</code> - forcibly reboot a server
 
* <code>rebuild</code> - rebuild a server using (most of) the same arguments as in the original <code><nowiki>create</nowiki></code>
 
* <code>remove</code> (<code>add</code>) - remove an object from a group of objects
 
* <code>rescue</code> (<code>unrescue</code>) - reboot a server in a special rescue mode allowing access to the original disks
 
* <code>resize</code> - change a server's flavor
 
* <code>resume</code> (<code>suspend</code>) - return a suspended server to running state
 
* <code>save</code> - download an object locally
 
* <code>set</code> (<code>unset</code>) - set a property on the object, formerly called <code>metadata</code>
 
* <code>show</code> - display detailed information about the specific object
 
* <code>ssh</code>
 
* <code>suspend</code> (<code>resume</code>) - stop a server and save to disk freeing memory
 
* <code>unlock</code> (<code>lock</code>)
 
* <code>unpause</code> (<code>pause</code>) - return a paused server to running state
 
* <code>unrescue</code> (<code>rescue</code>) - return a server to normal boot mode
 
* <code>unset</code> (<code>set</code>) - remove an attribute of the object
 
 
 
== Global Options ==
 
 
 
The common global options from the default [[OpenStack]] clients have been mapped to the set of global options below.
 
 
 
{| class="wikitable"
 
|-
 
! 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.
 
 
 
{| class="wikitable"
 
|-
 
! 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 <code><nowiki><verb> <object></nowiki></code> 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:
 
 
 
 
 
{| class="wikitable"
 
|-
 
| 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]''
 
 
 
{| class="wikitable"
 
|-
 
! OSC Command !! Implemented !! !! Keystone command
 
|-
 
|
 
<source lang="bash">
 
os credentials create
 
    --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>
 
|| no
 
|| ||
 
<source lang="bash">
 
nova credentials
 
    [--wrap <integer>]
 
 
 
nova x509-get-root-cert
 
    [<filename>]
 
</source>
 
|}
 
 
 
==== limits ====
 
 
 
{| class="wikitable"
 
|-
 
! OSC Command !! Implemented !! !! Keystone command
 
|-
 
|
 
<source lang="bash">
 
os limits show
 
    --absolute [--reserved] | --rate
 
</source>
 
|| yes
 
|| ||
 
<source lang="bash">
 
nova absolute-limits
 
    [--reserved]
 
 
 
nova rate-limits
 
 
 
cinder absolute-limits
 
 
 
cinder rate-limits
 
</source>
 
|}
 
 
 
==== quota ====
 
 
 
{| class="wikitable"
 
|-
 
! OSC Command !! Implemented !! !! Keystone command
 
|-
 
|
 
<source lang="bash">
 
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>
 
</source>
 
|| yes
 
|| ||
 
<source lang="bash">
 
nova quota-update
 
    [--instances <instances>]
 
    [--cores <cores>]
 
    [--ram <ram>]
 
    [--volumes <volumes>]
 
    [--gigabytes <gigabytes>]
 
    [--floating-ips <floating_ips>]
 
    [--metadata-items <metadata_items>]
 
    [--injected-files <injected_files>]
 
    [--injected-file-content-bytes <injected_file_content_bytes>]
 
    <tenant_id>
 
 
 
cinder quota-update
 
    [--volumes <volumes>]
 
    [--snapshots <snapshots>]
 
    [--gigabytes <gigabytes>]
 
    <tenant_id>
 
</source>
 
|-
 
|
 
<source lang="bash">
 
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>
 
</source>
 
|| yes
 
|| ||
 
<source lang="bash">
 
nova quota-class-update
 
    [--instances <instances>]
 
    [--cores <cores>]
 
    [--ram <ram>]
 
    [--volumes <volumes>]
 
    [--gigabytes <gigabytes>]
 
    [--floating-ips <floating_ips>]
 
    [--metadata-items <metadata_items>]
 
    [--injected-files <injected_files>]
 
    [--injected-file-content-bytes <injected_file_content_bytes>]
 
    <class>
 
 
 
cinder quota-class-update
 
    [--volumes <volumes>]
 
    [--snapshots <snapshots>]
 
    [--gigabytes <gigabytes>]
 
    <tenant_id>
 
</source>
 
|-
 
|
 
<source lang="bash">
 
os quota show
 
    [--default]
 
    <project>
 
</source>
 
|| yes
 
|| ||
 
<source lang="bash">
 
nova quota-show
 
    [--tenant <tenant-id>]
 
 
 
cinder quota-show
 
    <tenant_id>
 
 
 
nova quota-defaults
 
    <tenant_id>
 
 
 
cinder quota-defaults
 
    <tenant_id>
 
</source>
 
|-
 
|
 
<source lang="bash">
 
os quota show
 
    --class
 
    <class>
 
</source>
 
|| yes
 
|| ||
 
<source lang="bash">
 
nova quota-class-show
 
    <class>
 
 
 
cinder quota-class-show
 
    <class>
 
</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">
 
os agent create
 
    <os>
 
    <architecture>
 
    <version>
 
    <url>
 
    <md5hash>
 
    <hypervisor>
 
</source>
 
|| yes
 
|| ||
 
|-
 
|
 
<source lang="bash">
 
os agent delete
 
    <id>
 
</source>
 
|| yes
 
|| ||
 
|-
 
|
 
<source lang="bash">
 
os agent list
 
    [--hypervisor <hypervisor>]
 
</source>
 
|| yes
 
|| ||
 
|-
 
|
 
<source lang="bash">
 
os agent set
 
    <id>
 
    <version>
 
    <url>
 
    <md5hash>
 
</source>
 
|| yes
 
|| ||
 
|}
 
 
 
 
 
==== aggregate ====
 
 
 
{| class="wikitable"
 
|-
 
! OSC Command !! Implemented !! !! Nova command
 
|-
 
|
 
<source lang="bash">
 
os aggregate add host
 
    <aggregate>
 
    <host>
 
</source>
 
|| yes
 
|| ||
 
<source lang="bash">
 
nova aggregate-add-host
 
    <id>
 
    <host>
 
</source>
 
|-
 
|
 
<source lang="bash">
 
os aggregate create
 
    [--zone <availability-zone>]
 
    [--property <key=value>]
 
    <name>
 
</source>
 
|| yes
 
|| ||
 
<source lang="bash">
 
nova aggregate-create
 
    <name>
 
    [<availability_zone>]
 
</source>
 
|-
 
|
 
<source lang="bash">
 
os aggregate delete
 
    <aggregate>
 
</source>
 
|| yes
 
|| ||
 
<source lang="bash">
 
nova aggregate-delete
 
    <id>
 
</source>
 
|-
 
|
 
<source lang="bash">
 
os aggregate list
 
    [--long]
 
</source>
 
|| yes
 
|| ||
 
<source lang="bash">
 
nova aggregate-list
 
</source>
 
|-
 
|
 
<source lang="bash">
 
os aggregate remove host
 
    <aggregate>
 
    <host>
 
</source>
 
|| yes
 
|| ||
 
<source lang="bash">
 
nova aggregate-remove-host
 
    <id>
 
    <host>
 
</source>
 
|-
 
|
 
<source lang="bash">
 
os aggregate set
 
    [--name <new-name>]
 
    [--zone <availability-zone>]
 
    [--property <key=value>]
 
    <aggregate>
 
</source>
 
|| yes
 
|| ||
 
<source lang="bash">
 
nova aggregate-update
 
    <id>
 
    <name>
 
    [<availability_zone>]
 
 
 
nova aggregate-set-metadata
 
    <id>
 
    <key=value>
 
    [<key=value> ...]
 
</source>
 
|-
 
|
 
<source lang="bash">
 
os aggregate show
 
    <aggregate>
 
</source>
 
|| yes
 
|| ||
 
<source lang="bash">
 
nova aggregate-details
 
    <id>
 
</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">
 
os create cloudpipe
 
    <project>
 
</source>
 
|| no
 
|| ||
 
<source lang="bash">
 
nova cloudpipe-create
 
    <project>
 
</source>
 
|-
 
|
 
<source lang="bash">
 
os list cloudpipe
 
</source>
 
|| no
 
|| ||
 
<source lang="bash">
 
nova cloudpipe-list
 
</source>
 
|}
 
 
 
==== console ====
 
 
 
{| class="wikitable"
 
|-
 
! OSC Command !! Implemented !! !! Nova command
 
|-
 
|
 
<source lang="bash">
 
os console log show
 
    [--lines <num-lines>]
 
    <server>
 
</source>
 
|| yes
 
|| ||
 
<source lang="bash">
 
nova console-log
 
    [--length <length>]
 
    <server>
 
</source>
 
|-
 
|
 
<source lang="bash">
 
os console url show
 
    [--novnc | --xvpvnc | --spice]
 
    <server>
 
</source>
 
|| yes
 
|| ||
 
<source lang="bash">
 
nova get-vnc-console
 
    <server>
 
    <console_type>
 
</source>
 
|}
 
 
 
==== credentials ====
 
 
 
See [[#credentials|credentials]] in the [[#Cross_API|cross API section]].
 
 
 
==== diagnostics ====
 
 
 
{| class="wikitable"
 
|-
 
! OSC Command !! Implemented !! !! Nova command
 
|-
 
|
 
<source lang="bash">
 
os server show
 
    --diagnostics
 
    <server>
 
</source>
 
|| yes
 
|| ||
 
<source lang="bash">
 
nova diagnostics
 
    <server>
 
</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">
 
os create dns
 
    [--type <type>]
 
    <ip>
 
    <name>
 
    <domain>
 
</source>
 
|| no
 
|| ||
 
<source lang="bash">
 
nova dns-create
 
    [--type <type>]
 
    <ip>
 
    <name>
 
    <domain>
 
</source>
 
|-
 
|
 
<source lang="bash">
 
os delete dns
 
    <domain>
 
    <name>
 
</source>
 
|| no
 
|| ||
 
<source lang="bash">
 
nova dns-delete
 
    <domain>
 
    <name>
 
</source>
 
|-
 
|
 
<source lang="bash">
 
os list dns
 
    [--ip <ip>]
 
    [--name <name>]
 
    <domain>
 
</source>
 
|| no
 
|| ||
 
<source lang="bash">
 
nova dns-list
 
    [--ip <ip>]
 
    [--name <name>]
 
    <domain>
 
</source>
 
|-
 
|
 
<source lang="bash">
 
os create dns-domain
 
    [--project <project>]
 
    [--availability-zone <availability-zone>]
 
    [--public | --private]
 
    <domain>
 
</source>
 
|| no
 
|| ||
 
<source lang="bash">
 
nova dns-create-private-domain
 
    [--availability_zone <availability_zone>]
 
    <domain>
 
 
 
nova dns-create-public-domain
 
    [--project <project>]
 
    <domain>
 
</source>
 
|-
 
|
 
<source lang="bash">
 
os delete dns-domain
 
    <domain>
 
</source>
 
|| no
 
|| ||
 
<source lang="bash">
 
nova dns-delete-domain
 
    <domain>
 
</source>
 
|-
 
|
 
<source lang="bash">
 
os list dns-domains
 
</source>
 
|| no
 
|| ||
 
<source lang="bash">
 
nova dns-domains
 
</source>
 
|}
 
 
 
==== endpoints ====
 
 
 
''Totally duplicates Identity catalog command''
 
{| class="wikitable"
 
|-
 
! OSC Command !! Implemented !! !! Nova command
 
|-
 
|
 
<source lang="bash">
 
os endpoint list
 
</source>
 
|| no
 
|| ||
 
<source lang="bash">
 
nova endpoints
 
</source>
 
|}
 
 
 
==== fixed-ip ====
 
 
 
{| class="wikitable"
 
|-
 
! OSC Command !! Implemented !! !! Nova command
 
|-
 
|
 
<source lang="bash">
 
os ip fixed add
 
    <network>
 
    <server>
 
</source>
 
|| yes
 
|| ||
 
<source lang="bash">
 
nova add-fixed-ip
 
    <server>
 
    <network_id>
 
</source>
 
|-
 
|
 
<source lang="bash">
 
os ip fixed remove
 
    <ip-address>
 
    <server>
 
</source>
 
|| yes
 
|| ||
 
<source lang="bash">
 
nova remove-fixed-ip
 
    <server>
 
    <address>
 
</source>
 
|}
 
 
 
 
 
==== flavor ====
 
 
 
{| class="wikitable"
 
|-
 
! OSC Command !! Implemented !! !! Nova command
 
|-
 
|
 
<source lang="bash">
 
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>
 
</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">
 
nova flavor-create
 
    [--ephemeral <ephemeral>]
 
    [--swap <swap>]
 
    [--rxtx-factor <factor>]
 
    <name>
 
    <id>
 
    <ram>
 
    <disk>
 
    <vcpus>
 
</source>
 
|-
 
|
 
<source lang="bash">
 
os flavor delete
 
    <flavor>
 
</source>
 
|| yes
 
|| ||
 
<source lang="bash">
 
nova flavor-delete
 
    <id>
 
</source>
 
|-
 
|
 
<source lang="bash">
 
os flavor list
 
</source>
 
|| yes
 
|| ||
 
<source lang="bash">
 
nova flavor-list
 
</source>
 
|-
 
|
 
<source lang="bash">
 
os flavor show
 
    <flavor>
 
</source>
 
|| yes
 
|| ||
 
|}
 
 
 
 
 
==== floating-ip ====
 
 
 
{| class="wikitable"
 
|-
 
! OSC Command !! Implemented !! !! Nova command
 
|-
 
|
 
<source lang="bash">
 
os ip floating add
 
    <ip-address>
 
    <server>
 
</source>
 
|| yes
 
|| ||
 
<source lang="bash">
 
nova add-floating-ip
 
    <server>
 
    <address>
 
</source>
 
|-
 
|
 
<source lang="bash">
 
os ip floating create
 
    [<pool>]
 
</source>
 
|| yes
 
|| ||
 
<source lang="bash">
 
nova floating-ip-create
 
    [<floating_ip_pool>]
 
</source>
 
|-
 
|
 
<source lang="bash">
 
os ip floating delete
 
    <ip-address>
 
</source>
 
|| yes
 
|| ||
 
<source lang="bash">
 
nova floating-ip-delete
 
    <address>
 
</source>
 
|-
 
|
 
<source lang="bash">
 
os ip floating list
 
</source>
 
|| yes
 
|| ||
 
<source lang="bash">
 
nova floating-ip-list
 
</source>
 
|-
 
|
 
<source lang="bash">
 
os ip floating remove
 
    <ip-address>
 
    <server>
 
</source>
 
|| yes
 
|| ||
 
<source lang="bash">
 
nova remove-floating-ip
 
    <server>
 
    <address>
 
</source>
 
|}
 
 
 
 
 
==== floating-ip-pool ====
 
 
 
 
 
{| class="wikitable"
 
|-
 
! OSC Command !! Implemented !! !! Nova command
 
|-
 
|
 
<source lang="bash">
 
os ip floating pool list
 
</source>
 
|| yes
 
|| ||
 
<source lang="bash">
 
nova floating-ip-pool-list
 
</source>
 
|}
 
 
 
 
 
==== host ====
 
 
 
{| class="wikitable"
 
|-
 
! OSC Command !! Implemented !! !! Nova command
 
|-
 
|
 
<source lang="bash">
 
os host list
 
    [--zone <availability-zone>]
 
</source>
 
|| yes
 
|| ||
 
<source lang="bash">
 
nova host-action
 
    [--action <action>]
 
    <hostname>
 
</source>
 
|-
 
|
 
<source lang="bash">
 
os host set
 
    ...
 
</source>
 
|| no
 
|| ||
 
<source lang="bash">
 
nova host-update
 
    [--status <status>]
 
    [--maintenance <maintenance_mode>]
 
    <hostname>
 
</source>
 
|-
 
|
 
<source lang="bash">
 
os host show
 
    <host>
 
</source>
 
|| yes
 
|| ||
 
|}
 
 
 
 
 
==== hypervisor ====
 
 
 
{| class="wikitable"
 
|-
 
! OSC Command !! Implemented !! !! Nova command
 
|-
 
|
 
<source lang="bash">
 
os hypervisor list
 
    [--matching <hostname>]
 
</source>
 
|| yes
 
|| ||
 
|-
 
|
 
<source lang="bash">
 
os hypervisor show
 
    <id>
 
</source>
 
|| yes
 
|| ||
 
|}
 
 
 
 
 
==== keypair ====
 
 
 
{| class="wikitable"
 
|-
 
! OSC Command !! Implemented !! !! Nova command
 
|-
 
|
 
<source lang="bash">
 
os keypair create
 
    [--public-key <file>]
 
    <name>
 
</source>
 
|| yes
 
|| ||
 
<source lang="bash">
 
nova keypair-add
 
    [--pub_key <pub_key>]
 
    <name>
 
</source>
 
|-
 
|
 
<source lang="bash">
 
os keypair delete
 
    <name>
 
</source>
 
|| yes
 
|| ||
 
<source lang="bash">
 
nova keypair-delete
 
    <name>
 
</source>
 
|-
 
|
 
<source lang="bash">
 
os keypair list
 
</source>
 
|| yes
 
|| ||
 
<source lang="bash">
 
nova keypair-list
 
</source>
 
|-
 
|
 
<source lang="bash">
 
os keypair show
 
    [--public-key]
 
    <name>
 
</source>
 
|| yes
 
|| ||
 
|}
 
 
 
 
 
==== limits ====
 
 
 
See [[#limits|limits]] in the [[#Cross_API|cross API section]].
 
 
 
 
 
==== quota ====
 
 
 
See [[#quota|quota]] in the [[#Cross_API|cross API section]].
 
 
 
 
 
==== secgroup ====
 
 
 
{| class="wikitable"
 
|-
 
! OSC Command !! Implemented !! !! Nova command
 
|-
 
|
 
<source lang="bash">
 
os secgroup add
 
 
 
(see server add secgroup)
 
</source>
 
|| no
 
|| ||
 
<source lang="bash">
 
nova add-secgroup
 
    <server>
 
    <secgroup>
 
</source>
 
|-
 
|
 
<source lang="bash">
 
os secgroup create
 
    [--description <description>]
 
    <name>
 
</source>
 
|| yes
 
|| ||
 
<source lang="bash">
 
nova secgroup-create
 
    <name>
 
    <description>
 
</source>
 
|-
 
|
 
<source lang="bash">
 
os secgroup delete
 
    <group>
 
</source>
 
|| yes
 
|| ||
 
<source lang="bash">
 
nova secgroup-delete
 
    <secgroup>
 
</source>
 
|-
 
|
 
<source lang="bash">
 
os secgroup list
 
    [--all-projects]
 
</source>
 
|| yes
 
|| ||
 
<source lang="bash">
 
nova secgroup-list
 
    [--all-tenants [<0|1>]]
 
</source>
 
|-
 
|
 
<source lang="bash">
 
os secgroup remove
 
 
 
(see server remove secgroup)
 
</source>
 
|| no
 
|| ||
 
<source lang="bash">
 
nova remove-secgroup
 
    <server>
 
    <secgroup>
 
</source>
 
|-
 
|
 
<source lang="bash">
 
os secgroup set
 
    [--name <new-name>]
 
    [--description [<new-description>]
 
    <group>
 
</source>
 
|| yes
 
|| ||
 
<source lang="bash">
 
nova secgroup-update
 
    <secgroup>
 
    <name>
 
    <description>
 
</source>
 
|-
 
|
 
<source lang="bash">
 
os secgroup show
 
    <group>
 
</source>
 
|| yes
 
|| ||
 
<source lang="bash">
 
n/a
 
</source>
 
|}
 
 
 
==== secgroup-group-rule ====
 
 
 
{| class="wikitable"
 
|-
 
! OSC Command !! Implemented !! !! Nova command
 
|-
 
|
 
<source lang="bash">
 
os secgroup group rule create
 
    [--proto <protocol>]
 
    [--port <port>:<port>]
 
    <source-group>
 
    <secgroup>
 
</source>
 
|| no
 
|| ||
 
<source lang="bash">
 
nova secgroup-add-group-rule
 
    [--ip_proto <ip_proto>]
 
    [--from_port <from_port>]
 
    [--to_port <to_port>]
 
    <secgroup>
 
    <source_group>
 
</source>
 
|-
 
|
 
<source lang="bash">
 
os secgroup group rule delete
 
    [--proto <protocol>]
 
    [--port <port>:<port>]
 
    <source-group>
 
    <secgroup>
 
</source>
 
|| no
 
|| ||
 
<source lang="bash">
 
nova secgroup-delete-group-rule
 
    [--ip_proto <ip_proto>]
 
    [--from_port <from_port>]
 
    [--to_port <to_port>]
 
    <secgroup>
 
    <source_group>
 
</source>
 
|}
 
 
 
==== secgroup-rule ====
 
 
 
{| class="wikitable"
 
|-
 
! OSC Command !! Implemented !! !! Nova command
 
|-
 
|
 
<source lang="bash">
 
os secgroup rule create
 
    [--proto <proto>]
 
    [--src-ip <ip-address>]
 
    [--dst-port <port-range>]
 
    <group>
 
</source>
 
|| no
 
|| ||
 
<source lang="bash">
 
nova secgroup-add-rule
 
    <secgroup>
 
    <ip_proto>
 
    <from_port>
 
    <to_port>
 
    <cidr>
 
</source>
 
|-
 
|
 
<source lang="bash">
 
os secgroup rule delete
 
    [--proto <proto>]
 
    [--src-ip <ip-address>]
 
    [--dst-port <port-range>]
 
    <group>
 
</source>
 
|| no
 
|| ||
 
<source lang="bash">
 
nova secgroup-delete-rule
 
    <secgroup>
 
    <ip_proto>
 
    <from_port>
 
    <to_port>
 
    <cidr>
 
</source>
 
|-
 
|
 
<source lang="bash">
 
os secgroup rule list
 
    <group>
 
</source>
 
|| no
 
|| ||
 
<source lang="bash">
 
nova secgroup-list-rules
 
    <secgroup>
 
</source>
 
|}
 
 
 
====server====
 
 
 
{| class="wikitable"
 
|-
 
! OSC Command !! Implemented !! !! Nova command
 
|-
 
|
 
<source lang="bash">
 
os server add secgroup
 
    <server>
 
    <group>
 
</source>
 
|| yes
 
|| ||
 
<source lang="bash">
 
nova add-secgroup
 
    <server>
 
    <secgroup>
 
</source>
 
|-
 
|
 
<source lang="bash">
 
os server add volume
 
    [--device <device>]
 
    <server>
 
    <volume>
 
</source>
 
|| yes
 
|| ||
 
<source lang="bash">
 
nova volume-attach
 
    <server>
 
    <volume>
 
    <device>
 
</source>
 
|-
 
|
 
<source lang="bash">
 
os server create
 
    --image <image>
 
    --flavor <flavor>
 
    [--security-group <security-group-list> [...] ]
 
    [--key-name <key-name>]
 
    [--meta-data <key=value> [...] ]
 
    [--file <dest-filename=source-filename>] [...] ]
 
    [--user-data <user-data>]
 
    [--availability-zone <zone-name>]
 
    [--block-device-mapping <dev-name=mapping> [...] ]
 
    [--nic <net-id=net-uuid,v4-fixed-ip=ip-addr> [...] ]
 
    [--hint <key=value> [...] ]
 
    [--config-drive <value>|True ]
 
    [--min <count>]
 
    [--max <count>]
 
    [--wait]
 
    <server-name>
 
</source>
 
|| yes
 
|| ||
 
<source lang="bash">
 
nova boot
 
    [--flavor <flavor>]
 
    [--image <image>]
 
    [--meta <key=value>]
 
    [--file <dst-path=src-path>]
 
    [--key_name <key_name>]
 
    [--user_data <user-data>]
 
    [--availability_zone <availability-zone>]
 
    [--security_groups <security_groups>]
 
    [--block_device_mapping <dev_name=mapping>]
 
    [--hint <key=value>]
 
    [--nic <net-id=net-uuid,v4-fixed-ip=ip-addr>]
 
    [--config-drive <value>]
 
    [--poll]
 
    <name>
 
</source>
 
|-
 
|
 
<source lang="bash">
 
os server delete
 
    <server>
 
</source>
 
|| yes
 
|| ||
 
<source lang="bash">
 
nova delete
 
    <server>
 
</source>
 
|-
 
|
 
<source lang="bash">
 
os server list
 
    [--reservation-id <reservation-id>]
 
    [--ip <ip-regex>]
 
    [--ip6 <ip6-regex>]
 
    [--name <name-regex>]
 
    [--instance-name <instance-name-regex>]
 
    [--status <status>]
 
    [--flavor <flavor>]
 
    [--image <image>]
 
    [--host <hostname>]
 
    [--all-tenants]
 
</source>
 
|| yes
 
|| ||
 
<source lang="bash">
 
nova list
 
    [--reservation_id <reservation_id>]
 
    [--ip <ip_regexp>]
 
    [--ip6 <ip6_regexp>]
 
    [--name <name_regexp>]
 
    [--instance_name <name_regexp>]
 
    [--status <status>]
 
    [--flavor <flavor>] [--image <image>]
 
    [--host <hostname>]
 
    [--all_tenants [<0|1>]]
 
</source>
 
|-
 
|
 
<source lang="bash">
 
os server lock
 
    <server>
 
</source>
 
|| yes
 
|| ||
 
<source lang="bash">
 
nova lock
 
    <server>
 
</source>
 
|-
 
|
 
<source lang="bash">
 
os server migrate
 
    [--wait]
 
    <server>
 
 
 
os server migrate
 
    --live <host>
 
    [--shared-migration | --block-migration]
 
    [--disk-overcommit | --no-disk-overcommit]
 
    [--wait]
 
    <server>
 
</source>
 
|| yes
 
|| ||
 
<source lang="bash">
 
nova migrate
 
    [--poll]
 
    <server>
 
 
 
nova live-migration
 
    [--block_migrate]
 
    [--disk_over_commit]
 
    <server>
 
<host>
 
</source>
 
|-
 
|
 
<source lang="bash">
 
os server pause
 
    <server>
 
</source>
 
|| yes
 
|| ||
 
<source lang="bash">
 
nova pause
 
    <server>
 
</source>
 
|-
 
|
 
<source lang="bash">
 
os server reboot
 
    [--hard | --soft]
 
    [--wait]
 
    <server>
 
</source>
 
|| yes
 
|| ||
 
<source lang="bash">
 
nova reboot
 
    [--hard]
 
    [--poll]
 
    <server>
 
</source>
 
|-
 
|
 
<source lang="bash">
 
os server rebuild
 
    --image <image>
 
    [--password <password>]
 
    [--wait]
 
    <server>
 
</source>
 
|| yes
 
|| ||
 
<source lang="bash">
 
nova rebuild
 
    [--rebuild_password <rebuild_password>]
 
    [--poll]
 
    <server>
 
    <image>
 
</source>
 
|-
 
|
 
<source lang="bash">
 
os server remove secgroup
 
    <server>
 
    <group>
 
</source>
 
|| yes
 
|| ||
 
<source lang="bash">
 
nova remove-secgroup
 
    <server>
 
    <secgroup>
 
</source>
 
|-
 
|
 
<source lang="bash">
 
os server remove volume
 
    <server>
 
    <volume>
 
</source>
 
|| yes
 
|| ||
 
<source lang="bash">
 
nova volume-detach
 
    <server>
 
    <volume>
 
</source>
 
|-
 
|
 
<source lang="bash">
 
os server rescue
 
    <server>
 
</source>
 
|| yes
 
|| ||
 
<source lang="bash">
 
nova rescue
 
    <server>
 
</source>
 
|-
 
|
 
<source lang="bash">
 
os server resize
 
    --flavor <flavor>
 
    [--wait]
 
    <server>
 
 
 
os server resize
 
    --confirm
 
    <server>
 
 
 
os server resize
 
    --revert
 
    <server>
 
</source>
 
|| yes
 
|| ||
 
<source lang="bash">
 
nova resize
 
    [--poll]
 
    <server>
 
    <flavor>
 
 
 
nova resize-confirm
 
    <server>
 
 
 
nova resize-revert
 
    <server>
 
</source>
 
|-
 
|
 
<source lang="bash">
 
os server resume
 
    <server>
 
</source>
 
|| yes
 
|| ||
 
<source lang="bash">
 
nova resume
 
    <server>
 
</source>
 
|-
 
|
 
<source lang="bash">
 
os server set
 
    --name <new-name>
 
    --property <key=value>
 
    [--property <key=value>] ...
 
    --root-password
 
    <server>
 
</source>
 
|| yes
 
|| ||
 
<source lang="bash">
 
nova meta
 
    <server>
 
    <action>
 
    <key=value>
 
    [<key=value> ...]
 
 
 
nova rename
 
    <server>
 
    <name>
 
 
 
nova root-password
 
    <server>
 
</source>
 
|-
 
|
 
<source lang="bash">
 
os server show
 
    <server>
 
</source>
 
|| yes
 
|| ||
 
<source lang="bash">
 
nova show
 
    <server>
 
</source>
 
|-
 
|
 
<source lang="bash">
 
os server ssh
 
    [--login <login-name>]
 
    [--port <port>]
 
    [--identity <keyfile>]
 
    [--option <config-options>]
 
    [-4 | -6]
 
    [--private | --public | --address-type <address-type>]
 
    <server>
 
</source>
 
|| yes
 
|| ||
 
<source lang="bash">
 
nova ssh
 
    [--port PORT]
 
    [--private]
 
    [--ipv6]
 
    [--login <login>]
 
    <server>
 
</source>
 
|-
 
|
 
<source lang="bash">
 
os server suspend
 
    <server>
 
</source>
 
|| yes
 
|| ||
 
<source lang="bash">
 
nova suspend
 
    <server>
 
</source>
 
|-
 
|
 
<source lang="bash">
 
os server unlock
 
    <server>
 
</source>
 
|| yes
 
|| ||
 
<source lang="bash">
 
nova unlock
 
    <server>
 
</source>
 
|-
 
|
 
<source lang="bash">
 
os server unpause
 
    <server>
 
</source>
 
|| yes
 
|| ||
 
<source lang="bash">
 
nova unpause
 
    <server>
 
</source>
 
|-
 
|
 
<source lang="bash">
 
os server unrescue
 
    <server>
 
</source>
 
|| yes
 
|| ||
 
<source lang="bash">
 
nova unrescue
 
    <server>
 
</source>
 
|-
 
|
 
<source lang="bash">
 
os unset server
 
    --property <key>
 
    [--property <key>] ...
 
    <server>
 
</source>
 
|| yes
 
|| ||
 
<source lang="bash">
 
nova meta
 
    <server>
 
    <action>
 
    <key=value>
 
    [<key=value> ...]
 
</source>
 
|}
 
 
 
==== usage ====
 
 
 
{| class="wikitable"
 
|-
 
! OSC Command !! Implemented !! !! Nova command
 
|-
 
|
 
<source lang="bash">
 
os usage list
 
    [--start <start>]
 
    [--end <end>]
 
</source>
 
|| no
 
|| ||
 
<source lang="bash">
 
nova usage-list
 
    [--start <start>]
 
    [--end <end>]
 
</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]].
 
 
 
 
 
== 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">
 
os catalog show
 
    [--service <service>]
 
</source>
 
|| no
 
|| ||
 
<source lang="bash">
 
keystone catalog
 
    [--service <service-type>]
 
</source>
 
|}
 
 
 
==== ec2 credentials ====
 
 
 
{| class="wikitable"
 
|-
 
! OSC Command !! Implemented !! !! Keystone command
 
|-
 
|
 
<source lang="bash">
 
os ec2 credentials create
 
    [--project <project>]
 
    [--user <user>]
 
</source>
 
|| yes
 
|| ||
 
<source lang="bash">
 
keystone ec2-credentials-create
 
    [--user <user-id>]
 
    [--tenant_id <tenant-id>]
 
</source>
 
|-
 
|
 
<source lang="bash">
 
os ec2 credentials delete
 
    [--user <user>]
 
    <access-key>
 
</source>
 
|| yes
 
|| ||
 
<source lang="bash">
 
keystone ec2-credentials-delete
 
    [--user <user-id>]
 
    --access <access-key>
 
</source>
 
|-
 
|
 
<source lang="bash">
 
os ec2 credentials list
 
    [--user <user>]
 
</source>
 
|| yes
 
|| ||
 
<source lang="bash">
 
keystone ec2-credentials-list
 
    [--user <user-id>]
 
</source>
 
|-
 
|
 
<source lang="bash">
 
os ec2 credentials show
 
    [--user <user>]
 
    <access-key>
 
</source>
 
|| yes
 
|| ||
 
<source lang="bash">
 
keystone ec2-credentials-get
 
    [--user <user-id>]
 
    --access <access-key>
 
</source>
 
|}
 
 
 
==== endpoint ====
 
 
 
{| class="wikitable"
 
|-
 
! OSC Command !! Implemented !! !! Keystone command
 
|-
 
|
 
<source lang="bash">
 
os endpoint create
 
    --publicurl <public-url>
 
    [--adminurl <admin-url>]
 
    [--internalurl <internal-url>]
 
    [--region <endpoint-region>]
 
    <service>
 
</source>
 
|| yes
 
|| ||
 
<source lang="bash">
 
keystone endpoint-create
 
    [--region <endpoint-region>]
 
    [--service_id <service-id>]
 
    [--publicurl <public-url>]
 
    [--adminurl <admin-url>]
 
    [--internalurl <internal-url>]
 
</source>
 
|-
 
|
 
<source lang="bash">
 
os endpoint delete
 
    <endpoint-id>
 
</source>
 
|| yes
 
|| ||
 
<source lang="bash">
 
keystone endpoint-delete
 
    <endpoint-id>
 
</source>
 
|-
 
|
 
<source lang="bash">
 
os endpoint list
 
    [--long]
 
</source>
 
|| yes
 
|| ||
 
<source lang="bash">
 
keystone endpoint-list
 
</source>
 
|-
 
|
 
<source lang="bash">
 
os endpoint show
 
    [--type <endpoint-type>]
 
    [--attr <endpoint-attribute>]
 
    [--value <endpoint-value>]
 
    [--all]
 
    <service-type>
 
</source>
 
|| yes
 
|| ||
 
<source lang="bash">
 
keystone endpoint-get
 
    --service <service-type>
 
    [--endpoint_type <endpoint-type>]
 
    [--attr <service-attribute>]
 
    [--value <value>]
 
</source>
 
|}
 
 
 
==== project ====
 
 
 
{| class="wikitable"
 
|-
 
! OSC Command !! Implemented !! !! Keystone command
 
|-
 
|
 
<source lang="bash">
 
os project create
 
    [--description <description>]
 
    [--enable | --disable]
 
    <project-name>
 
</source>
 
|| yes
 
|| ||
 
<source lang="bash">
 
keystone tenant-create
 
    --name <tenant-name>
 
    [--description <tenant-description>]
 
    [--enabled <true|false>]
 
</source>
 
|-
 
|
 
<source lang="bash">
 
os project delete
 
    <project>
 
</source>
 
|| yes
 
|| ||
 
<source lang="bash">
 
keystone tenant-delete
 
    <tenant>
 
</source>
 
|-
 
|
 
<source lang="bash">
 
os project list
 
    [--long]
 
</source>
 
|| yes
 
|| ||
 
<source lang="bash">
 
keystone tenant-list
 
</source>
 
|-
 
|
 
<source lang="bash">
 
os project set
 
    [--name <new-project-name>]
 
    [--description <new-project-description>]
 
    [--enable | --disable]
 
    <project>
 
</source>
 
|| yes
 
|| ||
 
<source lang="bash">
 
keystone tenant-update
 
    [--name <tenant_name>]
 
    [--description <tenant-description>]
 
    [--enabled <true|false>]
 
    <tenant-id>
 
</source>
 
|-
 
|
 
<source lang="bash">
 
os project show
 
    <project>
 
</source>
 
|| yes
 
|| ||
 
<source lang="bash">
 
keystone tenant-get
 
    <tenant-id>
 
</source>
 
|}
 
 
 
==== role ====
 
 
 
{| class="wikitable"
 
|-
 
! OSC Command !! Implemented !! !! Keystone command
 
|-
 
|
 
<source lang="bash">
 
os role create
 
    <role-name>
 
</source>
 
|| yes
 
|| ||
 
<source lang="bash">
 
keystone role-create --name
 
    <role-name>
 
</source>
 
|-
 
|
 
<source lang="bash">
 
os role delete
 
    <role>
 
</source>
 
|| yes
 
|| ||
 
<source lang="bash">
 
keystone role-delete
 
    <role-id>
 
</source>
 
|-
 
|
 
<source lang="bash">
 
os role list
 
</source>
 
|| yes
 
|| ||
 
<source lang="bash">
 
keystone role-list
 
</source>
 
|-
 
|
 
<source lang="bash">
 
os role show
 
    <role>
 
</source>
 
|| yes
 
|| ||
 
<source lang="bash">
 
keystone role-get
 
    <role-id>
 
</source>
 
|}
 
 
 
==== service ====
 
 
 
{| class="wikitable"
 
|-
 
! OSC Command !! Implemented !! !! Keystone command
 
|-
 
|
 
<source lang="bash">
 
os service create
 
    [--type <service-type>]
 
    [--description <service-description>]
 
    <service-name>
 
</source>
 
|| yes
 
|| ||
 
<source lang="bash">
 
keystone service-create
 
    --name <name>
 
    --type <type>
 
    [--description <service-description>]
 
</source>
 
|-
 
|
 
<source lang="bash">
 
os service delete
 
    <service>
 
</source>
 
|| yes
 
|| ||
 
<source lang="bash">
 
keystone service-delete
 
    <service-id>
 
</source>
 
|-
 
|
 
<source lang="bash">
 
os service list
 
    [--long]
 
</source>
 
|| yes
 
|| ||
 
<source lang="bash">
 
keystone service-list
 
</source>
 
|-
 
|
 
<source lang="bash">
 
os service show
 
    [--catalog]
 
    <service>
 
</source>
 
|| yes
 
|| ||
 
<source lang="bash">
 
keystone service-get
 
    <service-id>
 
</source>
 
|}
 
 
 
==== token ====
 
 
 
{| class="wikitable"
 
|-
 
! OSC Command !! Implemented !! !! Keystone command
 
|-
 
|
 
<source lang="bash">
 
os token show
 
    [--width <token-display-width>]
 
</source>
 
|| ??
 
|| ||
 
<source lang="bash">
 
keystone token-get [--wrap <integer>]
 
</source>
 
|}
 
 
 
==== user ====
 
 
 
{| class="wikitable"
 
|-
 
! OSC Command !! Implemented !! !! Keystone command
 
|-
 
|
 
<source lang="bash">
 
os user create
 
    [--password <user-password>]
 
    [--email <user-email>]
 
    [--tenant <tenant>]
 
    [--enable | --disable]
 
    <user-name>
 
</source>
 
|| yes
 
|| ||
 
<source lang="bash">
 
keystone user-create
 
    --name <user-name>
 
    [--tenant_id <tenant-id>]
 
    [--pass <pass>]
 
    [--email <email>]
 
    [--enabled <true|false>]
 
</source>
 
|-
 
|
 
<source lang="bash">
 
os user delete
 
    <user>
 
</source>
 
|| yes
 
|| ||
 
<source lang="bash">
 
keystone user-delete
 
    <user-id>
 
</source>
 
|-
 
|
 
<source lang="bash">
 
os user list
 
    [--tenant <tenant>]
 
    [--long]
 
</source>
 
|| yes
 
|| ||
 
<source lang="bash">
 
keystone user-list
 
    [<tenant-id>]
 
</source>
 
|-
 
|
 
<source lang="bash">
 
os user set
 
    [--name <new-user-name>]
 
    [--password <user-password>]
 
    [--email <user-email>]
 
    [--tenant <tenant>]
 
    [--enable|--disable]
 
    <user>
 
</source>
 
|| yes
 
|| ||
 
<source lang="bash">
 
keystone user-password-update
 
    --pass <password>
 
    <user-id>
 
</source>
 
|-
 
|
 
<source lang="bash">
 
os user show
 
    <user>
 
</source>
 
|| yes
 
|| ||
 
<source lang="bash">
 
keystone user-get
 
    <user-id>
 
</source>
 
|}
 
 
 
==== user role ====
 
 
 
{| class="wikitable"
 
|-
 
! OSC Command !! Implemented !! !! Keystone command
 
|-
 
|
 
<source lang="bash">
 
os user role add
 
    [--tenant <tenant>]
 
    <user>
 
    <role>
 
</source>
 
|| yes
 
|| ||
 
<source lang="bash">
 
keystone user-role-add
 
    --user <user-id>
 
    --role <role-id>
 
    [--tenant_id <tenant-id>]
 
</source>
 
|-
 
|
 
<source lang="bash">
 
os user role list
 
    [--tenant <tenant>]
 
    [<user>]
 
</source>
 
|| yes
 
|| ||
 
<source lang="bash">
 
keystone user-role-list
 
    [--user <user-id>]
 
    [--tenant_id <tenant-id>]
 
</source>
 
|-
 
|
 
<source lang="bash">
 
os user role remove
 
    [--tenant <tenant>]
 
    <user>
 
    <role>
 
</source>
 
|| yes
 
|| ||
 
<source lang="bash">
 
keystone user-role-remove
 
    --user <user-id>
 
    --role <role-id>
 
    [--tenant_id <tenant-id>]
 
</source>
 
|}
 
 
 
==== <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"
 
|-
 
! OSC Command !! Implemented !! !! Keystone command
 
|-
 
|
 
<source lang="bash">
 
os credential create
 
    [--project <project>]
 
    [--type ec2|cert]
 
    <user>
 
    <data>
 
</source>
 
|| yes
 
|| ||
 
<source lang="bash">
 
keystone credential-create
 
    --user_id <user-id>
 
    --type <credential-type>
 
    --data <credential-data>
 
    [--project_id <project-id>]
 
</source>
 
|-
 
|
 
<source lang="bash">
 
os credential delete
 
    <credential-id>
 
</source>
 
|| yes
 
|| ||
 
<source lang="bash">
 
keystone credential-delete
 
    <credential-id>
 
</source>
 
|-
 
|
 
<source lang="bash">
 
os credential list
 
</source>
 
|| yes
 
|| ||
 
<source lang="bash">
 
keystone credential-list
 
</source>
 
|-
 
|
 
<source lang="bash">
 
os credential set
 
    [--user <user>]
 
    [--type ec2|cert]
 
    [--data <data>]
 
    [--project <project>]
 
    <credential-id>
 
</source>
 
|| yes
 
|| ||
 
<source lang="bash">
 
keystone credential-update
 
    [--user <user>]
 
    [--type <type>]
 
    [--data <data>]
 
    [--project <project>]
 
    <credential-id>
 
</source>
 
|-
 
|
 
<source lang="bash">
 
os credential show
 
    <credential-id>
 
</source>
 
|| yes
 
|| ||
 
<source lang="bash">
 
keystone credential-get
 
    <credential-id>
 
</source>
 
|}
 
 
 
==== domain ====
 
 
 
{| class="wikitable"
 
|-
 
! OSC Command !! Implemented !! !! Keystone command
 
|-
 
|
 
<source lang="bash">
 
os domain create
 
    [--description <domain-description>]
 
    [--enable | --disable]
 
    <domain-name>
 
</source>
 
|| yes
 
|| ||
 
<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 lang="bash">
 
os domain delete
 
    <domain>
 
</source>
 
|| yes
 
|| ||
 
<source lang="bash">
 
keystone domain-delete
 
    <domain-id>
 
</source>
 
|-
 
|
 
<source lang="bash">
 
os domain list
 
</source>
 
|| yes
 
|| ||
 
<source lang="bash">
 
keystone domain-list
 
</source>
 
|-
 
|
 
<source lang="bash">
 
os domain set
 
    [--name <new-domain-name>]
 
    [--description <new-domain-description>]
 
    [--enable | --disable]
 
    <domain>
 
</source>
 
|| yes
 
|| ||
 
<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 lang="bash">
 
os domain show
 
    <domain>
 
</source>
 
|| yes
 
|| ||
 
<source lang="bash">
 
keystone domain-get
 
    <domain-id>
 
</source>
 
|}
 
 
 
==== endpoint ====
 
 
 
{| class="wikitable"
 
|-
 
! OSC Command !! Implemented !! !! Keystone command
 
|-
 
|
 
<source lang="bash">
 
os endpoint create
 
    [--region <endpoint-region>
 
    [--enable | --disable]
 
    <service>
 
    <interface admin|public|internal>
 
    <url>
 
</source>
 
|| yes
 
|| ||
 
<source lang="bash">
 
keystone endpoint-create
 
    [--region <endpoint-region>
 
    [--enable | --disable]
 
    <service_id>
 
    <interface admin|public|internal>
 
    <url>
 
</source>
 
|-
 
|
 
<source lang="bash">
 
os endpoint delete
 
    <endpoint-id>
 
</source>
 
|| yes
 
|| ||
 
<source lang="bash">
 
</source>
 
|-
 
|
 
<source lang="bash">
 
os endpoint list
 
    [--long]
 
</source>
 
|| yes
 
|| ||
 
<source lang="bash">
 
keystone endpoint-list
 
</source>
 
|-
 
|
 
<source lang="bash">
 
os endpoint set
 
    [--interface <endpoint-interface>]
 
    [--url <endpoint-url>]
 
    [--service <service-id>]
 
    [--region <endpoint-region>]
 
    [--enable | --disable]
 
    <endpoint>
 
</source>
 
|| yes
 
|| ||
 
<source lang="bash">
 
keystone endpoint-set
 
    [--interface <endpoint-interface>]
 
    [--url <endpoint-url>]
 
    [--service <service-id>]
 
    [--region <endpoint-region>]
 
    [--enable | --disable]
 
    <endpoint>
 
</source>
 
|-
 
|
 
<source lang="bash">
 
os endpoint show
 
    <endpoint>
 
</source>
 
|| yes
 
|| ||
 
<source lang="bash">
 
keystone endpoint-get
 
    <endpoint>
 
</source>
 
|}
 
 
 
==== group ====
 
 
 
{| class="wikitable"
 
|-
 
! OSC Command !! Implemented !! !! Keystone command
 
|-
 
|
 
<source lang="bash">
 
os group create
 
    [--domain <domain>]
 
    [--description <group-description>]
 
    <group-name>
 
</source>
 
|| yes
 
|| ||
 
<source lang="bash">
 
keystone group-create
 
    --name <group-name>
 
    [--domain_id <domain-id>]
 
    [--description <group-description>]
 
</source>
 
|-
 
|
 
<source lang="bash">
 
os group delete
 
    <group>
 
</source>
 
|| yes
 
|| ||
 
<source lang="bash">
 
keystone group-delete
 
    <group-id>
 
</source>
 
|-
 
|
 
<source lang="bash">
 
os group list
 
    [--long]
 
</source>
 
|| yes
 
|| ||
 
<source lang="bash">
 
keystone group-list
 
</source>
 
|-
 
|
 
<source lang="bash">
 
os group set
 
    [--name <new-group-name>]
 
    [--domain <domain>]
 
    [--description <new-group-description>]
 
    <group>
 
</source>
 
|| yes
 
|| ||
 
<source lang="bash">
 
keystone group-update
 
    [--name <group_name>]
 
    [--domain_id <domain-id>]
 
    [--description <group-description>]
 
    <group-id>
 
</source>
 
|-
 
|
 
<source lang="bash">
 
os group show
 
    <group>
 
</source>
 
|| yes
 
|| ||
 
<source lang="bash">
 
keystone group-get
 
    <group-id>
 
</source>
 
|}
 
 
 
==== oauth ====
 
 
 
{| class="wikitable"
 
|-
 
! OSC Command !! Implemented !! !! Keystone command
 
|-
 
|
 
<source lang="bash">
 
os oauth request token create
 
    --consumer-key <consumer-key>
 
    --consumer-secret <consumer-secret>
 
    --roles <requested-roles>
 
</source>
 
|| yes
 
|| ||
 
n /a
 
|-
 
|
 
<source lang="bash">
 
os oauth request token authorize
 
    --request-key <request-key>
 
    --roles <requested-roles>
 
</source>
 
|| yes
 
|| ||
 
n /a
 
|-
 
|
 
<source lang="bash">
 
os oauth access token create
 
    --consumer-key <consumer-key>
 
    --consumer-secret <consumer-secret>
 
    --request-key <request-key>
 
    --request-secret <request-secret>
 
    --verifier <pin>
 
</source>
 
|| yes
 
|| ||
 
<source lang="bash">
 
n/a
 
</source>
 
|-
 
|
 
<source lang="bash">
 
os oauth access token authenticate
 
    --consumer-key <consumer-key>
 
    --consumer-secret <consumer-secret>
 
    --access-key <access-key>
 
    --access-secret <access-secret>
 
</source>
 
|| yes
 
|| ||
 
n /a
 
|-
 
|
 
<source lang="bash">
 
os oauth authorization list
 
    user <user>
 
</source>
 
|| yes
 
|| ||
 
n /a
 
|-
 
|
 
<source lang="bash">
 
os oauth authorization delete
 
    user <user>
 
    access-id <access-id>
 
</source>
 
|| yes
 
|| ||
 
n /a
 
|-
 
|
 
<source lang="bash">
 
os oauth authorization show
 
    request-id <request-id>
 
</source>
 
|| yes
 
|| ||
 
n /a
 
|-
 
| look at some alternatives: || || ||
 
|-
 
|
 
<source lang="bash">
 
os oauth token create
 
    --consumer-key <consumer-key>
 
    --consumer-secret <consumer-secret>
 
    --request-key <request-key>
 
    --request-secret <request-secret>
 
    --verifier <pin>
 
</source>
 
|| nyet
 
|| ||
 
<source lang="bash">
 
* makes the token specific to oauth
 
* add [--oauth-ver X] if versioning for oauth2 is an issue?
 
</source>
 
|-
 
|
 
<source lang="bash">
 
os oauth token create
 
    --request
 
    --consumer-key <consumer-key>
 
    --roles <roles>
 
</source>
 
|| nyet
 
|| ||
 
<source lang="bash">
 
* collapse 'access token' and 'request token' into 'oauth token'?
 
</source>
 
|}
 
 
 
==== policy ====
 
 
 
{| class="wikitable"
 
|-
 
! OSC Command !! Implemented !! !! Keystone command
 
|-
 
|
 
<source lang="bash">
 
os policy create
 
    [--type <policy-type>]
 
    --blob-file <blob-file>
 
</source>
 
|| yes
 
|| ||
 
<source lang="bash">
 
keystone policy-create
 
    --type <policy-type>
 
    --blob <policy-blob>
 
</source>
 
|-
 
|
 
<source lang="bash">
 
os policy delete
 
    <policy-id>
 
</source>
 
|| yes
 
|| ||
 
<source lang="bash">
 
keystone policy-delete
 
    <policy-id>
 
</source>
 
|-
 
|
 
<source lang="bash">
 
os policy list
 
    [--include-blob]
 
</source>
 
|| yes
 
|| ||
 
<source lang="bash">
 
keystone policy-list
 
</source>
 
|-
 
|
 
<source lang="bash">
 
os policy set
 
    [--type <policy-type>]
 
    [--blob-file<blob-file>]
 
    <policy-id>
 
</source>
 
|| yes
 
|| ||
 
<source lang="bash">
 
keystone policy-update
 
    [--type <policy-type>]
 
    [--blob <policy-blob>]
 
    <policy-id>
 
</source>
 
|-
 
|
 
<source lang="bash">
 
os policy show
 
    <policy-id>
 
</source>
 
|| yes
 
|| ||
 
<source lang="bash">
 
keystone policy-get
 
    <policy-id>
 
</source>
 
|}
 
 
 
==== project ====
 
 
 
{| class="wikitable"
 
|-
 
! OSC Command !! Implemented !! !! Keystone command
 
|-
 
|
 
<source lang="bash">
 
os project create
 
    [--domain <project-domain>]
 
    [--description <project-description>]
 
    [--enable | --disable]
 
    <project-name>
 
</source>
 
|| yes
 
|| ||
 
<source lang="bash">
 
keystone project-create
 
    [--domain_id <domain_id>]
 
    [--description <description>]
 
    [--enable | --disable]
 
    <name>
 
</source>
 
|-
 
|
 
<source lang="bash">
 
os project delete
 
    <project>
 
</source>
 
|| yes
 
|| ||
 
<source lang="bash">
 
os project-delete
 
    <project_id>
 
</source>
 
|-
 
|
 
<source lang="bash">
 
os project list
 
    [--long]
 
</source>
 
|| yes
 
|| ||
 
<source lang="bash">
 
keystone project-list
 
</source>
 
|-
 
|
 
<source lang="bash">
 
os project set
 
    [--name <new-project-name>]
 
    [--domain <project-domain>]
 
    [--description <new-project-description>]
 
    [--enable | --disable]
 
    <project>
 
</source>
 
|| yes
 
|| ||
 
<source lang="bash">
 
keystone project-set
 
    [--name <new-project-name>]
 
    [--domain <project-domain>]
 
    [--description <new-project-description>]
 
    [--enable | --disable]
 
    <project_id>
 
</source>
 
|-
 
|
 
<source lang="bash">
 
os project show
 
    <project>
 
</source>
 
|| yes
 
|| ||
 
<source lang="bash">
 
keystone project-get
 
    <project_id>
 
</source>
 
|}
 
 
 
==== role ====
 
 
 
{| class="wikitable"
 
|-
 
! OSC Command !! Implemented !! !! Keystone command
 
|-
 
|
 
<source lang="bash">
 
os role add
 
    [--user <user> | --group <group>]
 
    [--domain <domain> | --project <project>]
 
    <role>
 
</source>
 
|| yes
 
|| ||
 
<source lang="bash">
 
</source>
 
|-
 
|
 
<source lang="bash">
 
os role create
 
    <role-name>
 
</source>
 
|| yes
 
|| ||
 
<source lang="bash">
 
</source>
 
|-
 
|
 
<source lang="bash">
 
os role delete
 
    <role>
 
</source>
 
|| yes
 
|| ||
 
<source lang="bash">
 
</source>
 
|-
 
|
 
<source lang="bash">
 
os role list
 
</source>
 
|| yes
 
|| ||
 
<source lang="bash">
 
</source>
 
|-
 
|
 
<source lang="bash">
 
os role remove
 
    [--user <user> | --group <group>]
 
    [--domain <domain> | --project <project>]
 
    <role>
 
</source>
 
|| yes
 
|| ||
 
<source lang="bash">
 
</source>
 
|-
 
|
 
<source lang="bash">
 
os role set
 
    [--name <new-role-name>]
 
    <role>
 
</source>
 
|| yes
 
|| ||
 
<source lang="bash">
 
</source>
 
|-
 
|
 
<source lang="bash">
 
os role show
 
    <role>
 
</source>
 
|| yes
 
|| ||
 
<source lang="bash">
 
</source>
 
|}
 
 
 
==== service ====
 
 
 
{| class="wikitable"
 
|-
 
! OSC Command !! Implemented !! !! Keystone command
 
|-
 
|
 
<source lang="bash">
 
os service create
 
[--name <name>]
 
        [--enabled <true|false>]
 
        <type>
 
</source>
 
|| yes
 
|| ||
 
<source lang="bash">
 
keystone service-create
 
[--name <name>]
 
        [--enabled <true|false>]
 
        <type>
 
</source>
 
|-
 
|
 
<source lang="bash">
 
os service delete
 
    <service>
 
</source>
 
|| yes
 
|| ||
 
<source lang="bash">
 
keystone service-delete
 
    <service_id>
 
</source>
 
|-
 
|
 
<source lang="bash">
 
os list service
 
</source>
 
|| yes
 
|| ||
 
<source lang="bash">
 
keystone service-list
 
</source>
 
|-
 
|
 
<source lang="bash">
 
os service set
 
    [--type <service-type>]
 
    [--name <new-name>]
 
    [--enable | --disable]
 
    <service>
 
</source>
 
|| yes
 
|| ||
 
<source lang="bash">
 
keystone service-set
 
    [--type <service-type>]
 
    [--name <new-name>]
 
    [--enable | --disable]
 
    <service>
 
</source>
 
|-
 
|
 
<source lang="bash">
 
os service show
 
    <service>
 
</source>
 
|| yes
 
|| ||
 
<source lang="bash">
 
keystone service-get
 
    <service_id>
 
</source>
 
|}
 
 
 
==== user ====
 
 
 
{| class="wikitable"
 
|-
 
! OSC Command !! Implemented !! !! Keystone command
 
|-
 
|
 
<source lang="bash">
 
os user create
 
    [--password <password>]
 
    [--project <project>]
 
    [--email <user-email>]
 
    [--enable | --disable]
 
    <name>
 
</source>
 
|| yes
 
|| ||
 
<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 lang="bash">
 
os user delete
 
    <user>
 
</source>
 
|| yes
 
|| ||
 
<source lang="bash">
 
keystone user-delete
 
    <user-id>
 
</source>
 
|-
 
|
 
<source lang="bash">
 
os user list
 
    [--project <project>]
 
    [--long]
 
</source>
 
|| yes
 
|| ||
 
<source lang="bash">
 
keystone user-list
 
</source>
 
|-
 
|
 
<source lang="bash">
 
os user set
 
    [--name <new-name>]
 
    [--password <password>]
 
    [--project <project>]
 
    [--email <user-email>]
 
    [--enable | --disable]
 
    <user>
 
</source>
 
|| yes
 
|| ||
 
<source lang="bash">
 
keystone user-update
 
    --user_id <user-id>
 
    [--name <user-name>]
 
    [--domain_id <domain-id>]
 
    [--default_project_id <project-id>]
 
    [--description <description>]
 
    [--enabled <true|false>]
 
    [--password <password>]
 
</source>
 
|-
 
|
 
<source lang="bash">
 
os user show
 
    <user>
 
</source>
 
|| yes
 
|| ||
 
<source lang="bash">
 
keystone user-get
 
    <user-id>
 
</source>
 
|}
 
 
 
== Image ==
 
 
 
{| class="wikitable"
 
|-
 
! OSC Option !!  Environment Variable !!  !!  Glance Option !!  Environment Variable
 
|-
 
| --os-image-api-version <ver> || OS_IMAGE_API_VERSION ||  || --os-image-api-version <ver> || OS_IMAGE_API_VERSION
 
|-
 
|  ||  || || --os-service-type <type> || OS_SERVICE_TYPE
 
|-
 
|  ||  || || --os-endpoint-type <type> || OS_ENDPOINT_TYPE
 
|-
 
| --os-token <token> || OS_TOKEN || || --os-auth-token <token> || OS_AUTH_TOKEN
 
|-
 
| --os-url <url> || OS_URL || || --os-image-url <url> || OS_IMAGE_URL
 
|-
 
|  ||  || || --os-cacert <file> || OS_CACERT
 
|-
 
|  ||  || || --cert-file <file> || CERT_FILE
 
|-
 
|  ||  || || --key-file <key-file> || KEY_FILE
 
|-
 
|  ||  || || --no-ssl-compression ||
 
|-
 
|}
 
 
 
 
 
=== API v1 ===
 
 
 
==== image ====
 
 
 
{| class="wikitable"
 
|-
 
! OSC Command !! Implemented !! !! Glance command
 
|-
 
|
 
<source lang="bash">
 
os image create
 
    [--id <id>]
 
    [--store <store>]
 
    [--container-format <format>]
 
    [--disk-format <format>]
 
    [--owner <tenant>]
 
    [--size <size-bytes>]
 
    [--min-disk <disk-gb>]
 
    [--min-ram <ram-mg>]
 
    [--location <image-url>]
 
    [--copy-from <image-url>]
 
    [--file <local-filename>]
 
    [--checksum <checksum>]
 
    [--protected | --unprotected]
 
    [--public | --private]
 
    [--property <key=value>]
 
    <name>
 
</source>
 
|| yes
 
|| ||
 
<source lang="bash">
 
glance image-create
 
    [--id <IMAGE_ID>]
 
    [--name <NAME>]
 
    [--disk-format <DISK_FORMAT>]
 
    [--container-format <CONTAINER_FORMAT>]
 
    [--owner <TENANT_ID>]
 
    [--size <SIZE>]
 
    [--min-disk <DISK_GB>]
 
    [--min-ram <DISK_RAM>]
 
    [--location <IMAGE_URL>]
 
    [--checksum <CHECKSUM>]
 
    [--copy-from <IMAGE_URL>]
 
    [--is-public [True|False]]
 
    [--is-protected [True|False]]
 
    [--property <key=value>]
 
    [--human-readable]
 
</source>
 
|-
 
|
 
<source lang="bash">
 
os image delete
 
    <image>
 
</source>
 
|| yes
 
|| ||
 
<source lang="bash">
 
glance image-delete
 
    <IMAGE_ID>
 
</source>
 
|-
 
|
 
<source lang="bash">
 
os image list
 
    [--page-size <size>]
 
</source>
 
|| yes
 
|| ||
 
<source lang="bash">
 
glance image-list
 
</source>
 
|-
 
|
 
<source lang="bash">
 
os image save
 
    [--file <filename>]
 
    <image>
 
</source>
 
|| yes
 
|| ||
 
<source lang="bash">
 
glance image-download
 
    [--file <FILE>]
 
    <IMAGE>
 
</source>
 
|-
 
|
 
<source lang="bash">
 
os image set
 
    [--name <name>]
 
    [--owner <tenant>]
 
    [--min-disk <disk-gb>]
 
    [--min-ram <ram-mg>]
 
    [--protected | --unprotected]
 
    [--public | --private]
 
    [--property <key=value>]
 
    <image>
 
</source>
 
|| yes
 
|| ||
 
<source lang="bash">
 
glance image-update
 
    [--name <NAME>]
 
    [--disk-format <DISK_FORMAT>]
 
    [--container-format <CONTAINER_FORMAT>]
 
    [--owner <TENANT_ID>]
 
    [--size <SIZE>]
 
    [--min-disk <DISK_GB>]
 
    [--min-ram <DISK_RAM>]
 
    [--location <IMAGE_URL>]
 
    [--file <FILE>]
 
    [--checksum <CHECKSUM>]
 
    [--copy-from <IMAGE_URL>]
 
    [--is-public [True|False]]
 
    [--is-protected [True|False]]
 
    [--property <key=value>]
 
    [--purge-props]
 
    [--human-readable]
 
    <IMAGE>
 
</source>
 
|-
 
|
 
<source lang="bash">
 
os image show
 
    <image>
 
</source>
 
|| yes
 
|| ||
 
<source lang="bash">
 
glance image-show
 
    [--human-readable]
 
    <IMAGE>
 
</source>
 
|}
 
 
 
=== API v2 ===
 
 
 
==== image ====
 
 
 
 
 
{| class="wikitable"
 
|-
 
! OSC Command !! Implemented !! !! Glance command
 
|-
 
|
 
<source lang="bash">
 
os image add project
 
    <image>
 
    <project>
 
</source>
 
|| no
 
|| ||
 
<source lang="bash">
 
glance member-create
 
    [--can-share]
 
    <IMAGE_ID>
 
    <TENANT_ID>
 
</source>
 
|-
 
|
 
<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>
 
# verify v2 options
 
</source>
 
|| no
 
|| ||
 
<source lang="bash">
 
</source>
 
|-
 
|
 
<source lang="bash">
 
os image delete
 
    <image>
 
</source>
 
|| yes
 
|| ||
 
<source lang="bash">
 
glance image-delete
 
    <IMAGE_ID>
 
</source>
 
|-
 
|
 
<source lang="bash">
 
os image list
 
    [--page-size <size>]
 
</source>
 
|| yes
 
|| ||
 
<source lang="bash">
 
glance image-list
 
</source>
 
|-
 
|
 
<source lang="bash">
 
os image list
 
    --shared
 
    [--image <image>]
 
    [--project <project>]
 
</source>
 
|| no
 
|| ||
 
<source lang="bash">
 
glance member-list
 
    [--image-id <IMAGE_ID>]
 
    [--tenant-id <TENANT_ID>]
 
</source>
 
|-
 
|
 
<source lang="bash">
 
os image remove project
 
    <image>
 
    <project>
 
</source>
 
|| no
 
|| ||
 
<source lang="bash">
 
glance member-delete
 
    <IMAGE_ID>
 
    <TENANT_ID>
 
</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 ====
 
 
 
The image member commands have been rolled in to the regualr [[#image_3|image]] commands.
 
 
 
== Object ==
 
 
 
=== API v1 ===
 
 
 
Commands:
 
* upload  [options] container file_or_directory [file_or_directory] [...]
 
* post  [options] [container] [object]
 
 
 
==== container ====
 
 
 
{| class="wikitable"
 
|-
 
! OSC Command !! Implemented !! !! Swift command
 
|-
 
|
 
<source lang="bash">
 
os container list
 
    [--prefix <prefix>]
 
    [--delimiter <delimiter>]
 
    [--long]
 
    [--all]
 
</source>
 
|| yes
 
|| ||
 
<source lang="bash">
 
swift list
 
    [--prefix|-p]
 
    [-l|-lh]
 
    [-t]
 
    [--delimiter|-d]
 
    [options]
 
    [container]
 
</source>
 
|-
 
|
 
<source lang="bash">
 
os container show
 
    [<container-name>]
 
</source>
 
|| yes
 
|| ||
 
<source lang="bash">
 
swift stat
 
    [--lh]
 
    [<container>]
 
    [<object>]
 
</source>
 
|}
 
 
 
==== object ====
 
 
 
{| class="wikitable"
 
|-
 
! OSC Command !! Implemented !! !! Swift command
 
|-
 
|
 
<source lang="bash">
 
os object delete
 
    <object>
 
</source>
 
|| no
 
|| ||
 
<source lang="bash">
 
swift delete
 
    [--leave-segments]
 
    [options]
 
    --all
 
 
 
swift delete container
 
    [--leave-segments]
 
    [options]
 
    [object]
 
    [object] ...
 
</source>
 
|-
 
|
 
<source lang="bash">
 
os object list
 
    [--prefix <prefix>]
 
    [--delimiter <delimiter>]
 
    [--long]
 
    [--all]
 
    <container-name>]
 
</source>
 
|| yes
 
|| ||
 
<source lang="bash">
 
swift list
 
    [--prefix|-p]
 
    [-l|-lh]
 
    [-t]
 
    [--delimiter|-d]
 
    [options]
 
    [container]
 
</source>
 
|-
 
|
 
<source lang="bash">
 
os object show
 
    <container-name>
 
    <object-name>
 
</source>
 
|| yes
 
|| ||
 
<source lang="bash">
 
swift stat
 
    [--lh]
 
    [<container>]
 
    [<object>]
 
</source>
 
|-
 
|
 
<source lang="bash">
 
os object save
 
    [<container>]
 
    [<object>]
 
</source>
 
|| no
 
|| ||
 
<source lang="bash">
 
swift download
 
    --all
 
    [--prefix|-p]
 
    [options]
 
 
 
swift download
 
    container
 
    [--prefix|-p]
 
    [--output|-o <filename>]
 
    [options]
 
    [object]
 
    [object] ...
 
</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>]
 
    <volume>
 
</source>
 
|| yes
 
|| ||
 
<source lang="bash">
 
</source>
 
|}
 
 
 
==== volume type ====
 
 
 
{| class="wikitable"
 
|-
 
! OSC Command !! Implemented !! !! Cinder command
 
|-
 
|
 
<source lang="bash">
 
os volume type create
 
    [--property <key=value>]
 
    <name>
 
</source>
 
|| yes
 
|| ||
 
<source lang="bash">
 
cinder type-create
 
    <type-name>
 
</source>
 
|-
 
|
 
<source lang="bash">
 
os volume type delete
 
    <volume-type>
 
</source>
 
|| yes
 
|| ||
 
<source lang="bash">
 
cinder type-delete
 
    <type-id>
 
</source>
 
|-
 
|
 
<source lang="bash">
 
os volume type list
 
    [--long]
 
</source>
 
|| yes
 
|| ||
 
<source lang="bash">
 
cinder type-list
 
 
 
cinder extra-specs-list
 
</source>
 
|-
 
|
 
<source lang="bash">
 
os volume type set
 
    [--property <key=value>]
 
    <volume-type>
 
</source>
 
|| yes
 
|| ||
 
<source lang="bash">
 
cinder type-key
 
    <type-id>
 
    <set>
 
    <key=value>
 
</source>
 
|-
 
|
 
<source lang="bash">
 
os volume type unset
 
    [--property <key>]
 
    <volume-type>
 
</source>
 
|| yes
 
|| ||
 
<source lang="bash">
 
cinder type-key
 
    <type-id>
 
    <unset>
 
    <key>
 
</source>
 
|}
 
 
 
== Network ==
 
 
 
The Network commands in <code>neutron</code> are actually in pretty good shape.  It appears most update commands have not be
 
en implemented, but looks pretty solid other than that.  Note some questions:
 
 
 
* Should the --request-format option be a global option.  Nice from a developers perspective if you want to test XML for ins
 
tance, but why would users really care.
 
*
 
 
 
{| class="wikitable"
 
|-
 
! OSC Option !! Environment Variable !! !! Nova Option !! Environment Variable
 
|-
 
| || || || --os-auth-strategy || OS_AUTH_STRATEGY
 
|-
 
| --os-auth-url || OS_AUTH_URL || || --os-auth-url || OS_AUTH_URL
 
|-
 
| --os-project-name || OS_PROJECT_NAME || || --os-tenant-name || OS_TENANT_NAME
 
|-
 
| --os-project-id || OS_PROJECT_ID || || --os-tenant-id || OS_TENANT_ID
 
|-
 
| --os-username || OS_USERNAME || || --os-username || OS_USERNAME
 
|-
 
| --os-password || OS_PASSWORD || || --os-password || OS_PASSWORD
 
|-
 
| --os-region-name || OS_REGION_NAME || || --os-region-name || OS_REGION_NAME
 
|-
 
| --os-token || OS_TOKEN || || --os-token || OS_TOKEN
 
|-
 
| --os-url || OS_URL || || --os-url || OS_URL
 
|-
 
| --os-cacert || OS_CACERT || || --os-cacert || OS_CACERT
 
 
 
|}
 
 
 
 
 
=== API v2.0 ===
 
 
 
====Agent====
 
 
 
NOTE: There is no agent create in neutron at the moment.  I assume these should replace the compute commands.
 
 
 
{| class="wikitable"
 
|-
 
! OSC Command !! Implemented !! !! Neutron command
 
|-
 
|<source lang="bash">
 
os agent delete <agent>
 
</source>
 
|| no || ||
 
<source lang="bash">
 
neutron agent-delete <agent>
 
</source>
 
|-
 
|<source lang="bash">
 
os agent list
 
  [-D, --show-details]
 
  [-F FIELD, --field FIELD]
 
  [-f {csv,table}, --format {csv,table}]
 
  [-c COLUMN, --column COLUMN]
 
  [--quote {all,minimal,none,nonnumeric}]
 
</source>
 
|| no || ||
 
<source lang="bash">
 
neutron agent-list
 
  [-D, --show-details]
 
  [-F FIELD, --field FIELD]
 
  [-f {csv,table}, --format {csv,table}]
 
  [-c COLUMN, --column COLUMN]
 
  [--quote {all,minimal,none,nonnumeric}]
 
</source>
 
|-
 
|<source lang="bash">
 
os agent show
 
  [-D, --show-details]
 
  [-F FIELD, --field FIELD]
 
  [-f {csv,table}, --format {csv,table}]
 
  [-c COLUMN, --column COLUMN]
 
  [--variable VARIABLE]
 
  [--prefix PREFIX]
 
</source>
 
|| no || ||
 
<source lang="bash">
 
neutron agent-show <agent>
 
  [-D, --show-details]
 
  [-F FIELD, --field FIELD]
 
  [-f {csv,table}, --format {csv,table}]
 
  [-c COLUMN, --column COLUMN]
 
  [--variable VARIABLE]
 
  [--prefix PREFIX]
 
</source>
 
|-
 
|<source lang="bash">
 
os agent update <agent>
 
</source>
 
|| no || ||
 
<source lang="bash">
 
neutron agent-update <agent>
 
# NOTE: no args, what does this update?
 
</source>
 
|}
 
 
 
====Cisco====
 
{| class="wikitable"
 
|-
 
! OSC Command !! Implemented !! !! Neutron command
 
|-
 
|<source lang="bash">
 
os cisco credential create <credential_name> <credential_type>
 
    [-f {shell,table}] [-c COLUMN]
 
    [--variable VARIABLE] [--prefix PREFIX]
 
    [--request-format {json,xml}]
 
    [--tenant-id TENANT_ID]
 
    [--username USERNAME]
 
    [--password PASSWORD]
 
</source>
 
|| no || ||
 
<source lang="bash">
 
neutron cisco-credential-create <credential_name> <credential_type>
 
    [-f {shell,table}] [-c COLUMN]
 
    [--variable VARIABLE] [--prefix PREFIX]
 
    [--request-format {json,xml}]
 
    [--tenant-id TENANT_ID]
 
    [--username USERNAME]
 
    [--password PASSWORD]
 
</source>
 
|-
 
|<source lang="bash">
 
os cisco credential delete <credential>
 
</source>
 
|| no || ||
 
<source lang="bash">
 
neutron cisco-credential-delete <credential>
 
</source>
 
|-
 
|<source lang="bash">
 
os cisco credential list
 
    [-f {csv,table}] [-c COLUMN]
 
    [--quote {all,minimal,none,nonnumeric}]
 
    [--request-format {json,xml}] [-D]
 
    [-F FIELD]
 
</source>
 
|| no || ||
 
<source lang="bash">
 
neutron cisco-credential-list
 
    [-f {csv,table}] [-c COLUMN]
 
    [--quote {all,minimal,none,nonnumeric}]
 
    [--request-format {json,xml}] [-D]
 
    [-F FIELD]
 
</source>
 
|-
 
|<source lang="bash">
 
os cisco credential show <credential>
 
    [-f {shell,table}] [-c COLUMN]
 
    [--variable VARIABLE] [--prefix PREFIX]
 
    [--request-format {json,xml}] [-D]
 
    [-F FIELD]
 
</source>
 
|| no || ||
 
<source lang="bash">
 
neutron cisco-credential-show <credential>
 
    [-f {shell,table}] [-c COLUMN]
 
    [--variable VARIABLE] [--prefix PREFIX]
 
    [--request-format {json,xml}] [-D]
 
    [-F FIELD]
 
</source>
 
|-
 
|<source lang="bash">
 
os cisco network profile create <name> <vlan|overlay|multi-segment|trunk>
 
    [-f {shell,table}]
 
    [-c COLUMN] [--variable VARIABLE]     
 
    [--prefix PREFIX]                     
 
    [--request-format {json,xml}]         
 
    [--tenant-id TENANT_ID]               
 
    [--sub_type SUB_TYPE]                 
 
    [--segment_range SEGMENT_RANGE]       
 
    [--physical_network PHYSICAL_NETWORK] 
 
    [--multicast_ip_range MULTICAST_IP_RANGE]
 
    [--add-tenant ADD_TENANT]
 
</source>
 
|| no || ||
 
<source lang="bash">
 
neutron cisco-network-profile-create <name> <vlan|overlay|multi-segment|trunk>
 
    [-f {shell,table}]
 
    [-c COLUMN] [--variable VARIABLE]     
 
    [--prefix PREFIX]                     
 
    [--request-format {json,xml}]         
 
    [--tenant-id TENANT_ID]               
 
    [--sub_type SUB_TYPE]                 
 
    [--segment_range SEGMENT_RANGE]       
 
    [--physical_network PHYSICAL_NETWORK] 
 
    [--multicast_ip_range MULTICAST_IP_RANGE]
 
    [--add-tenant ADD_TENANT]
 
</source>
 
|-
 
|<source lang="bash">
 
os cisco network profile delete <profile>
 
    [--request-format {json,xml}]
 
</source>
 
|| no || ||
 
<source lang="bash">
 
neutron cisco-network-profile-delete <profile>
 
    [--request-format {json,xml}]
 
</source>
 
|-
 
|<source lang="bash">
 
os cisco network profile list
 
    [-f {csv,table}] [-c COLUMN]
 
    [--quote {all,minimal,none,nonnumeric}]
 
    [--request-format {json,xml}] [-D]   
 
    [-F FIELD]
 
</source>
 
|| no || ||
 
<source lang="bash">
 
neutron cisco-network-profile-list
 
    [-f {csv,table}] [-c COLUMN]
 
    [--quote {all,minimal,none,nonnumeric}]
 
    [--request-format {json,xml}] [-D]   
 
    [-F FIELD]
 
</source>
 
|-
 
|<source lang="bash">
 
os cisco network profile show <profile>
 
    [-f {shell,table}] [-c COLUMN]
 
    [--variable VARIABLE]               
 
    [--prefix PREFIX]                   
 
    [--request-format {json,xml}] [-D]   
 
    [-F FIELD]
 
</source>
 
|| no || ||
 
<source lang="bash">
 
neutron cisco-network-profile-show <profile>
 
    [-f {shell,table}] [-c COLUMN]
 
    [--variable VARIABLE]               
 
    [--prefix PREFIX]                   
 
    [--request-format {json,xml}] [-D]   
 
    [-F FIELD]
 
</source>
 
|-
 
|<source lang="bash">
 
os cisco network profile update <profile>
 
    [--request-format {json,xml}]
 
</source>
 
|| no || ||
 
<source lang="bash">
 
neutron cisco-network-profile-update <profile>
 
    [--request-format {json,xml}]
 
</source>
 
|-
 
|<source lang="bash">
 
os cisco policy profile list
 
    [-f {csv,table}] [-c COLUMN]
 
    [--quote {all,minimal,none,nonnumeric}]
 
    [--request-format {json,xml}] [-D]
 
    [-F FIELD]
 
</source>
 
|| no || ||
 
<source lang="bash">
 
neutron cisco-policy-profile-list
 
    [-f {csv,table}] [-c COLUMN]
 
    [--quote {all,minimal,none,nonnumeric}]
 
    [--request-format {json,xml}] [-D]
 
    [-F FIELD]
 
</source>
 
|-
 
|<source lang="bash">
 
os cisco policy profile show <profile>
 
    [-f {shell,table}] [-c COLUMN]
 
    [--variable VARIABLE]               
 
    [--prefix PREFIX]                   
 
    [--request-format {json,xml}] [-D]   
 
    [-F FIELD]
 
</source>
 
|| no || ||
 
<source lang="bash">
 
neutron cisco-policy-profile-show <profile>
 
    [-f {shell,table}] [-c COLUMN]
 
    [--variable VARIABLE]               
 
    [--prefix PREFIX]                   
 
    [--request-format {json,xml}] [-D]   
 
    [-F FIELD]
 
</source>
 
|-
 
|<source lang="bash">
 
os cisco policy profile update <profile>
 
    [--request-format {json,xml}]
 
</source>
 
|| no || ||
 
<source lang="bash">
 
neutron cisco-policy-profile-update <profile>
 
    [--request-format {json,xml}]
 
</source>
 
|}
 
 
 
====DHCP====
 
 
 
Note: In general, should we support these generic -h and --request-format options from neutron.  i think not.
 
 
 
{| class="wikitable"
 
|-
 
! OSC Command !! Implemented !! !! Neutron command
 
|-
 
|<source lang="bash">
 
os dhcp agent list hosting net <network>
 
    [-f {csv,table}] [-c COLUMN]
 
    [--quote {all,minimal,none,nonnumeric}]
 
    [--request-format {json,xml}] [-D]   
 
    [-F FIELD]
 
</source>
 
|| no || ||
 
<source lang="bash">
 
neutron dhcp-agent-list-hosting-net <network>
 
    [-f {csv,table}] [-c COLUMN]
 
    [--quote {all,minimal,none,nonnumeric}]
 
    [--request-format {json,xml}] [-D]   
 
    [-F FIELD]
 
</source>
 
|-
 
|<source lang="bash">
 
os dhcp agent network add <dhcp_agent> <network>
 
  [--request-format {json,xml}]
 
</source>
 
|| no || ||
 
<source lang="bash">
 
neutron dhcp-agent-network-add <dhcp_agent> <network>
 
  [--request-format {json,xml}]
 
</source>
 
|-
 
|<source lang="bash">
 
os dhcp agent network delete <dhcp_agent> <network>
 
  [--request-format {json,xml}]
 
# Note: delete instead of remove
 
</source>
 
|| no || ||
 
<source lang="bash">
 
neutron dhcp-agent-network-remove <dhcp_agent> <network>
 
  [--request-format {json,xml}]
 
</source>
 
|}
 
 
 
====Extensions====
 
 
 
Note: Perhaps this would be a nice general feature.
 
 
 
{| class="wikitable"
 
|-
 
! OSC Command !! Implemented !! !! Neutron command
 
|-
 
|<source lang="bash">
 
os extension list [-f {csv,table}] [-c COLUMN]
 
    [--quote {all,minimal,none,nonnumeric}]
 
    [--request-format {json,xml}] [-D] [-F FIELD]
 
    # Note: Do we want to provide service as an option for this command?
 
    # Note: Renamed base command extension
 
</source>
 
|| no || ||
 
<source lang="bash">
 
neutron ext-list [-f {csv,table}] [-c COLUMN]
 
    [--quote {all,minimal,none,nonnumeric}]
 
    [--request-format {json,xml}] [-D] [-F FIELD]
 
</source>
 
|-
 
|<source lang="bash">
 
os extension show <extension> [-f {shell,table}] [-c COLUMN]
 
    [--variable VARIABLE] [--prefix PREFIX]
 
    [--request-format {json,xml}] [-D] [-F FIELD]
 
    # Note: Renamed base command extension
 
</source>
 
|| no || ||
 
<source lang="bash">
 
neutron ext-show <extension> [-f {shell,table}] [-c COLUMN]
 
    [--variable VARIABLE] [--prefix PREFIX]
 
    [--request-format {json,xml}] [-D] [-F FIELD]
 
</source>
 
|}
 
 
 
====Firewall====
 
{| class="wikitable"
 
|-
 
! OSC Command !! Implemented !! !! Neutron command
 
|-
 
|<source lang="bash">
 
os firewall create <policy>
 
    [-f {shell,table}] [-c COLUMN]
 
    [--variable VARIABLE] [--prefix PREFIX]
 
    [--request-format {json,xml}]
 
    [--tenant-id TENANT_ID] [--name NAME]
 
    [--description DESCRIPTION] [--shared]
 
    [--admin-state-down]
 
</source>
 
|| no || ||
 
<source lang="bash">
 
neutron firewall-create <policy>
 
    [-f {shell,table}] [-c COLUMN]
 
    [--variable VARIABLE] [--prefix PREFIX]
 
    [--request-format {json,xml}]
 
    [--tenant-id TENANT_ID] [--name NAME]
 
    [--description DESCRIPTION] [--shared]
 
    [--admin-state-down]
 
</source>
 
|-
 
|<source lang="bash">
 
os firewall delete <firewall>
 
    [--request-format {json,xml}]
 
</source>
 
|| no || ||
 
<source lang="bash">
 
neutron firewall-delete <firewall>
 
    [--request-format {json,xml}]
 
</source>
 
|-
 
|<source lang="bash">
 
os firewall list
 
    [-f {csv,table}] [-c COLUMN]
 
    [--quote {all,minimal,none,nonnumeric}]
 
    [--request-format {json,xml}] [-D] [-F FIELD]
 
    [-P SIZE] [--sort-key FIELD]
 
    [--sort-dir {asc,desc}]
 
</source>
 
|| no || ||
 
<source lang="bash">
 
neutron firewall-list
 
    [-f {csv,table}] [-c COLUMN]
 
    [--quote {all,minimal,none,nonnumeric}]
 
    [--request-format {json,xml}] [-D] [-F FIELD]
 
    [-P SIZE] [--sort-key FIELD]
 
    [--sort-dir {asc,desc}]
 
</source>
 
|-
 
|<source lang="bash">
 
os firewall policy create <name>
 
    [-f {shell,table}] [-c COLUMN]
 
    [--variable VARIABLE] [--prefix PREFIX]
 
    [--request-format {json,xml}]
 
    [--tenant-id TENANT_ID]
 
    [--description DESCRIPTION] [--shared]
 
    [--firewall-rules FIREWALL_RULES]
 
    [--audited]
 
</source>
 
|| no || ||
 
<source lang="bash">
 
neutron firewall-policy-create <name>
 
    [-f {shell,table}] [-c COLUMN]
 
    [--variable VARIABLE] [--prefix PREFIX]
 
    [--request-format {json,xml}]   
 
    [--tenant-id TENANT_ID]         
 
    [--description DESCRIPTION] [--shared]
 
    [--firewall-rules FIREWALL_RULES]
 
    [--audited]
 
</source>
 
|-
 
|<source lang="bash">
 
os firewall policy delete <policy>
 
    [--request-format {json,xml}]
 
</source>
 
|| no || ||
 
<source lang="bash">
 
neutron firewall-policy-delete <policy>
 
    [--request-format {json,xml}]
 
</source>
 
|-
 
|<source lang="bash">
 
os firewall policy rule add <policy> <rule>
 
    [--request-format {json,xml}]
 
    [--insert-before FIREWALL_RULE]
 
    [--insert-after FIREWALL_RULE]
 
    # Note: Command change
 
</source>
 
|| no || ||
 
<source lang="bash">
 
neutron firewall-policy-insert-rule <policy> <rule>
 
    [--request-format {json,xml}]
 
    [--insert-before FIREWALL_RULE]       
 
    [--insert-after FIREWALL_RULE]
 
</source>
 
|-
 
|<source lang="bash">
 
os firewall policy list
 
    [-f {csv,table}] [-c COLUMN]
 
    [--quote {all,minimal,none,nonnumeric}]
 
    [--request-format {json,xml}] [-D]
 
    [-F FIELD] [-P SIZE] [--sort-key FIELD]
 
    [--sort-dir {asc,desc}]
 
</source>
 
|| no || ||
 
<source lang="bash">
 
neutron firewall-policy-list
 
    [-f {csv,table}] [-c COLUMN]
 
    [--quote {all,minimal,none,nonnumeric}]
 
    [--request-format {json,xml}] [-D]
 
    [-F FIELD] [-P SIZE] [--sort-key FIELD]
 
    [--sort-dir {asc,desc}]
 
</source>
 
|-
 
|<source lang="bash">
 
os firewall policy rule remove <policy> <rule>
 
    [--request-format {json,xml}]
 
    # Note command change
 
</source>
 
|| no || ||
 
<source lang="bash">
 
neutron firewall-policy-remove-rule <policy> <rule>
 
    [--request-format {json,xml}]
 
</source>
 
|-
 
|<source lang="bash">
 
os firewall policy show <policy>
 
    [-f {shell,table}] [-c COLUMN]
 
    [--variable VARIABLE] [--prefix PREFIX]
 
    [--request-format {json,xml}] [-D]
 
    [-F FIELD]
 
</source>
 
|| no || ||
 
<source lang="bash">
 
neutron firewall-policy-show <policy>
 
    [-f {shell,table}] [-c COLUMN]
 
    [--variable VARIABLE] [--prefix PREFIX]
 
    [--request-format {json,xml}] [-D]
 
    [-F FIELD]
 
</source>
 
|-
 
|<source lang="bash">
 
os firewall policy update <policy>
 
    [--request-format {json,xml}]
 
</source>
 
|| no || ||
 
<source lang="bash">
 
neutron firewall-policy-update <policy>
 
    [--request-format {json,xml}]
 
</source>
 
|-
 
|<source lang="bash">
 
os firewall rule create
 
    [-f {shell,table}] [-c COLUMN]
 
    [--variable VARIABLE] [--prefix PREFIX]
 
    [--request-format {json,xml}]
 
    [--tenant-id TENANT_ID] [--name NAME]
 
    [--description DESCRIPTION] [--shared]
 
    [--source-ip-address SOURCE_IP_ADDRESS]
 
    [--destination-ip-address DESTINATION_IP_ADDRESS]
 
    [--source-port SOURCE_PORT]
 
    [--destination-port DESTINATION_PORT]
 
    [--disabled] --protocol {tcp,udp,icmp,any}
 
    --action {allow,deny}
 
</source>
 
|| no || ||
 
<source lang="bash">
 
neutron firewall-rule-create
 
    [-f {shell,table}] [-c COLUMN]
 
    [--variable VARIABLE] [--prefix PREFIX]
 
    [--request-format {json,xml}]
 
    [--tenant-id TENANT_ID] [--name NAME]
 
    [--description DESCRIPTION] [--shared]
 
    [--source-ip-address SOURCE_IP_ADDRESS]
 
    [--destination-ip-address DESTINATION_IP_ADDRESS]
 
    [--source-port SOURCE_PORT]
 
    [--destination-port DESTINATION_PORT]
 
    [--disabled] --protocol {tcp,udp,icmp,any}
 
    --action {allow,deny}
 
</source>
 
|-
 
|<source lang="bash">
 
os firewall rule delete <rule>
 
    [--request-format {json,xml}]
 
</source>
 
|| no || ||
 
<source lang="bash">
 
neutron firewall-rule-delete <rule>
 
    [--request-format {json,xml}]
 
</source>
 
|-
 
|<source lang="bash">
 
os firewall rule list
 
    [-f {csv,table}] [-c COLUMN]
 
    [--quote {all,minimal,none,nonnumeric}]
 
    [--request-format {json,xml}] [-D]
 
    [-F FIELD] [-P SIZE] [--sort-key FIELD]
 
    [--sort-dir {asc,desc}]
 
</source>
 
|| no || ||
 
<source lang="bash">
 
neutron firewall-rule-list
 
    [-f {csv,table}] [-c COLUMN]
 
    [--quote {all,minimal,none,nonnumeric}]
 
    [--request-format {json,xml}] [-D]
 
    [-F FIELD] [-P SIZE] [--sort-key FIELD]
 
    [--sort-dir {asc,desc}]
 
</source>
 
|-
 
|<source lang="bash">
 
os firewall rule show <rule>
 
    [-f {shell,table}] [-c COLUMN]
 
    [--variable VARIABLE] [--prefix PREFIX]
 
    [--request-format {json,xml}] [-D]
 
    [-F FIELD]
 
</source>
 
|| no || ||
 
<source lang="bash">
 
neutron firewall-rule-show <rule>
 
    [-f {shell,table}] [-c COLUMN]
 
    [--variable VARIABLE] [--prefix PREFIX]
 
    [--request-format {json,xml}] [-D]
 
    [-F FIELD]
 
</source>
 
|-
 
|<source lang="bash">
 
os firewall rule update <rule>
 
    [--request-format {json,xml}]
 
    [--protocol {tcp,udp,icmp,any}]
 
</source>
 
|| no || ||
 
<source lang="bash">
 
neutron firewall-rule-update <rule>
 
    [--request-format {json,xml}]
 
    [--protocol {tcp,udp,icmp,any}]
 
</source>
 
|-
 
|<source lang="bash">
 
os firewall show <firewall>
 
    [-f {shell,table}] [-c COLUMN]
 
    [--variable VARIABLE] [--prefix PREFIX]
 
    [--request-format {json,xml}] [-D] [-F FIELD]
 
</source>
 
|| no || ||
 
<source lang="bash">
 
neutron firewall-show <firewall>
 
    [-f {shell,table}] [-c COLUMN]
 
    [--variable VARIABLE] [--prefix PREFIX]
 
    [--request-format {json,xml}] [-D] [-F FIELD]
 
</source>
 
|-
 
|<source lang="bash">
 
os firewall update <firewall>
 
    [--request-format {json,xml}]
 
</source>
 
|| no || ||
 
<source lang="bash">
 
neutron firewall-update <firewall>
 
    [--request-format {json,xml}]
 
</source>
 
|}
 
 
 
====Floating IP====
 
 
 
Note: Do we need to have backward compatibility for older releases where compute controlled floating IPs? I think the latest compute still supports the old interface, but it would be best to discontinue use of that.  Should the command be floating-ip or floatingip?
 
 
 
{| class="wikitable"
 
|-
 
! OSC Command !! Implemented !! !! Neutron command
 
|-
 
|<source lang="bash">
 
os floatingip associate <ip> <port>
 
    [--request-format {json,xml}]
 
    [--fixed-ip-address FIXED_IP_ADDRESS]
 
</source>
 
|| no || ||
 
<source lang="bash">
 
neutron floatingip-associate <ip> <port>
 
    [--request-format {json,xml}]
 
    [--fixed-ip-address FIXED_IP_ADDRESS]
 
</source>
 
|-
 
|<source lang="bash">
 
os floatingip create <network>
 
    [-f {shell,table}] [-c COLUMN]
 
    [--variable VARIABLE] [--prefix PREFIX]
 
    [--request-format {json,xml}]
 
    [--tenant-id TENANT_ID] [--port-id PORT_ID]
 
    [--fixed-ip-address FIXED_IP_ADDRESS]
 
</source>
 
|| no || ||
 
<source lang="bash">
 
neutron floatingip-create <network>
 
    [-f {shell,table}] [-c COLUMN]
 
    [--variable VARIABLE] [--prefix PREFIX]
 
    [--request-format {json,xml}]
 
    [--tenant-id TENANT_ID] [--port-id PORT_ID]
 
    [--fixed-ip-address FIXED_IP_ADDRESS]
 
</source>
 
|-
 
|<source lang="bash">
 
os floatingip delete <ip>
 
    [--request-format {json,xml}] FLOATINGIP
 
</source>
 
|| no || ||
 
<source lang="bash">
 
neutron floatingip-delete <ip>
 
    [--request-format {json,xml}] FLOATINGIP
 
</source>
 
|-
 
|<source lang="bash">
 
os floatingip disassociate <ip>
 
    [--request-format {json,xml}]
 
</source>
 
|| no || ||
 
<source lang="bash">
 
neutron floatingip-disassociate <ip>
 
    [--request-format {json,xml}]
 
</source>
 
|-
 
|<source lang="bash">
 
os floatingip list
 
    [-f {csv,table}] [-c COLUMN]
 
    [--quote {all,minimal,none,nonnumeric}]
 
    [--request-format {json,xml}] [-D] [-F FIELD]
 
    [-P SIZE] [--sort-key FIELD]
 
    [--sort-dir {asc,desc}]
 
</source>
 
|| no || ||
 
<source lang="bash">
 
neutron floatingip-list
 
    [-f {csv,table}] [-c COLUMN]
 
    [--quote {all,minimal,none,nonnumeric}]
 
    [--request-format {json,xml}] [-D] [-F FIELD]
 
    [-P SIZE] [--sort-key FIELD]
 
    [--sort-dir {asc,desc}]
 
</source>
 
|-
 
|<source lang="bash">
 
os floatingip show <ip>
 
    [-f {shell,table}] [-c COLUMN]
 
    [--variable VARIABLE] [--prefix PREFIX]
 
    [--request-format {json,xml}] [-D] [-F FIELD]
 
</source>
 
|| no || ||
 
<source lang="bash">
 
neutron floatingip-show <ip>
 
    [-f {shell,table}] [-c COLUMN]
 
    [--variable VARIABLE] [--prefix PREFIX]
 
    [--request-format {json,xml}] [-D] [-F FIELD]
 
</source>
 
|}
 
 
 
====IPSec====
 
{| class="wikitable"
 
|-
 
! OSC Command !! Implemented !! !! Neutron command
 
|-
 
|<source lang="bash">
 
os ipsec site connection create
 
    [-f {shell,table}]
 
    [-c COLUMN] [--variable VARIABLE]
 
    [--prefix PREFIX]
 
    [--request-format {json,xml}]
 
    [--tenant-id TENANT_ID]
 
    [--admin-state-down] [--name NAME]
 
    [--description DESCRIPTION]
 
    [--mtu MTU]
 
    [--initiator {bi-directional,response-only}]
 
    [--dpd action=ACTION,interval=INTERVAL,timeout=TIMEOUT]
 
    --vpnservice-id VPNSERVICE
 
    --ikepolicy-id IKEPOLICY
 
    --ipsecpolicy-id IPSECPOLICY
 
    --peer-address PEER_ADDRESS
 
    --peer-id PEER_ID --peer-cidr
 
    PEER_CIDRS --psk PSK
 
</source>
 
|| no || ||
 
<source lang="bash">
 
neutron ipsec-site-connection-create
 
    [-f {shell,table}]
 
    [-c COLUMN] [--variable VARIABLE]     
 
    [--prefix PREFIX]                     
 
    [--request-format {json,xml}]
 
    [--tenant-id TENANT_ID]
 
    [--admin-state-down] [--name NAME]
 
    [--description DESCRIPTION]
 
    [--mtu MTU]
 
    [--initiator {bi-directional,response-only}]
 
    [--dpd action=ACTION,interval=INTERVAL,timeout=TIMEOUT]
 
    --vpnservice-id VPNSERVICE
 
    --ikepolicy-id IKEPOLICY
 
    --ipsecpolicy-id IPSECPOLICY
 
    --peer-address PEER_ADDRESS
 
    --peer-id PEER_ID --peer-cidr
 
    PEER_CIDRS --psk PSK
 
</source>
 
|-
 
|<source lang="bash">
 
os ipsec site connection delete <ipsecsite>
 
    [--request-format {json,xml}]
 
</source>
 
|| no || ||
 
<source lang="bash">
 
neutron ipsec-site-connection-delete <ipsecsite>
 
    [--request-format {json,xml}]
 
</source>
 
|-
 
|<source lang="bash">
 
os ipsec site connection list
 
    [-f {csv,table}] [-c COLUMN]
 
    [--quote {all,minimal,none,nonnumeric}]
 
    [--request-format {json,xml}] [-D]
 
    [-F FIELD] [-P SIZE]
 
    [--sort-key FIELD]
 
    [--sort-dir {asc,desc}]
 
</source>
 
|| no || ||
 
<source lang="bash">
 
neutron ipsec-site-connection-list
 
    [-f {csv,table}] [-c COLUMN]
 
    [--quote {all,minimal,none,nonnumeric}]
 
    [--request-format {json,xml}] [-D]   
 
    [-F FIELD] [-P SIZE]                 
 
    [--sort-key FIELD]                   
 
    [--sort-dir {asc,desc}]
 
</source>
 
|-
 
|<source lang="bash">
 
os ipsec site connection show <ipsecsite>
 
    [-f {shell,table}] [-c COLUMN]
 
    [--variable VARIABLE]
 
    [--prefix PREFIX]
 
    [--request-format {json,xml}] [-D]
 
    [-F FIELD]
 
</source>
 
|| no || ||
 
<source lang="bash">
 
neutron ipsec-site-connection-show <ipsecsite>
 
    [-f {shell,table}] [-c COLUMN]
 
    [--variable VARIABLE]
 
    [--prefix PREFIX]                   
 
    [--request-format {json,xml}] [-D]   
 
    [-F FIELD]
 
</source>
 
|-
 
|<source lang="bash">
 
os ipsec site connection update <ipsecsite>
 
    [--request-format {json,xml}]
 
    [--dpd action=ACTION,interval=INTERVAL,timeout=TIMEOUT]
 
</source>
 
|| no || ||
 
<source lang="bash">
 
neutron ipsec-site-connection-update <ipsecsite>
 
    [--request-format {json,xml}]
 
    [--dpd action=ACTION,interval=INTERVAL,timeout=TIMEOUT]
 
</source>
 
|}
 
 
 
====L3====
 
{| class="wikitable"
 
|-
 
! OSC Command !! Implemented !! !! Neutron command
 
|-
 
|<source lang="bash">
 
os l3 agent list hosting router <router>
 
    [-f {csv,table}] [-c COLUMN]
 
    [--quote {all,minimal,none,nonnumeric}]
 
    [--request-format {json,xml}] [-D]
 
    [-F FIELD]
 
</source>
 
|| no || ||
 
<source lang="bash">
 
neutron l3-agent-list-hosting-router <router>
 
    [-f {csv,table}] [-c COLUMN]
 
    [--quote {all,minimal,none,nonnumeric}]
 
    [--request-format {json,xml}] [-D]     
 
    [-F FIELD]
 
</source>
 
|-
 
|<source lang="bash">
 
os l3 agent router add <l3_agent> <router>
 
    [--request-format {json,xml}]
 
</source>
 
|| no || ||
 
<source lang="bash">
 
neutron l3-agent-router-add <l3_agent> <router>
 
    [--request-format {json,xml}]
 
</source>
 
|-
 
|<source lang="bash">
 
os l3 agent router remove <l3_agent> <router>
 
    [--request-format {json,xml}]
 
</source>
 
|| no || ||
 
<source lang="bash">
 
neutron l3-agent-router-remove <l3_agent> <router>
 
    [--request-format {json,xml}]
 
</source>
 
|}
 
 
 
====Load Balancer====
 
{| class="wikitable"
 
|-
 
! OSC Command !! Implemented !! !! Neutron command
 
|-
 
|<source lang="bash">
 
os lb healthmonitor add <healthmonitor> <pool>
 
    [--request-format {json,xml}]
 
    # Note command change
 
</source>
 
|| no || ||
 
<source lang="bash">
 
neutron lb-healthmonitor-associate <healthmonitor> <pool>
 
    [--request-format {json,xml}]
 
</source>
 
|-
 
|<source lang="bash">
 
os lb healthmonitor create
 
    [-f {shell,table}] [-c COLUMN]
 
    [--variable VARIABLE] [--prefix PREFIX]
 
    [--request-format {json,xml}]
 
    [--tenant-id TENANT_ID]
 
    [--admin-state-down]
 
    [--expected-codes EXPECTED_CODES]
 
    [--http-method HTTP_METHOD]
 
    [--url-path URL_PATH] --delay DELAY
 
    --max-retries MAX_RETRIES --timeout
 
    TIMEOUT --type {PING,TCP,HTTP,HTTPS}
 
</source>
 
|| no || ||
 
<source lang="bash">
 
neutron lb-healthmonitor-create
 
    [-f {shell,table}] [-c COLUMN]
 
    [--variable VARIABLE] [--prefix PREFIX]
 
    [--request-format {json,xml}]
 
    [--tenant-id TENANT_ID]
 
    [--admin-state-down]
 
    [--expected-codes EXPECTED_CODES]
 
    [--http-method HTTP_METHOD]
 
    [--url-path URL_PATH] --delay DELAY
 
    --max-retries MAX_RETRIES --timeout
 
    TIMEOUT --type {PING,TCP,HTTP,HTTPS}
 
</source>
 
|-
 
|<source lang="bash">
 
os lb healthmonitor delete <healthmonitor>
 
    [--request-format {json,xml}]
 
</source>
 
|| no || ||
 
<source lang="bash">
 
neutron lb-healthmonitor-delete <healthmonitor>
 
    [--request-format {json,xml}]
 
</source>
 
|-
 
|<source lang="bash">
 
os lb healthmonitor remove <healthmonitor> <pool>
 
    [--request-format {json,xml}]
 
    # Note command change
 
</source>
 
|| no || ||
 
<source lang="bash">
 
neutron lb-healthmonitor-disassociate <healthmonitor> <pool>
 
    [--request-format {json,xml}]
 
</source>
 
|-
 
|<source lang="bash">
 
os lb healthmonitor list
 
    [-f {csv,table}] [-c COLUMN]
 
    [--quote {all,minimal,none,nonnumeric}]
 
    [--request-format {json,xml}] [-D]
 
    [-F FIELD] [-P SIZE] [--sort-key FIELD]
 
    [--sort-dir {asc,desc}]
 
</source>
 
|| no || ||
 
<source lang="bash">
 
neutron lb-healthmonitor-list
 
    [-f {csv,table}] [-c COLUMN]
 
    [--quote {all,minimal,none,nonnumeric}]
 
    [--request-format {json,xml}] [-D]
 
    [-F FIELD] [-P SIZE] [--sort-key FIELD]
 
    [--sort-dir {asc,desc}]
 
</source>
 
|-
 
|<source lang="bash">
 
os lb healthmonitor show <healthmonitor>
 
    [-f {shell,table}] [-c COLUMN]
 
    [--variable VARIABLE] [--prefix PREFIX]
 
    [--request-format {json,xml}] [-D]
 
    [-F FIELD]
 
</source>
 
|| no || ||
 
<source lang="bash">
 
neutron lb-healthmonitor-show <healthmonitor>
 
    [-f {shell,table}] [-c COLUMN]
 
    [--variable VARIABLE] [--prefix PREFIX]
 
    [--request-format {json,xml}] [-D]
 
    [-F FIELD]
 
</source>
 
|-
 
|<source lang="bash">
 
os lb healthmonitor update <healthmonitor>
 
    [--request-format {json,xml}]
 
</source>
 
|| no || ||
 
<source lang="bash">
 
neutron lb-healthmonitor-update <healthmonitor>
 
    [--request-format {json,xml}]
 
</source>
 
|-
 
|<source lang="bash">
 
os lb member create <pool>
 
    [-f {shell,table}] [-c COLUMN]
 
    [--variable VARIABLE] [--prefix PREFIX]
 
    [--request-format {json,xml}]
 
    [--tenant-id TENANT_ID] [--admin-state-down]
 
    [--weight WEIGHT] --address ADDRESS
 
    --protocol-port PROTOCOL_PORT
 
</source>
 
|| no || ||
 
<source lang="bash">
 
neutron lb-member-create <pool>
 
    [-f {shell,table}] [-c COLUMN]
 
    [--variable VARIABLE] [--prefix PREFIX]
 
    [--request-format {json,xml}]
 
    [--tenant-id TENANT_ID] [--admin-state-down]
 
    [--weight WEIGHT] --address ADDRESS
 
    --protocol-port PROTOCOL_PORT
 
</source>
 
|-
 
|<source lang="bash">
 
os lb member delete <member>
 
    [--request-format {json,xml}]
 
</source>
 
|| no || ||
 
<source lang="bash">
 
neutron lb-member-delete <member>
 
    [--request-format {json,xml}]
 
</source>
 
|-
 
|<source lang="bash">
 
os lb member list
 
    [-f {csv,table}] [-c COLUMN]
 
    [--quote {all,minimal,none,nonnumeric}]
 
    [--request-format {json,xml}] [-D] [-F FIELD]
 
    [-P SIZE] [--sort-key FIELD]
 
    [--sort-dir {asc,desc}]
 
</source>
 
|| no || ||
 
<source lang="bash">
 
neutron lb-member-list
 
    [-f {csv,table}] [-c COLUMN]
 
    [--quote {all,minimal,none,nonnumeric}]
 
    [--request-format {json,xml}] [-D] [-F FIELD]
 
    [-P SIZE] [--sort-key FIELD]
 
    [--sort-dir {asc,desc}]
 
</source>
 
|-
 
|<source lang="bash">
 
os lb member show <member>
 
    [-f {shell,table}] [-c COLUMN]
 
    [--variable VARIABLE] [--prefix PREFIX]
 
    [--request-format {json,xml}] [-D] [-F FIELD]
 
</source>
 
|| no || ||
 
<source lang="bash">
 
neutron lb-member-show <member>
 
    [-f {shell,table}] [-c COLUMN]
 
    [--variable VARIABLE] [--prefix PREFIX]
 
    [--request-format {json,xml}] [-D] [-F FIELD]
 
</source>
 
|-
 
|<source lang="bash">
 
os lb member update <member>
 
    [--request-format {json,xml}]
 
</source>
 
|| no || ||
 
<source lang="bash">
 
neutron lb-member-update <member>
 
    [--request-format {json,xml}]
 
</source>
 
|-
 
|<source lang="bash">
 
os lb pool create
 
    [-f {shell,table}] [-c COLUMN]
 
    [--variable VARIABLE] [--prefix PREFIX]
 
    [--request-format {json,xml}]
 
    [--tenant-id TENANT_ID] [--admin-state-down]
 
    [--description DESCRIPTION] --lb-method
 
    {ROUND_ROBIN,LEAST_CONNECTIONS,SOURCE_IP} --name
 
    NAME --protocol {HTTP,HTTPS,TCP} --subnet-id
 
    SUBNET [--provider PROVIDER]
 
</source>
 
|| no || ||
 
<source lang="bash">
 
neutron lb-pool-create
 
    [-f {shell,table}] [-c COLUMN]
 
    [--variable VARIABLE] [--prefix PREFIX]
 
    [--request-format {json,xml}]
 
    [--tenant-id TENANT_ID] [--admin-state-down]
 
    [--description DESCRIPTION] --lb-method
 
    {ROUND_ROBIN,LEAST_CONNECTIONS,SOURCE_IP} --name
 
    NAME --protocol {HTTP,HTTPS,TCP} --subnet-id
 
    SUBNET [--provider PROVIDER]
 
</source>
 
|-
 
|<source lang="bash">
 
os lb pool delete <pool>
 
    [--request-format {json,xml}]
 
</source>
 
|| no || ||
 
<source lang="bash">
 
neutron lb-pool-delete <pool>
 
    [--request-format {json,xml}]
 
</source>
 
|-
 
|<source lang="bash">
 
os lb pool list
 
    [-f {csv,table}] [-c COLUMN]
 
    [--quote {all,minimal,none,nonnumeric}]
 
    [--request-format {json,xml}] [-D] [-F FIELD]
 
    [-P SIZE] [--sort-key FIELD]
 
    [--sort-dir {asc,desc}]
 
</source>
 
|| no || ||
 
<source lang="bash">
 
neutron lb-pool-list
 
    [-f {csv,table}] [-c COLUMN]
 
    [--quote {all,minimal,none,nonnumeric}]
 
    [--request-format {json,xml}] [-D] [-F FIELD]
 
    [-P SIZE] [--sort-key FIELD]
 
    [--sort-dir {asc,desc}]
 
</source>
 
|-
 
|<source lang="bash">
 
os lb pool list on agent <lbaas_agent>
 
    [-f {csv,table}] [-c COLUMN]
 
    [--quote {all,minimal,none,nonnumeric}]
 
    [--request-format {json,xml}] [-D]
 
    [-F FIELD]
 
    # Note another oddball command
 
</source>
 
|| no || ||
 
<source lang="bash">
 
neutron lb-pool-list-on-agent <lbaas_agent>
 
    [-f {csv,table}] [-c COLUMN]
 
    [--quote {all,minimal,none,nonnumeric}]
 
    [--request-format {json,xml}] [-D]
 
    [-F FIELD]
 
# Note another one of those oddball commands
 
</source>
 
|-
 
|<source lang="bash">
 
os lb pool show <pool>
 
    [-f {shell,table}] [-c COLUMN]
 
    [--variable VARIABLE] [--prefix PREFIX]
 
    [--request-format {json,xml}] [-D] [-F FIELD]
 
</source>
 
|| no || ||
 
<source lang="bash">
 
neutron lb-pool-show <pool>
 
    [-f {shell,table}] [-c COLUMN]
 
    [--variable VARIABLE] [--prefix PREFIX]
 
    [--request-format {json,xml}] [-D] [-F FIELD]
 
</source>
 
|-
 
|<source lang="bash">
 
os lb pool stats <pool>
 
    [-f {shell,table}] [-c COLUMN]
 
    [--variable VARIABLE] [--prefix PREFIX]
 
    [--request-format {json,xml}] [-D] [-F FIELD]
 
</source>
 
|| no || ||
 
<source lang="bash">
 
neutron lb-pool-stats <pool>
 
    [-f {shell,table}] [-c COLUMN]
 
    [--variable VARIABLE] [--prefix PREFIX]
 
    [--request-format {json,xml}] [-D] [-F FIELD]
 
</source>
 
|-
 
|<source lang="bash">
 
os lb pool update <pool>
 
    [--request-format {json,xml}]
 
</source>
 
|| no || ||
 
<source lang="bash">
 
neutron lb-pool-update <pool>
 
    [--request-format {json,xml}]
 
</source>
 
|-
 
|<source lang="bash">
 
os lb vip create <pool>
 
    [-f {shell,table}] [-c COLUMN]
 
    [--variable VARIABLE] [--prefix PREFIX]
 
    [--request-format {json,xml}]
 
    [--tenant-id TENANT_ID] [--address ADDRESS]
 
    [--admin-state-down]
 
    [--connection-limit CONNECTION_LIMIT]
 
    [--description DESCRIPTION] --name NAME
 
    --protocol-port PROTOCOL_PORT --protocol
 
    {TCP,HTTP,HTTPS} --subnet-id SUBNET
 
</source>
 
|| no || ||
 
<source lang="bash">
 
neutron lb-vip-create <pool>
 
    [-f {shell,table}] [-c COLUMN]
 
    [--variable VARIABLE] [--prefix PREFIX]
 
    [--request-format {json,xml}]
 
    [--tenant-id TENANT_ID] [--address ADDRESS]
 
    [--admin-state-down]   
 
    [--connection-limit CONNECTION_LIMIT]
 
    [--description DESCRIPTION] --name NAME
 
    --protocol-port PROTOCOL_PORT --protocol
 
    {TCP,HTTP,HTTPS} --subnet-id SUBNET
 
</source>
 
|-
 
|<source lang="bash">
 
os lb vip delete <vip>
 
    [--request-format {json,xml}]
 
</source>
 
|| no || ||
 
<source lang="bash">
 
neutron lb-vip-delete <vip>
 
    [--request-format {json,xml}]
 
</source>
 
|-
 
|<source lang="bash">
 
os lb vip list
 
    [-f {csv,table}] [-c COLUMN]
 
    [--quote {all,minimal,none,nonnumeric}]
 
    [--request-format {json,xml}] [-D] [-F FIELD]
 
    [-P SIZE] [--sort-key FIELD]
 
    [--sort-dir {asc,desc}]
 
</source>
 
|| no || ||
 
<source lang="bash">
 
neutron lb-vip-list
 
    [-f {csv,table}] [-c COLUMN]
 
    [--quote {all,minimal,none,nonnumeric}]
 
    [--request-format {json,xml}] [-D] [-F FIELD]
 
    [-P SIZE] [--sort-key FIELD]
 
    [--sort-dir {asc,desc}]
 
</source>
 
|-
 
|<source lang="bash">
 
os lb vip show <vip>
 
    [-f {shell,table}] [-c COLUMN]
 
    [--variable VARIABLE] [--prefix PREFIX]
 
    [--request-format {json,xml}] [-D] [-F FIELD]
 
</source>
 
|| no || ||
 
<source lang="bash">
 
neutron lb-vip-show <vip>
 
    [-f {shell,table}] [-c COLUMN]
 
    [--variable VARIABLE] [--prefix PREFIX]
 
    [--request-format {json,xml}] [-D] [-F FIELD]
 
</source>
 
|-
 
|<source lang="bash">
 
os lb vip update <vip>
 
    [--request-format {json,xml}]
 
</source>
 
|| no || ||
 
<source lang="bash">
 
neutron lb-vip-update <vip>
 
    [--request-format {json,xml}]
 
</source>
 
|-
 
|<source lang="bash">
 
os lb agent hosting pool <pool>
 
    [-f {csv,table}] [-c COLUMN]
 
    [--quote {all,minimal,none,nonnumeric}]
 
    [--request-format {json,xml}] [-D]
 
    [-F FIELD]
 
    # Note: oddball command name
 
</source>
 
|| no || ||
 
<source lang="bash">
 
neutron lb-agent-hosting-pool <pool>
 
    [-f {csv,table}] [-c COLUMN]
 
    [--quote {all,minimal,none,nonnumeric}]
 
    [--request-format {json,xml}] [-D]
 
    [-F FIELD]
 
</source>
 
|}
 
 
 
====Network====
 
 
 
# Note name changes from net to netowork
 
 
 
{| class="wikitable"
 
|-
 
! OSC Command !! Implemented !! !! Neutron command
 
|-
 
|<source lang="bash">
 
os network create <name>
 
    [-f {shell,table}] [-c COLUMN]
 
    [--variable VARIABLE] [--prefix PREFIX]
 
    [--request-format {json,xml}]
 
    [--tenant-id TENANT_ID] [--admin-state-down]
 
    [--shared]
 
</source>
 
|| no || ||
 
<source lang="bash">
 
neutron net-create <name>
 
    [-f {shell,table}] [-c COLUMN]
 
    [--variable VARIABLE] [--prefix PREFIX]
 
    [--request-format {json,xml}]
 
    [--tenant-id TENANT_ID] [--admin-state-down]
 
    [--shared]
 
</source>
 
|-
 
|<source lang="bash">
 
os network delete <network>
 
    [--request-format {json,xml}]
 
</source>
 
|| no || ||
 
<source lang="bash">
 
neutron net-delete <network>
 
    [--request-format {json,xml}]
 
</source>
 
|-
 
|<source lang="bash">
 
os network external list
 
    [-f {csv,table}] [-c COLUMN]
 
    [--quote {all,minimal,none,nonnumeric}]
 
    [--request-format {json,xml}] [-D] [-F FIELD]
 
    [-P SIZE] [--sort-key FIELD]
 
    [--sort-dir {asc,desc}]
 
# Note another oddball command
 
</source>
 
|| no || ||
 
<source lang="bash">
 
neutron net-external-list
 
    [-f {csv,table}] [-c COLUMN]
 
    [--quote {all,minimal,none,nonnumeric}]
 
    [--request-format {json,xml}] [-D] [-F FIELD]
 
    [-P SIZE] [--sort-key FIELD]
 
    [--sort-dir {asc,desc}]
 
</source>
 
|-
 
|<source lang="bash">
 
os network list
 
    [-f {csv,table}] [-c COLUMN]
 
    [--quote {all,minimal,none,nonnumeric}]
 
    [--request-format {json,xml}] [-D] [-F FIELD]
 
    [-P SIZE] [--sort-key FIELD] [--sort-dir {asc,desc}]
 
</source>
 
|| no || ||
 
<source lang="bash">
 
neutron net-list
 
    [-f {csv,table}] [-c COLUMN]
 
    [--quote {all,minimal,none,nonnumeric}]
 
    [--request-format {json,xml}] [-D] [-F FIELD]
 
    [-P SIZE] [--sort-key FIELD] [--sort-dir {asc,desc}]
 
</source>
 
|-
 
|<source lang="bash">
 
os network list on dhcp agent <dhcp_agent>
 
    [-f {csv,table}] [-c COLUMN]
 
    [--quote {all,minimal,none,nonnumeric}]
 
    [--request-format {json,xml}] [-D]
 
    [-F FIELD] [-P SIZE] [--sort-key FIELD]
 
    [--sort-dir {asc,desc}]
 
</source>
 
|| no || ||
 
<source lang="bash">
 
neutron net-list-on-dhcp-agent <dhcp_agent>
 
    [-f {csv,table}] [-c COLUMN]
 
    [--quote {all,minimal,none,nonnumeric}]
 
    [--request-format {json,xml}] [-D]
 
    [-F FIELD] [-P SIZE] [--sort-key FIELD]
 
    [--sort-dir {asc,desc}]
 
# Note another one of those oddball commands
 
</source>
 
|-
 
|<source lang="bash">
 
os network show <network>
 
    [-f {shell,table}] [-c COLUMN]
 
    [--variable VARIABLE] [--prefix PREFIX]
 
    [--request-format {json,xml}] [-D] [-F FIELD]
 
</source>
 
|| no || ||
 
<source lang="bash">
 
neutron net-show <network>
 
    [-f {shell,table}] [-c COLUMN]
 
    [--variable VARIABLE] [--prefix PREFIX]
 
    [--request-format {json,xml}] [-D] [-F FIELD]
 
</source>
 
|-
 
|<source lang="bash">
 
os network update <network>
 
    [--request-format {json,xml}]
 
</source>
 
|| no || ||
 
<source lang="bash">
 
neutron net-update <network>
 
    [--request-format {json,xml}]
 
</source>
 
|}
 
 
 
====Network Gateway====
 
 
 
Note: change from net to network
 
 
 
{| class="wikitable"
 
|-
 
! OSC Command !! Implemented !! !! Neutron command
 
|-
 
|<source lang="bash">
 
os network gateway connect <gateway> <network>
 
    [--request-format {json,xml}]
 
    [--segmentation-type SEGMENTATION_TYPE]
 
    [--segmentation-id SEGMENTATION_ID]
 
# Note technicall wrong verb here, but add/remove
 
# seems a little odd
 
</source>
 
|| no || ||
 
<source lang="bash">
 
neutron net-gateway-connect <gateway> <network>
 
    [--request-format {json,xml}]
 
    [--segmentation-type SEGMENTATION_TYPE]
 
    [--segmentation-id SEGMENTATION_ID]
 
</source>
 
|-
 
|<source lang="bash">
 
os network gateway create <name>
 
    [-f {shell,table}] [-c COLUMN]
 
    [--variable VARIABLE] [--prefix PREFIX]
 
    [--request-format {json,xml}]
 
    [--tenant-id TENANT_ID] [--device DEVICE]
 
</source>
 
|| no || ||
 
<source lang="bash">
 
neutron net-gateway-create <name>
 
    [-f {shell,table}] [-c COLUMN]
 
    [--variable VARIABLE] [--prefix PREFIX]
 
    [--request-format {json,xml}]
 
    [--tenant-id TENANT_ID] [--device DEVICE]
 
</source>
 
|-
 
|<source lang="bash">
 
os network gateway delete <gateway>
 
    [--request-format {json,xml}]
 
</source>
 
|| no || ||
 
<source lang="bash">
 
neutron net-gateway-delete <gateway>
 
    [--request-format {json,xml}]
 
</source>
 
|-
 
|<source lang="bash">
 
os network gateway disconnect <gateway> <network>
 
    [--request-format {json,xml}]
 
    [--segmentation-type SEGMENTATION_TYPE]
 
    [--segmentation-id SEGMENTATION_ID]
 
# Note technicall wrong verb here, but add/remove
 
# seems a little odd
 
</source>
 
|| no || ||
 
<source lang="bash">
 
neutron net-gateway-disconnect <gateway> <network>
 
    [--request-format {json,xml}]
 
    [--segmentation-type SEGMENTATION_TYPE]
 
    [--segmentation-id SEGMENTATION_ID]
 
</source>
 
|-
 
|<source lang="bash">
 
os network gateway list
 
    [-f {csv,table}] [-c COLUMN]
 
    [--quote {all,minimal,none,nonnumeric}]
 
    [--request-format {json,xml}] [-D] [-F FIELD]
 
</source>
 
|| no || ||
 
<source lang="bash">
 
neutron net-gateway-list
 
    [-f {csv,table}] [-c COLUMN]
 
    [--quote {all,minimal,none,nonnumeric}]
 
    [--request-format {json,xml}] [-D] [-F FIELD]
 
</source>
 
|-
 
|<source lang="bash">
 
os network gateway show <gateway>
 
    [-f {shell,table}] [-c COLUMN]
 
    [--variable VARIABLE] [--prefix PREFIX]
 
    [--request-format {json,xml}] [-D] [-F FIELD]
 
</source>
 
|| no || ||
 
<source lang="bash">
 
neutron net-gateway-show <gateway>
 
    [-f {shell,table}] [-c COLUMN]
 
    [--variable VARIABLE] [--prefix PREFIX]
 
    [--request-format {json,xml}] [-D] [-F FIELD]
 
</source>
 
|-
 
|<source lang="bash">
 
os network gateway update <gateway>
 
    [--request-format {json,xml}]
 
</source>
 
|| no || ||
 
<source lang="bash">
 
neutron net-gateway-update <gateway>
 
    [--request-format {json,xml}]
 
</source>
 
|}
 
 
 
====Port====
 
 
 
{| class="wikitable"
 
|-
 
! OSC Command !! Implemented !! !! Neutron command
 
|-
 
|<source lang="bash">
 
os port create <network>
 
  [--tenant-id TENANT_ID]
 
  [--name NAME]
 
  [--admin-state-down]
 
  [--mac-address MAC_ADDRESS]
 
  [--device-id DEVICE_ID]
 
  [--fixed-ip ip_address=IP_ADDR]
 
  [--security-group SECURITY_GROUP]
 
  [--no-security-groups]
 
  [--extra-dhcp-opt EXTRA_DHCP_OPTS]
 
</source>
 
|| no || ||
 
<source lang="bash">
 
neutron port-create <network>
 
  [--tenant-id TENANT_ID]
 
  [--name NAME]
 
  [--admin-state-down]
 
  [--mac-address MAC_ADDRESS]
 
  [--device-id DEVICE_ID]
 
  [--fixed-ip ip_address=IP_ADDR]
 
  [--security-group SECURITY_GROUP]
 
  [--no-security-groups]
 
  [--extra-dhcp-opt EXTRA_DHCP_OPTS]
 
</source>
 
|-
 
|
 
<source lang="bash">
 
os port delete <port>
 
</source>
 
|| no || ||
 
<source lang="bash">
 
neutron port-delete <port>
 
</source>
 
|-
 
|
 
<source lang="bash">
 
os port list
 
  [-D, --show-details]
 
  [-F FIELD, --field FIELD]
 
  [-P SIZE, --page-size SIZE]
 
  [--sort-key FIELD]
 
  [--sort-dir {asc,desc}]
 
  [-f {csv,table}, --format {csv,table}]
 
  [-c COLUMN, --column COLUMN]
 
  [--quote {all,minimal,none,nonnumeric}]
 
</source>
 
|| no || ||
 
<source lang="bash">
 
neutron port-list
 
  [-D, --show-details]
 
  [-F FIELD, --field FIELD]
 
  [-P SIZE, --page-size SIZE]
 
  [--sort-key FIELD]
 
  [--sort-dir {asc,desc}]
 
  [-f {csv,table}, --format {csv,table}]
 
  [-c COLUMN, --column COLUMN]
 
  [--quote {all,minimal,none,nonnumeric}]
 
</source>
 
|-
 
|
 
<source lang="bash">
 
os port show <port>
 
  [-D, --show-details]
 
  [-F FIELD, --field FIELD]
 
  [-f {shell,table}, --format {shell,table}]
 
  [-c COLUMN, --column COLUMN]
 
  [-variable VARIABLE]
 
  [--prefix PREFIX]
 
</source>
 
|| no || ||
 
<source lang="bash">
 
neutron port-show <port>
 
  [-D, --show-details]
 
  [-F FIELD, --field FIELD]
 
  [-f {shell,table}, --format {shell,table}]
 
  [-c COLUMN, --column COLUMN]
 
  [-variable VARIABLE]
 
  [--prefix PREFIX]
 
</source>
 
|-
 
|
 
<source lang="bash">
 
os port update <port>
 
  [--security-group SECURITY_GROUP]
 
  [--no-security-groups]
 
  [--extra-dhcp-opt EXTRA_DHCP_OPTS]
 
</source>
 
|| no || ||
 
<source lang="bash">
 
neutron port-update <port>
 
  [--security-group SECURITY_GROUP]
 
  [--no-security-groups]
 
  [--extra-dhcp-opt EXTRA_DHCP_OPTS]
 
</source>
 
|}
 
 
 
====Queue====
 
{| class="wikitable"
 
|-
 
! OSC Command !! Implemented !! !! Neutron command
 
|-
 
|<source lang="bash">
 
os queue create <name>
 
    [-f {shell,table}] [-c COLUMN]
 
    [--variable VARIABLE] [--prefix PREFIX]
 
    [--request-format {json,xml}]
 
    [--tenant-id TENANT_ID] [--min MIN] [--max MAX]
 
    [--qos-marking QOS_MARKING] [--default DEFAULT]
 
    [--dscp DSCP]
 
</source>
 
|| no || ||
 
<source lang="bash">
 
neutron queue-create <name>
 
    [-f {shell,table}] [-c COLUMN]
 
    [--variable VARIABLE] [--prefix PREFIX]
 
    [--request-format {json,xml}]
 
    [--tenant-id TENANT_ID] [--min MIN] [--max MAX]
 
    [--qos-marking QOS_MARKING] [--default DEFAULT]
 
    [--dscp DSCP]
 
</source>
 
|-
 
|<source lang="bash">
 
os queue delete <queue>
 
    [--request-format {json,xml}]
 
</source>
 
|| no || ||
 
<source lang="bash">
 
neutron queue-delete <queue>
 
    [--request-format {json,xml}]
 
</source>
 
|-
 
|<source lang="bash">
 
os queue list
 
    [-f {csv,table}] [-c COLUMN]
 
    [--quote {all,minimal,none,nonnumeric}]
 
    [--request-format {json,xml}] [-D] [-F FIELD]
 
</source>
 
|| no || ||
 
<source lang="bash">
 
neutron queue-list
 
    [-f {csv,table}] [-c COLUMN]
 
    [--quote {all,minimal,none,nonnumeric}]
 
    [--request-format {json,xml}] [-D] [-F FIELD]
 
</source>
 
|-
 
|<source lang="bash">
 
os queue show <queue>
 
    [-f {shell,table}] [-c COLUMN]
 
    [--variable VARIABLE] [--prefix PREFIX]
 
    [--request-format {json,xml}] [-D] [-F FIELD]
 
</source>
 
|| no || ||
 
<source lang="bash">
 
neutron queue-show <queue>
 
    [-f {shell,table}] [-c COLUMN]
 
    [--variable VARIABLE] [--prefix PREFIX]
 
    [--request-format {json,xml}] [-D] [-F FIELD]
 
</source>
 
|}
 
 
 
====Quota====
 
 
 
Note: See [[#quota|quota]] in the [[#Cross_API|cross API section]].
 
 
 
{| class="wikitable"
 
|-
 
! OSC Command !! Implemented !! !! Neutron command
 
|-
 
|<source lang="bash">
 
</source>
 
|| no || ||
 
<source lang="bash">
 
neutron quota-delete
 
    [--request-format {json,xml}]
 
    [--tenant-id tenant-id]
 
</source>
 
|-
 
|<source lang="bash">
 
</source>
 
|| no || ||
 
<source lang="bash">
 
neutron quota-list
 
    [-f {csv,table}] [-c COLUMN]
 
    [--quote {all,minimal,none,nonnumeric}]
 
    [--request-format {json,xml}]
 
</source>
 
|-
 
|<source lang="bash">
 
</source>
 
|| no || ||
 
<source lang="bash">
 
neutron quota-show
 
    [-f {shell,table}] [-c COLUMN]
 
    [--variable VARIABLE] [--prefix PREFIX]
 
    [--request-format {json,xml}]
 
    [--tenant-id tenant-id]
 
</source>
 
|-
 
|<source lang="bash">
 
</source>
 
|| no || ||
 
<source lang="bash">
 
neutron quota-update
 
    [-f {shell,table}] [-c COLUMN]
 
    [--variable VARIABLE] [--prefix PREFIX]
 
    [--request-format {json,xml}]
 
    [--tenant-id tenant-id] [--network networks]
 
    [--subnet subnets] [--port ports]
 
    [--router routers] [--floatingip floatingips]
 
    [--security-group security_groups]
 
    [--security-group-rule security_group_rules]
 
</source>
 
|}
 
 
 
====Router====
 
{| class="wikitable"
 
|-
 
! OSC Command !! Implemented !! !! Neutron command
 
|-
 
|<source lang="bash">
 
os router create <name>
 
    [-f {shell,table}] [-c COLUMN]
 
    [--variable VARIABLE] [--prefix PREFIX]
 
    [--request-format {json,xml}]
 
    [--tenant-id TENANT_ID] [--admin-state-down]
 
</source>
 
|| no || ||
 
<source lang="bash">
 
neutron router-create <name>
 
    [-f {shell,table}] [-c COLUMN]
 
    [--variable VARIABLE] [--prefix PREFIX]
 
    [--request-format {json,xml}]
 
    [--tenant-id TENANT_ID] [--admin-state-down]
 
</source>
 
|-
 
|<source lang="bash">
 
os router delete <router>
 
    [--request-format {json,xml}]
 
</source>
 
|| no || ||
 
<source lang="bash">
 
neutron router-delete <router>
 
    [--request-format {json,xml}]
 
</source>
 
|-
 
|<source lang="bash">
 
os router gateway remove <router>
 
    [--request-format {json,xml}]
 
    # Note name change
 
</source>
 
|| no || ||
 
<source lang="bash">
 
neutron router-gateway-clear <router>
 
    [--request-format {json,xml}]
 
</source>
 
|-
 
|<source lang="bash">
 
os router gateway add <router> <network>
 
    [--request-format {json,xml}]
 
    [--disable-snat]
 
    # Note name change
 
</source>
 
|| no || ||
 
<source lang="bash">
 
neutron router-gateway-set <router> <network>
 
    [--request-format {json,xml}]
 
    [--disable-snat]
 
</source>
 
|-
 
|<source lang="bash">
 
os router interface add <router> <interface>
 
    [--request-format {json,xml}]
 
</source>
 
|| no || ||
 
<source lang="bash">
 
neutron router-interface-add <router> <interface>
 
    [--request-format {json,xml}]
 
 
 
</source>
 
|-
 
|<source lang="bash">
 
os router interface remove <router> <interface>
 
    [--request-format {json,xml}]
 
    # Note name change
 
</source>
 
|| no || ||
 
<source lang="bash">
 
neutron router-interface-delete <router> <interface>
 
    [--request-format {json,xml}]
 
</source>
 
|-
 
|<source lang="bash">
 
os router list
 
    [-f {csv,table}] [-c COLUMN]
 
    [--quote {all,minimal,none,nonnumeric}]
 
    [--request-format {json,xml}] [-D] [-F FIELD]
 
    [-P SIZE] [--sort-key FIELD]
 
    [--sort-dir {asc,desc}]
 
</source>
 
|| no || ||
 
<source lang="bash">
 
neutron router-list
 
    [-f {csv,table}] [-c COLUMN]
 
    [--quote {all,minimal,none,nonnumeric}]
 
    [--request-format {json,xml}] [-D] [-F FIELD]
 
    [-P SIZE] [--sort-key FIELD]
 
    [--sort-dir {asc,desc}]
 
</source>
 
|-
 
|<source lang="bash">
 
os router list on l3 agent <l3_agent>
 
    [-f {csv,table}] [-c COLUMN]
 
    [--quote {all,minimal,none,nonnumeric}]
 
    [--request-format {json,xml}] [-D]
 
    [-F FIELD]
 
</source>
 
|| no || ||
 
<source lang="bash">
 
neutron router-list-on-l3-agent <l3_agent>
 
    [-f {csv,table}] [-c COLUMN]
 
    [--quote {all,minimal,none,nonnumeric}]
 
    [--request-format {json,xml}] [-D]
 
    [-F FIELD]
 
# Note should we support these oddball
 
# commands like this one?
 
</source>
 
|-
 
|<source lang="bash">
 
os router port list <router>
 
    [-f {csv,table}] [-c COLUMN]
 
    [--quote {all,minimal,none,nonnumeric}]
 
    [--request-format {json,xml}] [-D] [-F FIELD]
 
    [-P SIZE] [--sort-key FIELD]
 
    [--sort-dir {asc,desc}]
 
</source>
 
|| no || ||
 
<source lang="bash">
 
neutron router-port-list <router>
 
    [-f {csv,table}] [-c COLUMN]
 
    [--quote {all,minimal,none,nonnumeric}]
 
    [--request-format {json,xml}] [-D] [-F FIELD]
 
    [-P SIZE] [--sort-key FIELD]
 
    [--sort-dir {asc,desc}]
 
</source>
 
|-
 
|<source lang="bash">
 
os router show <router>
 
    [-f {shell,table}] [-c COLUMN]
 
    [--variable VARIABLE] [--prefix PREFIX]
 
    [--request-format {json,xml}] [-D] [-F FIELD]
 
</source>
 
|| no || ||
 
<source lang="bash">
 
neutron router-show <router>
 
    [-f {shell,table}] [-c COLUMN]
 
    [--variable VARIABLE] [--prefix PREFIX]
 
    [--request-format {json,xml}] [-D] [-F FIELD]
 
</source>
 
|-
 
|<source lang="bash">
 
os router update <router>
 
    [--request-format {json,xml}]
 
</source>
 
|| no || ||
 
<source lang="bash">
 
neutron router-update <router>
 
    [--request-format {json,xml}]
 
</source>
 
|}
 
 
 
====Security Group====
 
 
 
Note: should we use "secgroup" or replace it with "security group"  Supporting both would be confusing, but for now it would probably work.
 
 
 
 
 
{| class="wikitable"
 
|-
 
! OSC Command !! Implemented !! !! Neutron command
 
|-
 
|<source lang="bash">
 
os security group create <name>
 
    [-f {shell,table}] [-c COLUMN]
 
    [--variable VARIABLE] [--prefix PREFIX]
 
    [--request-format {json,xml}]
 
    [--tenant-id TENANT_ID]
 
    [--description DESCRIPTION]
 
</source>
 
|| no || ||
 
<source lang="bash">
 
neutron security-group-create <name>
 
    [-f {shell,table}] [-c COLUMN]
 
    [--variable VARIABLE] [--prefix PREFIX]
 
    [--request-format {json,xml}]   
 
    [--tenant-id TENANT_ID]         
 
    [--description DESCRIPTION]
 
</source>
 
|-
 
|<source lang="bash">
 
os security group delete <security_group>
 
    [--request-format {json,xml}]
 
</source>
 
|| no || ||
 
<source lang="bash">
 
neutron security-group-delete <security_group>
 
    [--request-format {json,xml}]
 
</source>
 
|-
 
|<source lang="bash">
 
os security group list
 
    [-f {csv,table}] [-c COLUMN]
 
    [--quote {all,minimal,none,nonnumeric}]
 
    [--request-format {json,xml}] [-D]
 
    [-F FIELD] [-P SIZE] [--sort-key FIELD]
 
    [--sort-dir {asc,desc}]
 
</source>
 
|| no || ||
 
<source lang="bash">
 
neutron security-group-list
 
    [-f {csv,table}] [-c COLUMN]
 
    [--quote {all,minimal,none,nonnumeric}]
 
    [--request-format {json,xml}] [-D]
 
    [-F FIELD] [-P SIZE] [--sort-key FIELD]
 
    [--sort-dir {asc,desc}]
 
</source>
 
|-
 
|<source lang="bash">
 
os security group show <security_group>
 
    [-f {shell,table}] [-c COLUMN]
 
    [--variable VARIABLE] [--prefix PREFIX]
 
    [--request-format {json,xml}] [-D]
 
    [-F FIELD]
 
</source>
 
|| no || ||
 
<source lang="bash">
 
neutron security-group-show <security_group>
 
    [-f {shell,table}] [-c COLUMN]
 
    [--variable VARIABLE] [--prefix PREFIX]
 
    [--request-format {json,xml}] [-D]
 
    [-F FIELD]
 
</source>
 
|-
 
|<source lang="bash">
 
os security group update <security_group>
 
    [--request-format {json,xml}]
 
    [--name NAME] [--description DESCRIPTION]
 
</source>
 
|| no || ||
 
<source lang="bash">
 
neutron security-group-update <security_group>
 
    [--request-format {json,xml}]
 
    [--name NAME] [--description DESCRIPTION]
 
</source>
 
|}
 
 
 
====Security Group Rules====
 
 
 
Note: Again, we have duplicate commands with Nova.
 
 
 
{| class="wikitable"
 
|-
 
! OSC Command !! Implemented !! !! Neutron command
 
|-
 
|<source lang="bash">
 
os security group rule create <security_group>
 
    [-f {shell,table}] [-c COLUMN]
 
    [--variable VARIABLE]
 
    [--prefix PREFIX]
 
    [--request-format {json,xml}]
 
    [--tenant-id TENANT_ID]
 
    [--direction {ingress,egress}]
 
    [--ethertype ETHERTYPE]
 
    [--protocol PROTOCOL]
 
    [--port-range-min PORT_RANGE_MIN]
 
    [--port-range-max PORT_RANGE_MAX]
 
    [--remote-ip-prefix REMOTE_IP_PREFIX]
 
    [--remote-group-id REMOTE_GROUP]
 
</source>
 
|| no || ||
 
<source lang="bash">
 
neutron security-group-rule-create <security_group>
 
    [-f {shell,table}] [-c COLUMN]
 
    [--variable VARIABLE]               
 
    [--prefix PREFIX]                   
 
    [--request-format {json,xml}]       
 
    [--tenant-id TENANT_ID]             
 
    [--direction {ingress,egress}]       
 
    [--ethertype ETHERTYPE]             
 
    [--protocol PROTOCOL]               
 
    [--port-range-min PORT_RANGE_MIN]   
 
    [--port-range-max PORT_RANGE_MAX]   
 
    [--remote-ip-prefix REMOTE_IP_PREFIX]
 
    [--remote-group-id REMOTE_GROUP]
 
</source>
 
|-
 
|<source lang="bash">
 
os security group rule delete <rule>
 
    [--request-format {json,xml}]
 
 
 
</source>
 
|| no || ||
 
<source lang="bash">
 
neutron security-group-rule-delete <rule>
 
    [--request-format {json,xml}]
 
</source>
 
|-
 
|<source lang="bash">
 
os security group rule list
 
    [-f {csv,table}] [-c COLUMN]
 
    [--quote {all,minimal,none,nonnumeric}]
 
    [--request-format {json,xml}] [-D]
 
    [-F FIELD] [-P SIZE]
 
    [--sort-key FIELD]
 
    [--sort-dir {asc,desc}]
 
    [--no-nameconv]
 
</source>
 
|| no || ||
 
<source lang="bash">
 
neutron security-group-rule-list
 
    [-f {csv,table}] [-c COLUMN]
 
    [--quote {all,minimal,none,nonnumeric}]
 
    [--request-format {json,xml}] [-D] 
 
    [-F FIELD] [-P SIZE]               
 
    [--sort-key FIELD]                 
 
    [--sort-dir {asc,desc}]           
 
    [--no-nameconv]
 
</source>
 
|-
 
|<source lang="bash">
 
os security group rule show <rule>
 
    [-f {shell,table}] [-c COLUMN]
 
    [--variable VARIABLE]
 
    [--prefix PREFIX]
 
    [--request-format {json,xml}] [-D]
 
    [-F FIELD]
 
</source>
 
|| no || ||
 
<source lang="bash">
 
neutron security-group-rule-show <rule>
 
    [-f {shell,table}] [-c COLUMN]
 
    [--variable VARIABLE]             
 
    [--prefix PREFIX]                 
 
    [--request-format {json,xml}] [-D] 
 
    [-F FIELD]
 
</source>
 
|}
 
 
 
====Service Provider====
 
 
 
Note: Is this related to the Keystone service?  Not sure. The Neutron help is very light.
 
 
 
{| class="wikitable"
 
|-
 
! OSC Command !! Implemented !! !! Neutron command
 
|-
 
|<source lang="bash">
 
</source>
 
|| no || ||
 
<source lang="bash">
 
neutron service-provider-list
 
    [-f {csv,table}] [-c COLUMN]
 
    [--quote {all,minimal,none,nonnumeric}]
 
    [--request-format {json,xml}] [-D]
 
    [-F FIELD] [-P SIZE] [--sort-key FIELD]
 
    [--sort-dir {asc,desc}]
 
</source>
 
|}
 
 
 
====Subnet====
 
{| class="wikitable"
 
|-
 
! OSC Command !! Implemented !! !! Neutron command
 
|-
 
|<source lang="bash">
 
os subnet create <network> <cidr>
 
    [-f {shell,table}] [-c COLUMN]
 
    [--variable VARIABLE] [--prefix PREFIX]
 
    [--request-format {json,xml}]
 
    [--tenant-id TENANT_ID] [--name NAME]
 
    [--ip-version {4,6}] [--gateway GATEWAY_IP]
 
    [--no-gateway]
 
    [--allocation-pool start=IP_ADDR,end=IP_ADDR]
 
    [--host-route destination=CIDR,nexthop=IP_ADDR]
 
    [--dns-nameserver DNS_NAMESERVER]
 
    [--disable-dhcp]
 
</source>
 
|| no || ||
 
<source lang="bash">
 
neutron subnet-create <network> <cidr>
 
    [-f {shell,table}] [-c COLUMN]
 
    [--variable VARIABLE] [--prefix PREFIX]
 
    [--request-format {json,xml}]
 
    [--tenant-id TENANT_ID] [--name NAME]
 
    [--ip-version {4,6}] [--gateway GATEWAY_IP]
 
    [--no-gateway]         
 
    [--allocation-pool start=IP_ADDR,end=IP_ADDR]
 
    [--host-route destination=CIDR,nexthop=IP_ADDR]
 
    [--dns-nameserver DNS_NAMESERVER]
 
    [--disable-dhcp]
 
</source>
 
|-
 
|<source lang="bash">
 
os subnet delete <subnet>
 
    [--request-format {json,xml}]
 
</source>
 
|| no || ||
 
<source lang="bash">
 
neutron subnet-delete <subnet>
 
    [--request-format {json,xml}]
 
</source>
 
|-
 
|<source lang="bash">
 
os subnet list
 
    [-f {csv,table}] [-c COLUMN]
 
    [--quote {all,minimal,none,nonnumeric}]
 
    [--request-format {json,xml}] [-D] [-F FIELD]
 
    [-P SIZE] [--sort-key FIELD]
 
    [--sort-dir {asc,desc}]
 
</source>
 
|| no || ||
 
<source lang="bash">
 
neutron subnet-list
 
    [-f {csv,table}] [-c COLUMN]
 
    [--quote {all,minimal,none,nonnumeric}]
 
    [--request-format {json,xml}] [-D] [-F FIELD]
 
    [-P SIZE] [--sort-key FIELD]
 
    [--sort-dir {asc,desc}]
 
</source>
 
|-
 
|<source lang="bash">
 
os subnet show <subnet>
 
    [-f {shell,table}] [-c COLUMN]
 
    [--variable VARIABLE] [--prefix PREFIX]
 
    [--request-format {json,xml}] [-D] [-F FIELD]
 
</source>
 
|| no || ||
 
<source lang="bash">
 
neutron subnet-show <subnet>
 
    [-f {shell,table}] [-c COLUMN]
 
    [--variable VARIABLE] [--prefix PREFIX]
 
    [--request-format {json,xml}] [-D] [-F FIELD]
 
</source>
 
|-
 
|<source lang="bash">
 
os subnet update <subnet>
 
    [--request-format {json,xml}]
 
</source>
 
|| no || ||
 
<source lang="bash">
 
neutron subnet-update <subnet>
 
    [--request-format {json,xml}]
 
</source>
 
|}
 
 
 
====VPN====
 
{| class="wikitable"
 
|-
 
! OSC Command !! Implemented !! !! Neutron command
 
|-
 
|<source lang="bash">
 
os vpn ikepolicy create <name>
 
    [-f {shell,table}] [-c COLUMN]
 
    [--variable VARIABLE] [--prefix PREFIX]
 
    [--request-format {json,xml}]
 
    [--tenant-id TENANT_ID]
 
    [--description DESCRIPTION]
 
    [--auth-algorithm {sha1}]
 
    [--encryption-algorithm {3des,aes-128,aes-192,aes-256}]
 
    [--phase1-negotiation-mode {main}]
 
    [--ike-version {v1,v2}]
 
    [--pfs {group2,group5,group14}]
 
    [--lifetime units=UNITS,value=VALUE]
 
</source>
 
|| no || ||
 
<source lang="bash">
 
neutron vpn-ikepolicy-create <name>
 
    [-f {shell,table}] [-c COLUMN]
 
    [--variable VARIABLE] [--prefix PREFIX]
 
    [--request-format {json,xml}]
 
    [--tenant-id TENANT_ID]
 
    [--description DESCRIPTION]
 
    [--auth-algorithm {sha1}]
 
    [--encryption-algorithm {3des,aes-128,aes-192,aes-256}]
 
    [--phase1-negotiation-mode {main}]
 
    [--ike-version {v1,v2}]
 
    [--pfs {group2,group5,group14}]
 
    [--lifetime units=UNITS,value=VALUE]
 
</source>
 
|-
 
|<source lang="bash">
 
os vpn ikepolicy delete <policy>
 
    [--request-format {json,xml}]
 
</source>
 
|| no || ||
 
<source lang="bash">
 
neutron vpn-ikepolicy-delete <policy>
 
    [--request-format {json,xml}]
 
</source>
 
|-
 
|<source lang="bash">
 
os vpn ikepolicy list
 
    [-f {csv,table}] [-c COLUMN]
 
    [--quote {all,minimal,none,nonnumeric}]
 
    [--request-format {json,xml}] [-D]
 
    [-F FIELD] [-P SIZE] [--sort-key FIELD]
 
    [--sort-dir {asc,desc}]
 
</source>
 
|| no || ||
 
<source lang="bash">
 
neutron vpn-ikepolicy-list
 
    [-f {csv,table}] [-c COLUMN]
 
    [--quote {all,minimal,none,nonnumeric}]
 
    [--request-format {json,xml}] [-D]
 
    [-F FIELD] [-P SIZE] [--sort-key FIELD]
 
    [--sort-dir {asc,desc}]
 
</source>
 
|-
 
|<source lang="bash">
 
os vpn ikepolicy show <policy>
 
    [-f {shell,table}] [-c COLUMN]
 
    [--variable VARIABLE] [--prefix PREFIX]
 
    [--request-format {json,xml}] [-D]
 
    [-F FIELD]
 
</source>
 
|| no || ||
 
<source lang="bash">
 
neutron vpn-ikepolicy-show <policy>
 
    [-f {shell,table}] [-c COLUMN]
 
    [--variable VARIABLE] [--prefix PREFIX]
 
    [--request-format {json,xml}] [-D]
 
    [-F FIELD]
 
</source>
 
|-
 
|<source lang="bash">
 
os vpn ikepolicy update <policy>
 
    [--request-format {json,xml}]
 
    [--lifetime units=UNITS,value=VALUE]
 
</source>
 
|| no || ||
 
<source lang="bash">
 
neutron vpn-ikepolicy-update <policy>
 
    [--request-format {json,xml}]
 
    [--lifetime units=UNITS,value=VALUE]
 
</source>
 
|-
 
|<source lang="bash">
 
os vpn ipsecpolicy create <name>
 
    [-f {shell,table}] [-c COLUMN]
 
    [--variable VARIABLE] [--prefix PREFIX]
 
    [--request-format {json,xml}]
 
    [--tenant-id TENANT_ID]
 
    [--description DESCRIPTION]
 
    [--transform-protocol {esp,ah,ah-esp}]
 
    [--auth-algorithm {sha1}]
 
    [--encryption-algorithm {3des,aes-128,aes-192,aes-256}]
 
    [--encapsulation-mode {tunnel,transport}]
 
    [--pfs {group2,group5,group14}]
 
    [--lifetime units=UNITS,value=VALUE]
 
</source>
 
|| no || ||
 
<source lang="bash">
 
neutron vpn-ipsecpolicy-create <name>
 
    [-f {shell,table}] [-c COLUMN]
 
    [--variable VARIABLE] [--prefix PREFIX]
 
    [--request-format {json,xml}]   
 
    [--tenant-id TENANT_ID]         
 
    [--description DESCRIPTION]     
 
    [--transform-protocol {esp,ah,ah-esp}]
 
    [--auth-algorithm {sha1}]       
 
    [--encryption-algorithm {3des,aes-128,aes-192,aes-256}]
 
    [--encapsulation-mode {tunnel,transport}]
 
    [--pfs {group2,group5,group14}] 
 
    [--lifetime units=UNITS,value=VALUE]
 
</source>
 
|-
 
|<source lang="bash">
 
os vpn ipsecpolicy delete <policy>
 
  [--request-format {json,xml}]
 
</source>
 
|| no || ||
 
<source lang="bash">
 
neutron vpn-ipsecpolicy-delete <policy>
 
  [--request-format {json,xml}]
 
</source>
 
|-
 
|<source lang="bash">
 
os vpn ipsecpolicy list
 
    [-f {csv,table}] [-c COLUMN]
 
    [--quote {all,minimal,none,nonnumeric}]
 
    [--request-format {json,xml}] [-D]
 
    [-F FIELD] [-P SIZE] [--sort-key FIELD]
 
    [--sort-dir {asc,desc}]
 
</source>
 
|| no || ||
 
<source lang="bash">
 
neutron vpn-ipsecpolicy-list
 
    [-f {csv,table}] [-c COLUMN]
 
    [--quote {all,minimal,none,nonnumeric}]
 
    [--request-format {json,xml}] [-D]
 
    [-F FIELD] [-P SIZE] [--sort-key FIELD]
 
    [--sort-dir {asc,desc}]
 
</source>
 
|-
 
|<source lang="bash">
 
os vpn ipsecpolicy show <policy>
 
    [-f {shell,table}] [-c COLUMN]
 
    [--variable VARIABLE] [--prefix PREFIX]
 
    [--request-format {json,xml}] [-D]
 
    [-F FIELD]
 
</source>
 
|| no || ||
 
<source lang="bash">
 
neutron vpn-ipsecpolicy-show <policy>
 
    [-f {shell,table}] [-c COLUMN]
 
    [--variable VARIABLE] [--prefix PREFIX]
 
    [--request-format {json,xml}] [-D]
 
    [-F FIELD]
 
</source>
 
|-
 
|<source lang="bash">
 
os vpn ipsecpolicy update <policy>
 
    [--request-format {json,xml}]
 
    [--lifetime units=UNITS,value=VALUE]
 
</source>
 
|| no || ||
 
<source lang="bash">
 
neutron vpn-ipsecpolicy-update <policy>
 
    [--request-format {json,xml}]
 
    [--lifetime units=UNITS,value=VALUE]
 
</source>
 
|-
 
|<source lang="bash">
 
os vpn service create <router> <subnet>
 
    [-f {shell,table}] [-c COLUMN]
 
    [--variable VARIABLE] [--prefix PREFIX]
 
    [--request-format {json,xml}]
 
    [--tenant-id TENANT_ID] [--admin-state-down]
 
    [--name NAME] [--description DESCRIPTION]
 
</source>
 
|| no || ||
 
<source lang="bash">
 
neutron vpn-service-create <router> <subnet>
 
    [-f {shell,table}] [-c COLUMN]
 
    [--variable VARIABLE] [--prefix PREFIX]
 
    [--request-format {json,xml}]
 
    [--tenant-id TENANT_ID] [--admin-state-down]
 
    [--name NAME] [--description DESCRIPTION]
 
</source>
 
|-
 
|<source lang="bash">
 
os vpn service delete <service>
 
    [--request-format {json,xml}]
 
</source>
 
|| no || ||
 
<source lang="bash">
 
neutron vpn-service-delete <service>
 
    [--request-format {json,xml}]
 
</source>
 
|-
 
|<source lang="bash">
 
os vpn service list
 
    [-f {csv,table}] [-c COLUMN]
 
    [--quote {all,minimal,none,nonnumeric}]
 
    [--request-format {json,xml}] [-D] [-F FIELD]
 
    [-P SIZE] [--sort-key FIELD]
 
    [--sort-dir {asc,desc}]
 
</source>
 
|| no || ||
 
<source lang="bash">
 
neutron vpn-service-list
 
    [-f {csv,table}] [-c COLUMN]
 
    [--quote {all,minimal,none,nonnumeric}]
 
    [--request-format {json,xml}] [-D] [-F FIELD]
 
    [-P SIZE] [--sort-key FIELD]
 
    [--sort-dir {asc,desc}]
 
</source>
 
|-
 
|<source lang="bash">
 
os vpn service show <service>
 
    [-f {shell,table}] [-c COLUMN]
 
    [--variable VARIABLE] [--prefix PREFIX]
 
    [--request-format {json,xml}] [-D] [-F FIELD]
 
</source>
 
|| no || ||
 
<source lang="bash">
 
neutron vpn-service-show <service>
 
    [-f {shell,table}] [-c COLUMN]
 
    [--variable VARIABLE] [--prefix PREFIX]
 
    [--request-format {json,xml}] [-D] [-F FIELD]
 
</source>
 
|-
 
|<source lang="bash">
 
os vpn service update <service>
 
    [--request-format {json,xml}]
 
</source>
 
|| no || ||
 
<source lang="bash">
 
neutron vpn-service-update <service>
 
    [--request-format {json,xml}]
 
</source>
 
|}
 
 
 
= Options =
 
 
 
In general, options will be transformed into more UNIX-like usage
 
 
 
* <code><nowiki>--enable true|false</nowiki></code> becomes <code><nowiki>--enable|--disable</nowiki></code>
 
 
 
''(dhellmann) Not all boolean options have natural antonyms like enable/disable. It may be more consistent to use a --flag --no-flag style naming convention to indicate the opposites of flags.''
 
 
 
"(dtroyer) Yup, except i really don't like --no-enable.  I'm going to work through the switch mapping to see how many others we really have to deal with."
 
 
 
----
 
[[Category:Client]]
 

Latest revision as of 17:26, 23 March 2016

[Note: The former content of this page was removed on 23Mar2016 as it was over 15 months out of date. The current information that was formerly on this page can be found at OpenStack Documentation]