Difference between revisions of "UnifiedCLI/Mapping"
(→Global Options) |
(Fixed code blocks) |
||
| Line 126: | Line 126: | ||
'''token''' | '''token''' | ||
| − | < | + | <source lang="bash"> |
keystone token-get [--wrap <integer>] | keystone token-get [--wrap <integer>] | ||
os show token [--width <pki-token-display-width>] | os show token [--width <pki-token-display-width>] | ||
| − | </ | + | </source> |
'''catalog''' | '''catalog''' | ||
| − | < | + | <source lang="bash"> |
keystone catalog [--service <service-type>] | keystone catalog [--service <service-type>] | ||
os show service [--catalog <service-type>] | os show service [--catalog <service-type>] | ||
| − | </ | + | </source> |
'''ec2-credentials''' | '''ec2-credentials''' | ||
| − | < | + | <source lang="bash"> |
keystone ec2-credentials-create [--user <user-id>] | keystone ec2-credentials-create [--user <user-id>] | ||
[--tenant_id <tenant-id>] | [--tenant_id <tenant-id>] | ||
| Line 151: | Line 151: | ||
## are both args really optional? | ## are both args really optional? | ||
| − | </ | + | </source> |
| − | < | + | <source lang="bash"> |
keystone ec2-credentials-delete [--user <user-id>] | keystone ec2-credentials-delete [--user <user-id>] | ||
--access <access-key> | --access <access-key> | ||
| Line 161: | Line 161: | ||
## what changes if --user is not provided? | ## what changes if --user is not provided? | ||
| − | </ | + | </source> |
| − | < | + | <source lang="bash"> |
keystone ec2-credentials-get [--user <user-id>] | keystone ec2-credentials-get [--user <user-id>] | ||
--access <access-key> | --access <access-key> | ||
| Line 171: | Line 171: | ||
## what changes if --user is not provided? | ## what changes if --user is not provided? | ||
| − | </ | + | </source> |
| − | < | + | <source lang="bash"> |
keystone ec2-credentials-list [--user <user-id>] | keystone ec2-credentials-list [--user <user-id>] | ||
os list ec2-credentials [--user <user-id>] | os list ec2-credentials [--user <user-id>] | ||
| − | </ | + | </source> |
'''endpoint''' | '''endpoint''' | ||
| − | < | + | <source lang="bash"> |
keystone endpoint-create [--region <endpoint-region>] | keystone endpoint-create [--region <endpoint-region>] | ||
[--service_id <service-id>] | [--service_id <service-id>] | ||
| Line 196: | Line 196: | ||
[--internalurl <internal-url>] | [--internalurl <internal-url>] | ||
<service> | <service> | ||
| − | </ | + | </source> |
| − | < | + | <source lang="bash"> |
keystone endpoint-delete <endpoint-id> | keystone endpoint-delete <endpoint-id> | ||
os delete endpoint <endpoint-id> | os delete endpoint <endpoint-id> | ||
| − | </ | + | </source> |
| − | < | + | <source lang="bash"> |
keystone endpoint-get --service <service-type> | keystone endpoint-get --service <service-type> | ||
[--endpoint_type <endpoint-type>] | [--endpoint_type <endpoint-type>] | ||
| Line 221: | Line 221: | ||
[--all] | [--all] | ||
<service> | <service> | ||
| − | </ | + | </source> |
| − | < | + | <source lang="bash"> |
keystone endpoint-list | keystone endpoint-list | ||
os list endpoint [--long] | os list endpoint [--long] | ||
| − | </ | + | </source> |
'''role''' | '''role''' | ||
| − | < | + | <source lang="bash"> |
keystone role-create --name <role-name> | keystone role-create --name <role-name> | ||
os create role <role-name> | os create role <role-name> | ||
| − | </ | + | </source> |
| − | < | + | <source lang="bash"> |
keystone role-delete <role-id> | keystone role-delete <role-id> | ||
os delete role <role> | os delete role <role> | ||
| − | </ | + | </source> |
| − | < | + | <source lang="bash"> |
keystone role-get <role-id> | keystone role-get <role-id> | ||
os show role <role> | os show role <role> | ||
| − | </ | + | </source> |
| − | < | + | <source lang="bash"> |
keystone role-list | keystone role-list | ||
os list role | os list role | ||
| − | </ | + | </source> |
'''service''' | '''service''' | ||
| − | < | + | <source lang="bash"> |
keystone service-create --name <name> | keystone service-create --name <name> | ||
--type <type> | --type <type> | ||
| Line 272: | Line 272: | ||
[--description <service-description>] | [--description <service-description>] | ||
<service-name> | <service-name> | ||
| − | </ | + | </source> |
| − | < | + | <source lang="bash"> |
keystone service-delete <service-id> | keystone service-delete <service-id> | ||
os delete service <service> | os delete service <service> | ||
| − | </ | + | </source> |
| − | < | + | <source lang="bash"> |
keystone service-get <service-id> | keystone service-get <service-id> | ||
os show service <service> | os show service <service> | ||
| − | </ | + | </source> |
| − | < | + | <source lang="bash"> |
keystone service-list | keystone service-list | ||
os list service [--long] | os list service [--long] | ||
| − | </ | + | </source> |
'''tenant''' | '''tenant''' | ||
| − | < | + | <source lang="bash"> |
keystone tenant-create --name <tenant-name> | keystone tenant-create --name <tenant-name> | ||
[--description <tenant-description>] | [--description <tenant-description>] | ||
| Line 307: | Line 307: | ||
[--enable | --disable] | [--enable | --disable] | ||
<tenant-name> | <tenant-name> | ||
| − | </ | + | </source> |
| − | < | + | <source lang="bash"> |
keystone tenant-delete <tenant-id> | keystone tenant-delete <tenant-id> | ||
os delete tenant <tenant> | os delete tenant <tenant> | ||
| − | </ | + | </source> |
| − | < | + | <source lang="bash"> |
keystone tenant-get <tenant-id> | keystone tenant-get <tenant-id> | ||
os show tenant <tenant> | os show tenant <tenant> | ||
| − | </ | + | </source> |
| − | < | + | <source lang="bash"> |
keystone tenant-list | keystone tenant-list | ||
os list tenant [--long] | os list tenant [--long] | ||
| − | </ | + | </source> |
| − | < | + | <source lang="bash"> |
keystone tenant-update | keystone tenant-update | ||
[--name <tenant_name>] | [--name <tenant_name>] | ||
| Line 343: | Line 343: | ||
[--enable | --disable] | [--enable | --disable] | ||
<tenant> | <tenant> | ||
| − | </ | + | </source> |
'''user''' | '''user''' | ||
| − | < | + | <source lang="bash"> |
keystone user-create --name <user-name> | keystone user-create --name <user-name> | ||
[--tenant_id <tenant-id>] | [--tenant_id <tenant-id>] | ||
| Line 361: | Line 361: | ||
[--enable | --disable] | [--enable | --disable] | ||
<user-name> | <user-name> | ||
| − | </ | + | </source> |
| − | < | + | <source lang="bash"> |
keystone user-delete <user-id> | keystone user-delete <user-id> | ||
os delete user <user> | os delete user <user> | ||
| − | </ | + | </source> |
| − | < | + | <source lang="bash"> |
keystone user-get <user-id> | keystone user-get <user-id> | ||
os show user <user> | os show user <user> | ||
| − | </ | + | </source> |
| − | < | + | <source lang="bash"> |
keystone user-list [<tenant-id>] | keystone user-list [<tenant-id>] | ||
os list user [--tenant <tenant>] [--long] | os list user [--tenant <tenant>] [--long] | ||
| − | </ | + | </source> |
| − | < | + | <source lang="bash"> |
keystone user-password-update --pass <password> <user-id> | keystone user-password-update --pass <password> <user-id> | ||
| Line 395: | Line 395: | ||
[--enable|--disable] | [--enable|--disable] | ||
<user> | <user> | ||
| − | </ | + | </source> |
'''user-role''' | '''user-role''' | ||
| − | < | + | <source lang="bash"> |
keystone user-role-add --user <user-id> | keystone user-role-add --user <user-id> | ||
--role <role-id> | --role <role-id> | ||
| Line 408: | Line 408: | ||
[--tenant <tenant>] | [--tenant <tenant>] | ||
<role> <user> | <role> <user> | ||
| − | </ | + | </source> |
| − | < | + | <source lang="bash"> |
keystone user-role-list [--user <user-id>] | keystone user-role-list [--user <user-id>] | ||
[--tenant_id <tenant-id>] | [--tenant_id <tenant-id>] | ||
| Line 418: | Line 418: | ||
[--tenant <tenant>] | [--tenant <tenant>] | ||
[<user>] | [<user>] | ||
| − | </ | + | </source> |
| − | < | + | <source lang="bash"> |
keystone user-role-remove --user <user-id> | keystone user-role-remove --user <user-id> | ||
--role <role-id> | --role <role-id> | ||
| Line 429: | Line 429: | ||
[--tenant <tenant>] | [--tenant <tenant>] | ||
<role> <user> | <role> <user> | ||
| − | </ | + | </source> |
'''<other>''' | '''<other>''' | ||
| − | < | + | <source lang="bash"> |
keystone bootstrap | keystone bootstrap | ||
--pass <password> | --pass <password> | ||
| Line 442: | Line 442: | ||
##TBD | ##TBD | ||
| − | </ | + | </source> |
| − | < | + | <source lang="bash"> |
keystone discover | keystone discover | ||
##TBD | ##TBD | ||
| − | </ | + | </source> |
| Line 457: | Line 457: | ||
'''credential''' | '''credential''' | ||
| − | < | + | <source lang="bash"> |
keystone credential-create --user_id <user-id> | keystone credential-create --user_id <user-id> | ||
--type <credential-type> | --type <credential-type> | ||
| Line 468: | Line 468: | ||
<type> | <type> | ||
<data> | <data> | ||
| − | </ | + | </source> |
| − | < | + | <source lang="bash"> |
keystone credential-delete <credential-id> | keystone credential-delete <credential-id> | ||
os delete credential <credential-id> | os delete credential <credential-id> | ||
| − | </ | + | </source> |
| − | < | + | <source lang="bash"> |
keystone credential-get <credential-id> | keystone credential-get <credential-id> | ||
os show credential <credential-id> | os show credential <credential-id> | ||
| − | </ | + | </source> |
| − | < | + | <source lang="bash"> |
keystone credential-list | keystone credential-list | ||
os list credential [--long] | os list credential [--long] | ||
| − | </ | + | </source> |
| − | < | + | <source lang="bash"> |
keystone credential-update | keystone credential-update | ||
[--user <user>] | [--user <user>] | ||
| Line 506: | Line 506: | ||
[--project <project>] | [--project <project>] | ||
<credential-id> | <credential-id> | ||
| − | </ | + | </source> |
'''domain''' | '''domain''' | ||
| − | < | + | <source lang="bash"> |
keystone domain-create --name <domain-name> | keystone domain-create --name <domain-name> | ||
[--description <domain-description>] | [--description <domain-description>] | ||
| Line 524: | Line 524: | ||
[--private_user_names] | [--private_user_names] | ||
<domain-name> | <domain-name> | ||
| − | </ | + | </source> |
| − | < | + | <source lang="bash"> |
keystone domain-delete <domain-id> | keystone domain-delete <domain-id> | ||
os delete domain <domain> | os delete domain <domain> | ||
| − | </ | + | </source> |
| − | < | + | <source lang="bash"> |
keystone domain-get <domain-id> | keystone domain-get <domain-id> | ||
os show domain <domain> | os show domain <domain> | ||
| − | </ | + | </source> |
| − | < | + | <source lang="bash"> |
keystone domain-list | keystone domain-list | ||
os list domain [--long] | os list domain [--long] | ||
| − | </ | + | </source> |
| − | < | + | <source lang="bash"> |
keystone domain-update | keystone domain-update | ||
[--name <domain_name>] | [--name <domain_name>] | ||
| Line 564: | Line 564: | ||
[--enable | --disable] | [--enable | --disable] | ||
<domain> | <domain> | ||
| − | </ | + | </source> |
'''endpoint''' | '''endpoint''' | ||
| − | < | + | <source lang="bash"> |
keystone endpoint-create --service_id <service-id> | keystone endpoint-create --service_id <service-id> | ||
--interface <endpoint-interface> | --interface <endpoint-interface> | ||
| Line 583: | Line 583: | ||
<endpoint-url> | <endpoint-url> | ||
| − | </ | + | </source> |
| − | < | + | <source lang="bash"> |
keystone endpoint-delete <endpoint-id> | keystone endpoint-delete <endpoint-id> | ||
os delete endpoint <endpoint-id> | os delete endpoint <endpoint-id> | ||
| − | </ | + | </source> |
| − | < | + | <source lang="bash"> |
keystone endpoint-list | keystone endpoint-list | ||
os list endpoint [--long] | os list endpoint [--long] | ||
| − | </ | + | </source> |
| − | < | + | <source lang="bash"> |
keystone enpoint-get <endpoint-id> | keystone enpoint-get <endpoint-id> | ||
os show endpoint <endpoint-id> | os show endpoint <endpoint-id> | ||
| − | </ | + | </source> |
| − | < | + | <source lang="bash"> |
keystone endpoint-update --endpoint_id <endpoint-id> | keystone endpoint-update --endpoint_id <endpoint-id> | ||
[--region <endpoint-region>] | [--region <endpoint-region>] | ||
| Line 622: | Line 622: | ||
[--url <endpoint-url>] | [--url <endpoint-url>] | ||
<endpoint-id> | <endpoint-id> | ||
| − | </ | + | </source> |
'''group''' | '''group''' | ||
| − | < | + | <source lang="bash"> |
keystone group-create --name <group-name> | keystone group-create --name <group-name> | ||
[--domain_id <domain-id>] | [--domain_id <domain-id>] | ||
| Line 636: | Line 636: | ||
[--description <group-description>] | [--description <group-description>] | ||
<group-name> | <group-name> | ||
| − | </ | + | </source> |
| − | < | + | <source lang="bash"> |
keystone group-delete <group-id> | keystone group-delete <group-id> | ||
os delete group <group> | os delete group <group> | ||
| − | </ | + | </source> |
| − | < | + | <source lang="bash"> |
keystone group-get <group-id> | keystone group-get <group-id> | ||
os show group <group> | os show group <group> | ||
| − | </ | + | </source> |
| − | < | + | <source lang="bash"> |
keystone group-list | keystone group-list | ||
os list group [--long] | os list group [--long] | ||
| − | </ | + | </source> |
| − | < | + | <source lang="bash"> |
keystone group-update | keystone group-update | ||
[--name <group_name>] | [--name <group_name>] | ||
| Line 672: | Line 672: | ||
[--description <new-group-description>] | [--description <new-group-description>] | ||
<group> | <group> | ||
| − | </ | + | </source> |
'''policy''' | '''policy''' | ||
| − | < | + | <source lang="bash"> |
keystone policy-create --type <policy-type> | keystone policy-create --type <policy-type> | ||
--blob <policy-blob> | --blob <policy-blob> | ||
| Line 684: | Line 684: | ||
--type <policy-type> | --type <policy-type> | ||
--blob <policy-blob> | --blob <policy-blob> | ||
| − | </ | + | </source> |
| − | < | + | <source lang="bash"> |
keystone policy-delete <policy-id> | keystone policy-delete <policy-id> | ||
os delete policy <policy-id> | os delete policy <policy-id> | ||
| − | </ | + | </source> |
| − | < | + | <source lang="bash"> |
keystone policy-get <policy-id> | keystone policy-get <policy-id> | ||
os show policy <policy-id> | os show policy <policy-id> | ||
| − | </ | + | </source> |
| − | < | + | <source lang="bash"> |
keystone policy-list | keystone policy-list | ||
os list policy [--long] | os list policy [--long] | ||
| − | </ | + | </source> |
| − | < | + | <source lang="bash"> |
keystone policy-update | keystone policy-update | ||
[--type <policy-type>] | [--type <policy-type>] | ||
| Line 718: | Line 718: | ||
[--blob <policy-blob>] | [--blob <policy-blob>] | ||
<policy-id> | <policy-id> | ||
| − | </ | + | </source> |
'''project''' | '''project''' | ||
| − | < | + | <source lang="bash"> |
keystone project-create --name <project-name> | keystone project-create --name <project-name> | ||
[--domain_id <project-domain-id>] | [--domain_id <project-domain-id>] | ||
| Line 734: | Line 734: | ||
[--enable | --disable] | [--enable | --disable] | ||
<project-name> | <project-name> | ||
| − | </ | + | </source> |
| − | < | + | <source lang="bash"> |
keystone project-delete <project-id> | keystone project-delete <project-id> | ||
os delete project <project> | os delete project <project> | ||
| − | </ | + | </source> |
| − | < | + | <source lang="bash"> |
keystone project-get <project-id> | keystone project-get <project-id> | ||
os show project <project> | os show project <project> | ||
| − | </ | + | </source> |
| − | < | + | <source lang="bash"> |
keystone project-list | keystone project-list | ||
os list project [--long] | os list project [--long] | ||
| − | </ | + | </source> |
| − | < | + | <source lang="bash"> |
keystone project-update | keystone project-update | ||
[--name <project_name>] | [--name <project_name>] | ||
| Line 772: | Line 772: | ||
[--enable | --disable] | [--enable | --disable] | ||
<project> | <project> | ||
| − | </ | + | </source> |
'''role''' | '''role''' | ||
| − | < | + | <source lang="bash"> |
keystone role-create --name <role-name> | keystone role-create --name <role-name> | ||
os create role <role-name> | os create role <role-name> | ||
| − | </ | + | </source> |
| − | < | + | <source lang="bash"> |
keystone role-delete <role-id> | keystone role-delete <role-id> | ||
os delete role <role> | os delete role <role> | ||
| − | </ | + | </source> |
| − | < | + | <source lang="bash"> |
keystone role-get <role-id> | keystone role-get <role-id> | ||
os show role <role> | os show role <role> | ||
| − | </ | + | </source> |
| − | < | + | <source lang="bash"> |
keystone role-list | keystone role-list | ||
os list role | os list role | ||
| − | </ | + | </source> |
| − | < | + | <source lang="bash"> |
keystone role-update <role-id> | keystone role-update <role-id> | ||
os update role <role> | os update role <role> | ||
| − | </ | + | </source> |
'''service''' | '''service''' | ||
| − | < | + | <source lang="bash"> |
keystone service-create --type <type> | keystone service-create --type <type> | ||
[--name <name>] | [--name <name>] | ||
| Line 823: | Line 823: | ||
[--enabled <true|false>] | [--enabled <true|false>] | ||
<type> | <type> | ||
| − | </ | + | </source> |
| − | < | + | <source lang="bash"> |
keystone service-delete <service-id> | keystone service-delete <service-id> | ||
os delete service <service> | os delete service <service> | ||
| − | </ | + | </source> |
| − | < | + | <source lang="bash"> |
keystone service-get <service-id> | keystone service-get <service-id> | ||
os show service <service> | os show service <service> | ||
| − | </ | + | </source> |
| − | < | + | <source lang="bash"> |
keystone service-list | keystone service-list | ||
os list service [--long] | os list service [--long] | ||
| − | </ | + | </source> |
| − | < | + | <source lang="bash"> |
keystone service-update --service_id <service-id> | keystone service-update --service_id <service-id> | ||
[--type <type>] | [--type <type>] | ||
| Line 858: | Line 858: | ||
[--enabled <true|false>] | [--enabled <true|false>] | ||
<service> | <service> | ||
| − | </ | + | </source> |
'''user''' | '''user''' | ||
| − | < | + | <source lang="bash"> |
keystone user-create --name <user-name> | keystone user-create --name <user-name> | ||
[--domain_id <domain-id>] | [--domain_id <domain-id>] | ||
| Line 878: | Line 878: | ||
[--password <password>] | [--password <password>] | ||
<user-name> | <user-name> | ||
| − | </ | + | </source> |
| − | < | + | <source lang="bash"> |
keystone user-delete <user-id> | keystone user-delete <user-id> | ||
os delete user <user> | os delete user <user> | ||
| − | </ | + | </source> |
| − | < | + | <source lang="bash"> |
keystone user-get <user-id> | keystone user-get <user-id> | ||
os show user <user> | os show user <user> | ||
| − | </ | + | </source> |
| − | < | + | <source lang="bash"> |
keystone user-list | keystone user-list | ||
os list user [--long] | os list user [--long] | ||
| − | </ | + | </source> |
| − | < | + | <source lang="bash"> |
keystone user-update --user_id <user-id> | keystone user-update --user_id <user-id> | ||
[--name <user-name>] | [--name <user-name>] | ||
| Line 919: | Line 919: | ||
[--user_name <user-name>] | [--user_name <user-name>] | ||
<user> | <user> | ||
| − | </ | + | </source> |
| Line 941: | Line 941: | ||
'''aggregate''' | '''aggregate''' | ||
| − | < | + | <source lang="bash"> |
nova aggregate-create <name> <availability_zone> | nova aggregate-create <name> <availability_zone> | ||
os create aggregate ... | os create aggregate ... | ||
| − | </ | + | </source> |
| − | < | + | <source lang="bash"> |
nova aggregate-delete <id> | nova aggregate-delete <id> | ||
os delete aggregate ... | os delete aggregate ... | ||
| − | </ | + | </source> |
| − | < | + | <source lang="bash"> |
nova aggregate-details <id> | nova aggregate-details <id> | ||
os show aggregate ... | os show aggregate ... | ||
| − | </ | + | </source> |
| − | < | + | <source lang="bash"> |
nova aggregate-list | nova aggregate-list | ||
os list aggregate | os list aggregate | ||
| − | </ | + | </source> |
| − | < | + | <source lang="bash"> |
nova aggregate-update <id> <name> [<availability_zone>] | nova aggregate-update <id> <name> [<availability_zone>] | ||
os set aggregate ... | os set aggregate ... | ||
| − | </ | + | </source> |
| − | < | + | <source lang="bash"> |
nova aggregate-set-metadata <id> <key=value> [<key=value> ...] | nova aggregate-set-metadata <id> <key=value> [<key=value> ...] | ||
os set aggregate --metadata ... | os set aggregate --metadata ... | ||
| − | </ | + | </source> |
'''aggregate-host''' | '''aggregate-host''' | ||
| − | < | + | <source lang="bash"> |
nova aggregate-add-host <id> <host> | nova aggregate-add-host <id> <host> | ||
os add aggregate-host ... | os add aggregate-host ... | ||
| − | </ | + | </source> |
| − | < | + | <source lang="bash"> |
nova aggregate-remove-host <id> <host> | nova aggregate-remove-host <id> <host> | ||
os remove aggregate-host ... | os remove aggregate-host ... | ||
| − | </ | + | </source> |
'''bash-completion''' | '''bash-completion''' | ||
| − | < | + | <source lang="bash"> |
nova bash-completion | nova bash-completion | ||
os show bash-completion | os show bash-completion | ||
| − | </ | + | </source> |
'''cloudpipe''' | '''cloudpipe''' | ||
| − | < | + | <source lang="bash"> |
nova cloudpipe-create <project> | nova cloudpipe-create <project> | ||
os create cloudpipe ... | os create cloudpipe ... | ||
| − | </ | + | </source> |
| − | < | + | <source lang="bash"> |
nova cloudpipe-list | nova cloudpipe-list | ||
os list cloudpipe | os list cloudpipe | ||
| − | </ | + | </source> |
'''console''' | '''console''' | ||
| − | < | + | <source lang="bash"> |
nova console-log [--length <length>] <server> | nova console-log [--length <length>] <server> | ||
os show console ... | os show console ... | ||
| − | </ | + | </source> |
| − | < | + | <source lang="bash"> |
nova get-vnc-console <server> <console_type> | nova get-vnc-console <server> <console_type> | ||
os show console [--vnc] ... | os show console [--vnc] ... | ||
| − | </ | + | </source> |
'''credentials''' | '''credentials''' | ||
| − | < | + | <source lang="bash"> |
nova credentials | nova credentials | ||
os show credentials | os show credentials | ||
| − | </ | + | </source> |
'''diagnostics''' | '''diagnostics''' | ||
| − | < | + | <source lang="bash"> |
nova diagnostics <server> | nova diagnostics <server> | ||
os show diagnostics ... | os show diagnostics ... | ||
| − | </ | + | </source> |
'''dns''' | '''dns''' | ||
| − | < | + | <source lang="bash"> |
nova dns-create [--type <type>] <ip> <name> <domain> | nova dns-create [--type <type>] <ip> <name> <domain> | ||
os create dns ... | os create dns ... | ||
| − | </ | + | </source> |
| − | < | + | <source lang="bash"> |
nova dns-delete <domain> <name> | nova dns-delete <domain> <name> | ||
os delete dns ... | os delete dns ... | ||
| − | </ | + | </source> |
| − | < | + | <source lang="bash"> |
nova dns-list [--ip <ip>] [--name <name>] <domain> | nova dns-list [--ip <ip>] [--name <name>] <domain> | ||
os list dns ... | os list dns ... | ||
| − | </ | + | </source> |
'''dns-domain''' | '''dns-domain''' | ||
| − | < | + | <source lang="bash"> |
nova dns-create-private-domain [--availability_zone <availability_zone>] | nova dns-create-private-domain [--availability_zone <availability_zone>] | ||
<domain> | <domain> | ||
os create dns-domain [--private] ... | os create dns-domain [--private] ... | ||
| − | </ | + | </source> |
'''dns-public-domain''' | '''dns-public-domain''' | ||
| − | < | + | <source lang="bash"> |
nova dns-create-public-domain [--project <project>] <domain> | nova dns-create-public-domain [--project <project>] <domain> | ||
os create dns-domain [--public] ... | os create dns-domain [--public] ... | ||
| − | </ | + | </source> |
| − | < | + | <source lang="bash"> |
nova dns-delete-domain <domain> | nova dns-delete-domain <domain> | ||
os delete dns-domain ... | os delete dns-domain ... | ||
| − | </ | + | </source> |
| − | < | + | <source lang="bash"> |
nova dns-domains | nova dns-domains | ||
os list dns-domains | os list dns-domains | ||
| − | </ | + | </source> |
'''endpoints''' | '''endpoints''' | ||
| − | < | + | <source lang="bash"> |
nova endpoints | nova endpoints | ||
| Line 1,122: | Line 1,122: | ||
# does this overlap with keystone? | # does this overlap with keystone? | ||
| − | </ | + | </source> |
'''fixed-ip''' | '''fixed-ip''' | ||
| − | < | + | <source lang="bash"> |
nova add-fixed-ip <server> <network_id> | nova add-fixed-ip <server> <network_id> | ||
os add fixed-ip ... | os add fixed-ip ... | ||
| − | </ | + | </source> |
| − | < | + | <source lang="bash"> |
nova remove-fixed-ip <server> <address> | nova remove-fixed-ip <server> <address> | ||
os remove fixed-ip ... | os remove fixed-ip ... | ||
| − | </ | + | </source> |
'''flavor''' | '''flavor''' | ||
| − | < | + | <source lang="bash"> |
nova flavor-create [--ephemeral <ephemeral>] | nova flavor-create [--ephemeral <ephemeral>] | ||
[--swap <swap>] | [--swap <swap>] | ||
| Line 1,150: | Line 1,150: | ||
os create flavor ... | os create flavor ... | ||
| − | </ | + | </source> |
| − | < | + | <source lang="bash"> |
nova flavor-delete <id> | nova flavor-delete <id> | ||
os delete flavor ... | os delete flavor ... | ||
| − | </ | + | </source> |
| − | < | + | <source lang="bash"> |
nova flavor-list | nova flavor-list | ||
os list flavor | os list flavor | ||
| − | </ | + | </source> |
'''floating-ip''' | '''floating-ip''' | ||
| − | < | + | <source lang="bash"> |
nova add-floating-ip <server> <address> | nova add-floating-ip <server> <address> | ||
os add floating-ip ... | os add floating-ip ... | ||
| − | </ | + | </source> |
| − | < | + | <source lang="bash"> |
nova floating-ip-create [<floating_ip_pool>] | nova floating-ip-create [<floating_ip_pool>] | ||
os create floating-ip ... | os create floating-ip ... | ||
| − | </ | + | </source> |
| − | < | + | <source lang="bash"> |
nova floating-ip-delete <address> | nova floating-ip-delete <address> | ||
os delete floating-ip | os delete floating-ip | ||
| − | </ | + | </source> |
| − | < | + | <source lang="bash"> |
nova floating-ip-list | nova floating-ip-list | ||
os list floating-ip | os list floating-ip | ||
| − | </ | + | </source> |
| − | < | + | <source lang="bash"> |
nova remove-floating-ip <server> <address> | nova remove-floating-ip <server> <address> | ||
os remove floating-ip ... | os remove floating-ip ... | ||
| − | </ | + | </source> |
'''floating-ip-pool''' | '''floating-ip-pool''' | ||
| − | < | + | <source lang="bash"> |
nova floating-ip-pool-list | nova floating-ip-pool-list | ||
os list floating-ip-pool | os list floating-ip-pool | ||
| − | </ | + | </source> |
'''host''' | '''host''' | ||
| − | < | + | <source lang="bash"> |
nova host-action [--action <action>] <hostname> | nova host-action [--action <action>] <hostname> | ||
os ?? host ... | os ?? host ... | ||
| − | </ | + | </source> |
| − | < | + | <source lang="bash"> |
nova host-update [--status <status>] | nova host-update [--status <status>] | ||
[--maintenance <maintenance_mode>] | [--maintenance <maintenance_mode>] | ||
| Line 1,228: | Line 1,228: | ||
os set host ... | os set host ... | ||
| − | </ | + | </source> |
'''image''' | '''image''' | ||
| − | < | + | <source lang="bash"> |
nova image-create [--poll] <server> <name> | nova image-create [--poll] <server> <name> | ||
os create image ... | os create image ... | ||
| − | </ | + | </source> |
| − | < | + | <source lang="bash"> |
nova image-delete <image> | nova image-delete <image> | ||
os delete image ... | os delete image ... | ||
| − | </ | + | </source> |
| − | < | + | <source lang="bash"> |
nova image-list | nova image-list | ||
os list image | os list image | ||
| − | </ | + | </source> |
| − | < | + | <source lang="bash"> |
nova image-meta <image> <action> <key=value> [<key=value> ...] | nova image-meta <image> <action> <key=value> [<key=value> ...] | ||
os set image ... | os set image ... | ||
| − | </ | + | </source> |
| − | < | + | <source lang="bash"> |
nova image-show <image> | nova image-show <image> | ||
os show image ... | os show image ... | ||
| − | </ | + | </source> |
'''keypair''' | '''keypair''' | ||
| − | < | + | <source lang="bash"> |
nova keypair-add [--pub_key <pub_key>] <name> | nova keypair-add [--pub_key <pub_key>] <name> | ||
os create keypair ... | os create keypair ... | ||
| − | </ | + | </source> |
| − | < | + | <source lang="bash"> |
nova keypair-delete <name> | nova keypair-delete <name> | ||
os delete keypair | os delete keypair | ||
| − | </ | + | </source> |
| − | < | + | <source lang="bash"> |
nova keypair-list | nova keypair-list | ||
os list keypair | os list keypair | ||
| − | </ | + | </source> |
'''limits''' | '''limits''' | ||
| − | < | + | <source lang="bash"> |
nova absolute-limits | nova absolute-limits | ||
os show limits --absolute | os show limits --absolute | ||
## is there any other kind? | ## is there any other kind? | ||
| − | </ | + | </source> |
'''quota''' | '''quota''' | ||
| − | < | + | <source lang="bash"> |
nova quota-defaults <tenant_id> | nova quota-defaults <tenant_id> | ||
nova quota-show <tenant_id> | nova quota-show <tenant_id> | ||
os show quota <tenant> [--defaults] | os show quota <tenant> [--defaults] | ||
| − | </ | + | </source> |
| − | < | + | <source lang="bash"> |
nova quota-update [--instances <instances>] | nova quota-update [--instances <instances>] | ||
[--cores <cores>] | [--cores <cores>] | ||
| Line 1,324: | Line 1,324: | ||
os set quota ... | os set quota ... | ||
| − | </ | + | </source> |
'''quota-class''' | '''quota-class''' | ||
| − | < | + | <source lang="bash"> |
nova quota-class-show <class> | nova quota-class-show <class> | ||
os show quota-class ... | os show quota-class ... | ||
| − | </ | + | </source> |
| − | < | + | <source lang="bash"> |
nova quota-class-update [--instances <instances>] | nova quota-class-update [--instances <instances>] | ||
[--cores <cores>] | [--cores <cores>] | ||
| Line 1,349: | Line 1,349: | ||
os set quota-class ... | os set quota-class ... | ||
| − | </ | + | </source> |
'''rate-limits''' | '''rate-limits''' | ||
| − | < | + | <source lang="bash"> |
nova rate-limits | nova rate-limits | ||
os show rate-limits | os show rate-limits | ||
| − | </ | + | </source> |
'''resource''' | '''resource''' | ||
| − | < | + | <source lang="bash"> |
nova describe-resource <hostname> | nova describe-resource <hostname> | ||
os show resource ... | os show resource ... | ||
| − | </ | + | </source> |
'''secgroup''' | '''secgroup''' | ||
| − | < | + | <source lang="bash"> |
nova secgroup-create <name> <description> | nova secgroup-create <name> <description> | ||
os create secgroup ... | os create secgroup ... | ||
| − | </ | + | </source> |
| − | < | + | <source lang="bash"> |
nova secgroup-delete <secgroup> | nova secgroup-delete <secgroup> | ||
os delete secgroup ... | os delete secgroup ... | ||
| − | </ | + | </source> |
| − | < | + | <source lang="bash"> |
nova secgroup-list | nova secgroup-list | ||
os list secgroup | os list secgroup | ||
| − | </ | + | </source> |
'''secgroup-group-rule''' | '''secgroup-group-rule''' | ||
| − | < | + | <source lang="bash"> |
nova secgroup-add-group-rule [--ip_proto <ip_proto>] | nova secgroup-add-group-rule [--ip_proto <ip_proto>] | ||
[--from_port <from_port>] | [--from_port <from_port>] | ||
| Line 1,402: | Line 1,402: | ||
os create secgroup-group-rule | os create secgroup-group-rule | ||
| − | </ | + | </source> |
| − | < | + | <source lang="bash"> |
nova secgroup-delete-group-rule [--ip_proto <ip_proto>] | nova secgroup-delete-group-rule [--ip_proto <ip_proto>] | ||
[--from_port <from_port>] | [--from_port <from_port>] | ||
| Line 1,412: | Line 1,412: | ||
os delete secgroup-group-rule ... | os delete secgroup-group-rule ... | ||
| − | </ | + | </source> |
'''secgroup-rule''' | '''secgroup-rule''' | ||
| − | < | + | <source lang="bash"> |
nova secgroup-add-rule <secgroup> <ip_proto> <from_port> <to_port> <cidr> | nova secgroup-add-rule <secgroup> <ip_proto> <from_port> <to_port> <cidr> | ||
os create secgroup-rule | os create secgroup-rule | ||
| − | </ | + | </source> |
| − | < | + | <source lang="bash"> |
nova secgroup-delete-rule <secgroup> <ip_proto> <from_port> <to_port> <cidr> | nova secgroup-delete-rule <secgroup> <ip_proto> <from_port> <to_port> <cidr> | ||
os delete secgroup-rule | os delete secgroup-rule | ||
| − | </ | + | </source> |
| − | < | + | <source lang="bash"> |
nova secgroup-list-rules <secgroup> | nova secgroup-list-rules <secgroup> | ||
os list secgroup-rule ... | os list secgroup-rule ... | ||
| − | </ | + | </source> |
'''server''' | '''server''' | ||
| − | < | + | <source lang="bash"> |
nova boot [--flavor <flavor>] | nova boot [--flavor <flavor>] | ||
[--image <image>] | [--image <image>] | ||
| Line 1,474: | Line 1,474: | ||
[--wait] | [--wait] | ||
<server-name> | <server-name> | ||
| − | </ | + | </source> |
| − | < | + | <source lang="bash"> |
nova delete <server> | nova delete <server> | ||
os delete server <server> | os delete server <server> | ||
| − | </ | + | </source> |
| − | < | + | <source lang="bash"> |
nova list [--reservation_id <reservation_id>] | nova list [--reservation_id <reservation_id>] | ||
[--ip <ip_regexp>] | [--ip <ip_regexp>] | ||
| Line 1,507: | Line 1,507: | ||
[--host <hostname>] | [--host <hostname>] | ||
[--all-tenants] | [--all-tenants] | ||
| − | </ | + | </source> |
| − | < | + | <source lang="bash"> |
nova lock <server> | nova lock <server> | ||
os lock server <server> | os lock server <server> | ||
| − | </ | + | </source> |
| − | < | + | <source lang="bash"> |
nova live-migration [--block_migrate] | nova live-migration [--block_migrate] | ||
[--disk_over_commit] | [--disk_over_commit] | ||
| Line 1,529: | Line 1,529: | ||
<host> | <host> | ||
os migrate server [--wait] <server> | os migrate server [--wait] <server> | ||
| − | </ | + | </source> |
| − | < | + | <source lang="bash"> |
nova pause <server> | nova pause <server> | ||
os pause server <server> | os pause server <server> | ||
| − | </ | + | </source> |
| − | < | + | <source lang="bash"> |
nova reboot [--hard] [--poll] <server> | nova reboot [--hard] [--poll] <server> | ||
os reboot server [--hard|--soft] [--wait] <server> | os reboot server [--hard|--soft] [--wait] <server> | ||
| − | </ | + | </source> |
| − | < | + | <source lang="bash"> |
nova rebuild [--rebuild_password <rebuild_password>] | nova rebuild [--rebuild_password <rebuild_password>] | ||
[--poll] | [--poll] | ||
| Line 1,556: | Line 1,556: | ||
[--wait] | [--wait] | ||
<server> | <server> | ||
| − | </ | + | </source> |
| − | < | + | <source lang="bash"> |
nova rename <server> <name> | nova rename <server> <name> | ||
os rename server <server> <new-name> | os rename server <server> <new-name> | ||
| − | </ | + | </source> |
| − | < | + | <source lang="bash"> |
nova rescue <server> | nova rescue <server> | ||
os rescue server <server> | os rescue server <server> | ||
| − | </ | + | </source> |
| − | < | + | <source lang="bash"> |
nova resize [--poll] <server> <flavor> | nova resize [--poll] <server> <flavor> | ||
os resize server --flavor <flavor> [--wait] <server> | os resize server --flavor <flavor> [--wait] <server> | ||
| − | </ | + | </source> |
| − | < | + | <source lang="bash"> |
nova resize-confirm <server> | nova resize-confirm <server> | ||
os resize server --confirm <server> | os resize server --confirm <server> | ||
| − | </ | + | </source> |
| − | < | + | <source lang="bash"> |
nova resume <server> | nova resume <server> | ||
os resume server <server> | os resume server <server> | ||
| − | </ | + | </source> |
| − | < | + | <source lang="bash"> |
nova resize-revert <server> | nova resize-revert <server> | ||
os resize server --revert <server> | os resize server --revert <server> | ||
| − | </ | + | </source> |
| − | < | + | <source lang="bash"> |
nova meta <server> <action> <key=value> [<key=value> ...] | nova meta <server> <action> <key=value> [<key=value> ...] | ||
| Line 1,612: | Line 1,612: | ||
[--meta-data <key>] ... | [--meta-data <key>] ... | ||
<server> | <server> | ||
| − | </ | + | </source> |
| − | < | + | <source lang="bash"> |
nova root-password <server> | nova root-password <server> | ||
os set server --root-password <server> | os set server --root-password <server> | ||
| − | </ | + | </source> |
| − | < | + | <source lang="bash"> |
nova show <server> | nova show <server> | ||
os show server <server> | os show server <server> | ||
| − | </ | + | </source> |
| − | < | + | <source lang="bash"> |
nova ssh [--port PORT] [--private] [--ipv6] [--login <login>] <server> | nova ssh [--port PORT] [--private] [--ipv6] [--login <login>] <server> | ||
| Line 1,638: | Line 1,638: | ||
[--login <login>] | [--login <login>] | ||
<server> | <server> | ||
| − | </ | + | </source> |
| − | < | + | <source lang="bash"> |
nova suspend <server> | nova suspend <server> | ||
os suspend server <server> | os suspend server <server> | ||
| − | </ | + | </source> |
| − | < | + | <source lang="bash"> |
nova unlock <server> | nova unlock <server> | ||
os unlock server <server> | os unlock server <server> | ||
| − | </ | + | </source> |
| − | < | + | <source lang="bash"> |
nova unpause <server> | nova unpause <server> | ||
os unpause server <server> | os unpause server <server> | ||
| − | </ | + | </source> |
| − | < | + | <source lang="bash"> |
nova unrescue <server> | nova unrescue <server> | ||
os unrescue server <server> | os unrescue server <server> | ||
| − | </ | + | </source> |
'''usage''' | '''usage''' | ||
| − | < | + | <source lang="bash"> |
nova usage-list [--start <start>] [--end <end>] | nova usage-list [--start <start>] [--end <end>] | ||
os list usage ... | os list usage ... | ||
| − | </ | + | </source> |
'''volume''' | '''volume''' | ||
| − | < | + | <source lang="bash"> |
nova volume-attach <server> <volume> <device> | nova volume-attach <server> <volume> <device> | ||
os attach volume ... | os attach volume ... | ||
| − | </ | + | </source> |
| − | < | + | <source lang="bash"> |
nova volume-create [--snapshot_id <snapshot_id>] | nova volume-create [--snapshot_id <snapshot_id>] | ||
[--display_name <display_name>] | [--display_name <display_name>] | ||
| Line 1,695: | Line 1,695: | ||
os create volume ... | os create volume ... | ||
| − | </ | + | </source> |
| − | < | + | <source lang="bash"> |
nova volume-delete <volume> | nova volume-delete <volume> | ||
os delete volume ... | os delete volume ... | ||
| − | </ | + | </source> |
| − | < | + | <source lang="bash"> |
nova volume-detach <server> <volume> | nova volume-detach <server> <volume> | ||
os detach volume ... | os detach volume ... | ||
| − | </ | + | </source> |
| − | < | + | <source lang="bash"> |
nova nova volume-list | nova nova volume-list | ||
os list volume | os list volume | ||
| − | </ | + | </source> |
| − | < | + | <source lang="bash"> |
nova volume-show <volume> | nova volume-show <volume> | ||
os show volume ... | os show volume ... | ||
| − | </ | + | </source> |
'''volume-snapshot''' | '''volume-snapshot''' | ||
| − | < | + | <source lang="bash"> |
nova volume-snapshot-create [--force <True|False>] | nova volume-snapshot-create [--force <True|False>] | ||
[--display_name <display_name>] | [--display_name <display_name>] | ||
| Line 1,735: | Line 1,735: | ||
os create volume-snapshot ... | os create volume-snapshot ... | ||
| − | </ | + | </source> |
| − | < | + | <source lang="bash"> |
nova volume-snapshot-delete <snapshot_id> | nova volume-snapshot-delete <snapshot_id> | ||
os delete volume-snapshot ... | os delete volume-snapshot ... | ||
| − | </ | + | </source> |
| − | < | + | <source lang="bash"> |
nova volume-snapshot-list | nova volume-snapshot-list | ||
os list volume-snapshot | os list volume-snapshot | ||
| − | </ | + | </source> |
| − | < | + | <source lang="bash"> |
nova volume-snapshot-show <snapshot> | nova volume-snapshot-show <snapshot> | ||
os show volume-snapshot | os show volume-snapshot | ||
| − | </ | + | </source> |
'''volume-type''' | '''volume-type''' | ||
| − | < | + | <source lang="bash"> |
nova volume-type-create <name> | nova volume-type-create <name> | ||
os create volume-type ... | os create volume-type ... | ||
| − | </ | + | </source> |
| − | < | + | <source lang="bash"> |
nova volume-type-delete <id> | nova volume-type-delete <id> | ||
os delete volume-type ... | os delete volume-type ... | ||
| − | </ | + | </source> |
| − | < | + | <source lang="bash"> |
nova volume-type-list | nova volume-type-list | ||
os list volume-type | os list volume-type | ||
| − | </ | + | </source> |
'''x509-cert''' | '''x509-cert''' | ||
| − | < | + | <source lang="bash"> |
nova x509-create-cert [<private_key_file>] [<x509_cert>] | nova x509-create-cert [<private_key_file>] [<x509_cert>] | ||
os create x509-cert ... | os create x509-cert ... | ||
| − | </ | + | </source> |
'''x509-root-cert''' | '''x509-root-cert''' | ||
| − | < | + | <source lang="bash"> |
nova x509-get-root-cert [<filename>] | nova x509-get-root-cert [<filename>] | ||
os show x509-root-cert ... | os show x509-root-cert ... | ||
| − | </ | + | </source> |
| Line 1,815: | Line 1,815: | ||
--timeout <seconds>,, ,, | --timeout <seconds>,, ,, | ||
--no-ssl-compression,, ,, | --no-ssl-compression,, ,, | ||
| − | </ | + | </pre></nowiki> |
| Line 1,822: | Line 1,822: | ||
'''image''' | '''image''' | ||
| − | < | + | <source lang="bash"> |
glance image-create [--id <IMAGE_ID>] [--name <NAME>] | glance image-create [--id <IMAGE_ID>] [--name <NAME>] | ||
[--disk-format <CONTAINER_FORMAT>] | [--disk-format <CONTAINER_FORMAT>] | ||
| Line 1,833: | Line 1,833: | ||
os create image ... | os create image ... | ||
| − | </ | + | </source> |
| − | < | + | <source lang="bash"> |
glance image-delete <IMAGE_ID> | glance image-delete <IMAGE_ID> | ||
os delete image ... | os delete image ... | ||
| − | </ | + | </source> |
| − | < | + | <source lang="bash"> |
glance image-list | glance image-list | ||
os list image ... | os list image ... | ||
| − | </ | + | </source> |
| − | < | + | <source lang="bash"> |
glance image-show <IMAGE_ID> | glance image-show <IMAGE_ID> | ||
os show image ... | os show image ... | ||
| − | </ | + | </source> |
| − | < | + | <source lang="bash"> |
glance member-images [options] <MEMBER> | glance member-images [options] <MEMBER> | ||
os list image --member <member> [options] | os list image --member <member> [options] | ||
| − | </ | + | </source> |
| − | < | + | <source lang="bash"> |
glance show [options] <ID> | glance show [options] <ID> | ||
os show image ... | os show image ... | ||
| − | </ | + | </source> |
| − | < | + | <source lang="bash"> |
glance update [options] <ID> <field1=value1 field2=value2 ...> | glance update [options] <ID> <field1=value1 field2=value2 ...> | ||
os set image ... | os set image ... | ||
| − | </ | + | </source> |
'''image-member''' | '''image-member''' | ||
| − | < | + | <source lang="bash"> |
glance member-create [--can-share] <IMAGE_ID> <TENANT_ID> | glance member-create [--can-share] <IMAGE_ID> <TENANT_ID> | ||
os create image-member ... | os create image-member ... | ||
| − | </ | + | </source> |
| − | < | + | <source lang="bash"> |
glance member-delete <IMAGE_ID> <TENANT_ID> | glance member-delete <IMAGE_ID> <TENANT_ID> | ||
os list image-member <image> [options] | os list image-member <image> [options] | ||
| − | </ | + | </source> |
| − | < | + | <source lang="bash"> |
glance member-delete [options] <ID> <MEMBER> | glance member-delete [options] <ID> <MEMBER> | ||
os delete image-member ... | os delete image-member ... | ||
| − | </ | + | </source> |
| − | < | + | <source lang="bash"> |
glance member-list [--image-id <IMAGE_ID>] [--tenant-id <TENANT_ID>] | glance member-list [--image-id <IMAGE_ID>] [--tenant-id <TENANT_ID>] | ||
os list image-member ... | os list image-member ... | ||
| − | </ | + | </source> |
| Line 1,919: | Line 1,919: | ||
--endpoint-type <type>,CINDER_ENDPOINT_TYPE, ,, | --endpoint-type <type>,CINDER_ENDPOINT_TYPE, ,, | ||
--retries <int>,, ,, | --retries <int>,, ,, | ||
| − | </ | + | </pre></nowiki> |
| Line 1,926: | Line 1,926: | ||
'''credentials''' | '''credentials''' | ||
| − | < | + | <source lang="bash"> |
cinder credentials | cinder credentials | ||
os list credential | os list credential | ||
| − | </ | + | </source> |
'''limits''' | '''limits''' | ||
| − | < | + | <source lang="bash"> |
cinder rate-limits | cinder rate-limits | ||
os list limit --rate | os list limit --rate | ||
| − | </ | + | </source> |
| − | < | + | <source lang="bash"> |
cinder absolute-limits | cinder absolute-limits | ||
os list limit --absolute | os list limit --absolute | ||
| − | </ | + | </source> |
'''snapshot''' | '''snapshot''' | ||
| − | < | + | <source lang="bash"> |
cinder snapshot-create | cinder snapshot-create | ||
<volume-id> | <volume-id> | ||
| Line 1,961: | Line 1,961: | ||
--display-description <display-description> | --display-description <display-description> | ||
<volume-id> | <volume-id> | ||
| − | </ | + | </source> |
| − | < | + | <source lang="bash"> |
cinder snapshot-delete <snapshot-id> | cinder snapshot-delete <snapshot-id> | ||
os delete snapshot <snapshot-id> | os delete snapshot <snapshot-id> | ||
| − | </ | + | </source> |
| − | < | + | <source lang="bash"> |
cinder snapshot-list | cinder snapshot-list | ||
--all-tenants [<0|1>] | --all-tenants [<0|1>] | ||
| Line 1,983: | Line 1,983: | ||
--status <status> | --status <status> | ||
--volume-id <volume-id> | --volume-id <volume-id> | ||
| − | </ | + | </source> |
| − | < | + | <source lang="bash"> |
cinder snapshot-rename | cinder snapshot-rename | ||
--display-description <display-description> | --display-description <display-description> | ||
| Line 1,996: | Line 1,996: | ||
<snapshot-id> | <snapshot-id> | ||
<display-name> | <display-name> | ||
| − | </ | + | </source> |
| − | < | + | <source lang="bash"> |
cinder snapshot-show <snapshot-id> | cinder snapshot-show <snapshot-id> | ||
os show snapshot <snapshot-id> | os show snapshot <snapshot-id> | ||
| − | </ | + | </source> |
'''type''' | '''type''' | ||
| − | < | + | <source lang="bash"> |
cinder type-create <type-name> | cinder type-create <type-name> | ||
os create type <type-name> | os create type <type-name> | ||
| − | </ | + | </source> |
| − | < | + | <source lang="bash"> |
cinder type-delete <type-id> | cinder type-delete <type-id> | ||
os delete type <type> | os delete type <type> | ||
| − | </ | + | </source> |
| − | < | + | <source lang="bash"> |
cinder type-list | cinder type-list | ||
os list type | os list type | ||
| − | </ | + | </source> |
| − | < | + | <source lang="bash"> |
cinder extra-specs-list | cinder extra-specs-list | ||
os tbd | os tbd | ||
| − | </ | + | </source> |
| − | < | + | <source lang="bash"> |
cinder type-key <type-name-or-id> <action (set|unset)> <key=value> | cinder type-key <type-name-or-id> <action (set|unset)> <key=value> | ||
os tbd | os tbd | ||
| − | </ | + | </source> |
'''volume''' | '''volume''' | ||
| − | < | + | <source lang="bash"> |
cinder create | cinder create | ||
[--snapshot-id <snapshot-id>] | [--snapshot-id <snapshot-id>] | ||
| Line 2,065: | Line 2,065: | ||
[--metadata [<key=value>]] | [--metadata [<key=value>]] | ||
<size> | <size> | ||
| − | </ | + | </source> |
| − | < | + | <source lang="bash"> |
cinder delete <volume-id> | cinder delete <volume-id> | ||
os delete volume <volume-id> | os delete volume <volume-id> | ||
| − | </ | + | </source> |
| − | < | + | <source lang="bash"> |
cinder list | cinder list | ||
--all-tenants [<0|1>] | --all-tenants [<0|1>] | ||
| Line 2,083: | Line 2,083: | ||
os list volume | os list volume | ||
--long | --long | ||
| − | </ | + | </source> |
| − | < | + | <source lang="bash"> |
cinder rename | cinder rename | ||
--display-description <display-description> | --display-description <display-description> | ||
| Line 2,096: | Line 2,096: | ||
<volume-id> | <volume-id> | ||
<display-name> | <display-name> | ||
| − | </ | + | </source> |
| − | < | + | <source lang="bash"> |
cinder show <volume-id> | cinder show <volume-id> | ||
os show volume <volume-id> | os show volume <volume-id> | ||
| − | </ | + | </source> |
| − | < | + | <source lang="bash"> |
cinder force-delete <volume-id> | cinder force-delete <volume-id> | ||
os tbd | os tbd | ||
| − | </ | + | </source> |
| − | < | + | <source lang="bash"> |
cinder metadata | cinder metadata | ||
<volume-id> | <volume-id> | ||
| Line 2,120: | Line 2,120: | ||
os tbd | os tbd | ||
| − | </ | + | </source> |
| Line 2,136: | Line 2,136: | ||
-t TOKEN|--token=TOKEN | -t TOKEN|--token=TOKEN | ||
--version=VERSION,QUANTUM_VERSION | --version=VERSION,QUANTUM_VERSION | ||
| − | </ | + | </pre></nowiki> |
| Line 2,150: | Line 2,150: | ||
'''iface''' | '''iface''' | ||
| − | < | + | <source lang="bash"> |
plug_iface <tenant-id> <net-id> <port-id> <iface-id> | plug_iface <tenant-id> <net-id> <port-id> <iface-id> | ||
add interface <tenant> <network> <port> <interface> | add interface <tenant> <network> <port> <interface> | ||
| − | </ | + | </source> |
| − | < | + | <source lang="bash"> |
show_iface <tenant-id> <net-id> <port-id> | show_iface <tenant-id> <net-id> <port-id> | ||
show interface <tenant> <network> <port> | show interface <tenant> <network> <port> | ||
| − | </ | + | </source> |
| − | < | + | <source lang="bash"> |
unplug_iface <tenant-id> <net-id> <port-id> | unplug_iface <tenant-id> <net-id> <port-id> | ||
remove interface <tenant> <network> <port> | remove interface <tenant> <network> <port> | ||
| − | </ | + | </source> |
'''net''' | '''net''' | ||
| − | < | + | <source lang="bash"> |
create_net <tenant-id> <net-name> | create_net <tenant-id> <net-name> | ||
create network <tenant> <network-name> | create network <tenant> <network-name> | ||
| − | </ | + | </source> |
| − | < | + | <source lang="bash"> |
delete_net <tenant-id> <net-id> | delete_net <tenant-id> <net-id> | ||
delete <tenant> <network> | delete <tenant> <network> | ||
| − | </ | + | </source> |
| − | < | + | <source lang="bash"> |
list_nets <tenant-id> | list_nets <tenant-id> | ||
list network <tenant> | list network <tenant> | ||
| − | </ | + | </source> |
| − | < | + | <source lang="bash"> |
list_nets_detail <tenant-id> | list_nets_detail <tenant-id> | ||
list network --detail <tenant> | list network --detail <tenant> | ||
| − | </ | + | </source> |
| − | < | + | <source lang="bash"> |
show_net <tenant-id> <net-id> | show_net <tenant-id> <net-id> | ||
show network <tenant> <network> | show network <tenant> <network> | ||
| − | </ | + | </source> |
| − | < | + | <source lang="bash"> |
show_net_detail <tenant-id> <net-id> | show_net_detail <tenant-id> <net-id> | ||
show network --detail <tenant> <network> | show network --detail <tenant> <network> | ||
| − | </ | + | </source> |
| − | < | + | <source lang="bash"> |
update_net <tenant-id> <net-id> <new-name> | update_net <tenant-id> <net-id> <new-name> | ||
set network <tenant> <network> --name <name> | set network <tenant> <network> --name <name> | ||
| − | </ | + | </source> |
'''port''' | '''port''' | ||
| − | < | + | <source lang="bash"> |
create_port <tenant-id> <net-id> | create_port <tenant-id> <net-id> | ||
create port <tenant> <network> | create port <tenant> <network> | ||
| − | </ | + | </source> |
| − | < | + | <source lang="bash"> |
delete_port <tenant-id> <net-id> <port-id> | delete_port <tenant-id> <net-id> <port-id> | ||
delete port <tenant> <network> <port> | delete port <tenant> <network> <port> | ||
| − | </ | + | </source> |
| − | < | + | <source lang="bash"> |
list_ports <tenant-id> <net-id> | list_ports <tenant-id> <net-id> | ||
list port <tenant> <network> | list port <tenant> <network> | ||
| − | </ | + | </source> |
| − | < | + | <source lang="bash"> |
list_ports_detail <tenant-id> <net-id> | list_ports_detail <tenant-id> <net-id> | ||
list port --detail <tenant> <network> | list port --detail <tenant> <network> | ||
| − | </ | + | </source> |
| − | < | + | <source lang="bash"> |
show_port <tenant-id> <net-id> <port-id> | show_port <tenant-id> <net-id> <port-id> | ||
show port <tenant> <network> <port> | show port <tenant> <network> <port> | ||
| − | </ | + | </source> |
| − | < | + | <source lang="bash"> |
show_port_detail <tenant-id> <net-id> <port-id> | show_port_detail <tenant-id> <net-id> <port-id> | ||
show port --detail <tenant> <network> <port> | show port --detail <tenant> <network> <port> | ||
| − | </ | + | </source> |
| − | < | + | <source lang="bash"> |
update_port <tenant-id> <net-id> <port-id> <params> | update_port <tenant-id> <net-id> <port-id> <params> | ||
set port <tenant> <network> <port> <params> | set port <tenant> <network> <port> <params> | ||
| − | </ | + | </source> |
Revision as of 23:13, 21 February 2013
Contents
OpenStackClient Commands
Part of the UnifiedCLI proposal
[Note that the use of the word object here is its generic meaning as the target of an action.]
Command Structure
Verbs
The verbs used by the default OpenStack clients have been mapped to the set below that attempts to define a consistent meaning to each action. Many of them have logical opposite actions. Those verbs with an opposite action is noted in parens if applicable.
-
add(remove) - add an object to a container which itself is usually another object; the command is built in the order of "add object1 to object2" (<object1>-<object2>), the positional arguments also appear in that order -
attach(detach) - connect two objects (is this different from add/remove?) -
create(delete) - create a new occurrance of the specified object -
delete(create) - delete a specific occurrance of the specified object -
detach(attach) - disconnect two objects (is this different from add/remove?) -
list- display summary information about multiple objects - lock (unlock)
-
migrate- move a server to a different host;--liveperforms a live migration if possible -
pause(unpause) - stop a server and leave it in memory -
reboot- forcibly reboot a server -
rebuild- rebuild a server using (most of) the same arguments as in the originalcreate -
remove(add) - remove an object from a group of objects -
rescue(unrescue) - reboot a server in a special rescue mode allowing access to the original disks -
resize- change a server's flavor -
resume(suspend) - return a suspended server to running state -
save- download an object locally -
set(unset) - set an attribute of the object, often calledmetadata -
show- display detailed information about the specifiec object -
ssh -
suspend(resume) - stop a server and save to disk freeing memory - unlock (lock)
-
unpause(pause) - return a paused server to running state -
unrescue(rescue) - return a server to normal boot mode -
unset(set) - remove an attribute of the object
Global Options
The common global options from the default OpenStack clients have been mapped to the set of global options below.
| Option | Environment Variable | OSC Option | Environment Variable | |
|---|---|---|---|---|
| --version | --version | |||
| --help | --help | |||
| --debug | --debug | |||
| --quiet | ||||
| --verbose | ||||
| --log-file <filename> | ||||
| --os-auth-url <url> | OS_AUTH_URL | --os-auth-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.
#!csv , Option, Description, Usual Default --description,describes an object, none --enable | --disable, Used for setting the enabled state for an object, n/a
Command Mapping Summary
This is an example mapping of the existing commands from Keystone (Identity), Nova (Compute), Glance (Image) and Cinder (Volume) to the <verb> <object> form for the OpenStackClient cli tool. It reduces both the number of verbs and objects by handling some of the smaller differences with command line options.
Further consolidation could be achieved by additional options or by introduction secondary objects to the syntax. For example, the credentials and x509-cert (and x509-root-cert) objects could be combined:
#!csv , , 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
Identity
#!csv , Keystone Option, Environment Variable, , OSC Option, Environment Variable --os-identity-api-version <ver>,OS_IDENTITY_API_VERSION, ,--os-identity-api-version <ver>,OS_IDENTITY_API_VERSION --os-token <token>,OS_SERVICE_TOKEN , ,--os-token <token>,OS_TOKEN --os-endpoint <url>,OS_SERVICE_ENDPOINT, ,--os-url <url>,OS_URL --os-cert <file>,OS_CERT, ,, --os-key <key-file>,OS_KEY, ,, --os-cache,OS_CACHE, ,, --force-new-token,, ,, --stale-duration <seconds>,, ,,
API v2.0
token
keystone token-get [--wrap <integer>]
os show token [--width <pki-token-display-width>]
catalog
keystone catalog [--service <service-type>]
os show service [--catalog <service-type>]
ec2-credentials
keystone ec2-credentials-create [--user <user-id>]
[--tenant_id <tenant-id>]
os create ec2-credentials --tenant_id <tenant-id> [--user <user-id>]
## are both args really optional?
keystone ec2-credentials-delete [--user <user-id>]
--access <access-key>
os delete ec2-credentials <access-key>
## what changes if --user is not provided?
keystone ec2-credentials-get [--user <user-id>]
--access <access-key>
os show ec2-credentials <access-key>
## what changes if --user is not provided?
keystone ec2-credentials-list [--user <user-id>]
os list ec2-credentials [--user <user-id>]
endpoint
keystone endpoint-create [--region <endpoint-region>]
[--service_id <service-id>]
[--publicurl <public-url>]
[--adminurl <admin-url>]
[--internalurl <internal-url>]
os create endpoint
[--region <endpoint-region>]
[--publicurl <public-url>]
[--adminurl <admin-url>]
[--internalurl <internal-url>]
<service>
keystone endpoint-delete <endpoint-id>
os delete endpoint <endpoint-id>
keystone endpoint-get --service <service-type>
[--endpoint_type <endpoint-type>]
[--attr <service-attribute>]
[--value <value>]
os show endpoint
[--type <endpoint-type>]
[--attr <endpoint-attribute>]
[--value <endpoint-value>]
<service>
os show endpoint
[--all]
<service>
keystone endpoint-list
os list endpoint [--long]
role
keystone role-create --name <role-name>
os create role <role-name>
keystone role-delete <role-id>
os delete role <role>
keystone role-get <role-id>
os show role <role>
keystone role-list
os list role
service
keystone service-create --name <name>
--type <type>
[--description <service-description>]
os create service
[--type <service-type>]
[--description <service-description>]
<service-name>
keystone service-delete <service-id>
os delete service <service>
keystone service-get <service-id>
os show service <service>
keystone service-list
os list service [--long]
tenant
keystone tenant-create --name <tenant-name>
[--description <tenant-description>]
[--enabled <true|false>]
os create tenant
[--description <tenant-description>]
[--enable | --disable]
<tenant-name>
keystone tenant-delete <tenant-id>
os delete tenant <tenant>
keystone tenant-get <tenant-id>
os show tenant <tenant>
keystone tenant-list
os list tenant [--long]
keystone tenant-update
[--name <tenant_name>]
[--description <tenant-description>]
[--enabled <true|false>]
<tenant-id>
os set tenant
[--name <new-tenant-name>]
[--description <new-tenant-description>]
[--enable | --disable]
<tenant>
user
keystone user-create --name <user-name>
[--tenant_id <tenant-id>]
[--pass <pass>]
[--email <email>]
[--enabled <true|false>]
os create user
[--password <user-password>]
[--email <user-email>]
[--tenant <tenant>]
[--enable | --disable]
<user-name>
keystone user-delete <user-id>
os delete user <user>
keystone user-get <user-id>
os show user <user>
keystone user-list [<tenant-id>]
os list user [--tenant <tenant>] [--long]
keystone user-password-update --pass <password> <user-id>
os set user
[--name <new-user-name>]
[--password <user-password>]
[--email <user-email>]
[--tenant <tenant>]
[--enable|--disable]
<user>
user-role
keystone user-role-add --user <user-id>
--role <role-id>
[--tenant_id <tenant-id>]
os add role-user
[--tenant <tenant>]
<role> <user>
keystone user-role-list [--user <user-id>]
[--tenant_id <tenant-id>]
os list role-user
[--tenant <tenant>]
[<user>]
keystone user-role-remove --user <user-id>
--role <role-id>
[--tenant_id <tenant-id>]
os remove role-user
[--tenant <tenant>]
<role> <user>
<other>
keystone bootstrap
--pass <password>
[--user-name <user-name>]
[--role-name <role-name>]
[--tenant-name <tenant-name>]
##TBD
keystone discover
##TBD
API v3
credential
keystone credential-create --user_id <user-id>
--type <credential-type>
--data <credential-data>
[--project_id <project-id>]
os create credential
[--project <project>]
<user>
<type>
<data>
keystone credential-delete <credential-id>
os delete credential <credential-id>
keystone credential-get <credential-id>
os show credential <credential-id>
keystone credential-list
os list credential [--long]
keystone credential-update
[--user <user>]
[--type <type>]
[--data <data>]
[--project <project>]
<credential-id>
os set credential
[--user <user>]
[--type <type>]
[--data <data>]
[--project <project>]
<credential-id>
domain
keystone domain-create --name <domain-name>
[--description <domain-description>]
[--enabled <true|false>]
[--private_project_names <true|false>]
[--private_user_names <true|false>]
os create domain
[--description <domain-description>]
[--enable | --disable]
[--private_project_names]
[--private_user_names]
<domain-name>
keystone domain-delete <domain-id>
os delete domain <domain>
keystone domain-get <domain-id>
os show domain <domain>
keystone domain-list
os list domain [--long]
keystone domain-update
[--name <domain_name>]
[--description <domain-description>]
[--enabled <true|false>]
[--private_project_names <true|false>]
[--private_user_names <true|false>]
<domain-id>
os set domain
[--name <new-domain-name>]
[--description <new-domain-description>]
[--private_project_names]
[--private_user_names]
[--enable | --disable]
<domain>
endpoint
keystone endpoint-create --service_id <service-id>
--interface <endpoint-interface>
--url <endpoint-url>
[--region <endpoint-region>]
[--enabled <true|false>]
os create endpoint
[--region <endpoint-region>]
[--enabled <true|false>]
<service-id>
<endpoint-interface>
<endpoint-url>
keystone endpoint-delete <endpoint-id>
os delete endpoint <endpoint-id>
keystone endpoint-list
os list endpoint [--long]
keystone enpoint-get <endpoint-id>
os show endpoint <endpoint-id>
keystone endpoint-update --endpoint_id <endpoint-id>
[--region <endpoint-region>]
[--enabled <true|false>]
[<service-id>]
[<endpoint-interface>]
[<endpoint-url>]
os update endpoint
[--region <endpoint-region>]
[--enabled <true|false>]
[--service <service-id>]
[--interface <endpoint-interface>]
[--url <endpoint-url>]
<endpoint-id>
group
keystone group-create --name <group-name>
[--domain_id <domain-id>]
[--description <group-description>]
os create group
[--domain <domain>]
[--description <group-description>]
<group-name>
keystone group-delete <group-id>
os delete group <group>
keystone group-get <group-id>
os show group <group>
keystone group-list
os list group [--long]
keystone group-update
[--name <group_name>]
[--domain_id <domain-id>]
[--description <group-description>]
<group-id>
os set group
[--name <new-group-name>]
[--domain <domain>]
[--description <new-group-description>]
<group>
policy
keystone policy-create --type <policy-type>
--blob <policy-blob>
os create policy
--type <policy-type>
--blob <policy-blob>
keystone policy-delete <policy-id>
os delete policy <policy-id>
keystone policy-get <policy-id>
os show policy <policy-id>
keystone policy-list
os list policy [--long]
keystone policy-update
[--type <policy-type>]
[--blob <policy-blob>]
<policy-id>
os set policy
[--type <policy-type>]
[--blob <policy-blob>]
<policy-id>
project
keystone project-create --name <project-name>
[--domain_id <project-domain-id>]
[--description <project-description>]
[--enabled <true|false>]
os create project
[--domain <project-domain>]
[--description <project-description>]
[--enable | --disable]
<project-name>
keystone project-delete <project-id>
os delete project <project>
keystone project-get <project-id>
os show project <project>
keystone project-list
os list project [--long]
keystone project-update
[--name <project_name>]
[--domain_id <project-domain-id>]
[--description <project-description>]
[--enabled <true|false>]
<project-id>
os set project
[--name <new-project-name>]
[--domain <project-domain>]
[--description <new-project-description>]
[--enable | --disable]
<project>
role
keystone role-create --name <role-name>
os create role <role-name>
keystone role-delete <role-id>
os delete role <role>
keystone role-get <role-id>
os show role <role>
keystone role-list
os list role
keystone role-update <role-id>
os update role <role>
service
keystone service-create --type <type>
[--name <name>]
[--enabled <true|false>]
os create service
[--name <name>]
[--enabled <true|false>]
<type>
keystone service-delete <service-id>
os delete service <service>
keystone service-get <service-id>
os show service <service>
keystone service-list
os list service [--long]
keystone service-update --service_id <service-id>
[--type <type>]
[--name <name>]
[--enabled <true|false>]
os update service
[--type <type>]
[--name <name>]
[--enabled <true|false>]
<service>
user
keystone user-create --name <user-name>
[--domain_id <domain-id>]
[--default_project_id <project-id>]
[--description <description>]
[--enabled <true|false>]
[--password <password>]
os create user
[--domain_id <domain-id>]
[--default_project_id <project-id>]
[--description <description>]
[--enabled <true|false>]
[--password <password>]
<user-name>
keystone user-delete <user-id>
os delete user <user>
keystone user-get <user-id>
os show user <user>
keystone user-list
os list user [--long]
keystone user-update --user_id <user-id>
[--name <user-name>]
[--domain_id <domain-id>]
[--default_project_id <project-id>]
[--description <description>]
[--enabled <true|false>]
[--password <password>]
os set user
[--domain_id <domain-id>]
[--default_project_id <project-id>]
[--description <description>]
[--enabled <true|false>]
[--password <password>]
[--user_name <user-name>]
<user>
Compute
#!csv , Nova Option, Environment Variable, , OSC 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)
aggregate
nova aggregate-create <name> <availability_zone>
os create aggregate ...
nova aggregate-delete <id>
os delete aggregate ...
nova aggregate-details <id>
os show aggregate ...
nova aggregate-list
os list aggregate
nova aggregate-update <id> <name> [<availability_zone>]
os set aggregate ...
nova aggregate-set-metadata <id> <key=value> [<key=value> ...]
os set aggregate --metadata ...
aggregate-host
nova aggregate-add-host <id> <host>
os add aggregate-host ...
nova aggregate-remove-host <id> <host>
os remove aggregate-host ...
bash-completion
nova bash-completion
os show bash-completion
cloudpipe
nova cloudpipe-create <project>
os create cloudpipe ...
nova cloudpipe-list
os list cloudpipe
console
nova console-log [--length <length>] <server>
os show console ...
nova get-vnc-console <server> <console_type>
os show console [--vnc] ...
credentials
nova credentials
os show credentials
diagnostics
nova diagnostics <server>
os show diagnostics ...
dns
nova dns-create [--type <type>] <ip> <name> <domain>
os create dns ...
nova dns-delete <domain> <name>
os delete dns ...
nova dns-list [--ip <ip>] [--name <name>] <domain>
os list dns ...
dns-domain
nova dns-create-private-domain [--availability_zone <availability_zone>]
<domain>
os create dns-domain [--private] ...
dns-public-domain
nova dns-create-public-domain [--project <project>] <domain>
os create dns-domain [--public] ...
nova dns-delete-domain <domain>
os delete dns-domain ...
nova dns-domains
os list dns-domains
endpoints
nova endpoints
os list endpoints
# does this overlap with keystone?
fixed-ip
nova add-fixed-ip <server> <network_id>
os add fixed-ip ...
nova remove-fixed-ip <server> <address>
os remove fixed-ip ...
flavor
nova flavor-create [--ephemeral <ephemeral>]
[--swap <swap>]
[--rxtx-factor <factor>]
<name> <id> <ram> <disk> <vcpus>
os create flavor ...
nova flavor-delete <id>
os delete flavor ...
nova flavor-list
os list flavor
floating-ip
nova add-floating-ip <server> <address>
os add floating-ip ...
nova floating-ip-create [<floating_ip_pool>]
os create floating-ip ...
nova floating-ip-delete <address>
os delete floating-ip
nova floating-ip-list
os list floating-ip
nova remove-floating-ip <server> <address>
os remove floating-ip ...
floating-ip-pool
nova floating-ip-pool-list
os list floating-ip-pool
host
nova host-action [--action <action>] <hostname>
os ?? host ...
nova host-update [--status <status>]
[--maintenance <maintenance_mode>]
<hostname>
os set host ...
image
nova image-create [--poll] <server> <name>
os create image ...
nova image-delete <image>
os delete image ...
nova image-list
os list image
nova image-meta <image> <action> <key=value> [<key=value> ...]
os set image ...
nova image-show <image>
os show image ...
keypair
nova keypair-add [--pub_key <pub_key>] <name>
os create keypair ...
nova keypair-delete <name>
os delete keypair
nova keypair-list
os list keypair
limits
nova absolute-limits
os show limits --absolute
## is there any other kind?
quota
nova quota-defaults <tenant_id>
nova quota-show <tenant_id>
os show quota <tenant> [--defaults]
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>
os set quota ...
quota-class
nova quota-class-show <class>
os show quota-class ...
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>
os set quota-class ...
rate-limits
nova rate-limits
os show rate-limits
resource
nova describe-resource <hostname>
os show resource ...
secgroup
nova secgroup-create <name> <description>
os create secgroup ...
nova secgroup-delete <secgroup>
os delete secgroup ...
nova secgroup-list
os list secgroup
secgroup-group-rule
nova secgroup-add-group-rule [--ip_proto <ip_proto>]
[--from_port <from_port>]
[--to_port <to_port>]
<secgroup> <source_group>
os create secgroup-group-rule
nova secgroup-delete-group-rule [--ip_proto <ip_proto>]
[--from_port <from_port>]
[--to_port <to_port>]
<secgroup> <source_group>
os delete secgroup-group-rule ...
secgroup-rule
nova secgroup-add-rule <secgroup> <ip_proto> <from_port> <to_port> <cidr>
os create secgroup-rule
nova secgroup-delete-rule <secgroup> <ip_proto> <from_port> <to_port> <cidr>
os delete secgroup-rule
nova secgroup-list-rules <secgroup>
os list secgroup-rule ...
server
nova boot [--flavor <flavor>]
[--image <image>]
[--meta <key=value>]
[--file <dst-path=src-path>]
[--key_name <key_name>]
[--user_data <user-data>]
[--availability_zone <availability-zone>]
[--security_groups <security_groups>]
[--block_device_mapping <dev_name=mapping>]
[--hint <key=value>]
[--nic <net-id=net-uuid,v4-fixed-ip=ip-addr>]
[--config-drive <value>]
[--poll]
<name>
os create server
--image <image>
--flavor <flavor>
[--security-group <security-group-list> [...] ]
[--key-name <key-name>]
[--meta-data <key=value> [--meta-data <key=value] [...] ]
[--file <dest-filename=source-filename> [--file <dest-filename=source-filename>] [...] ]
[--user-data <user-data>]
[--reservation-id <uuid>]
[--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>
nova delete <server>
os delete server <server>
nova list [--reservation_id <reservation_id>]
[--ip <ip_regexp>]
[--ip6 <ip6_regexp>]
[--name <name_regexp>]
[--instance_name <name_regexp>]
[--status <status>]
[--flavor <flavor>] [--image <image>]
[--host <hostname>]
[--all_tenants [<0|1>]]
os list server
[--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]
nova lock <server>
os lock server <server>
nova live-migration [--block_migrate]
[--disk_over_commit]
<server> <host>
nova migrate [--poll] <server>
os migrate server --live
[--block_migrate]
[--disk_over_commit]
<server>
<host>
os migrate server [--wait] <server>
nova pause <server>
os pause server <server>
nova reboot [--hard] [--poll] <server>
os reboot server [--hard|--soft] [--wait] <server>
nova rebuild [--rebuild_password <rebuild_password>]
[--poll]
<server> <image>
os rebuild server
--image <image>
[--rebuild-password <rebuild-password>]
[--wait]
<server>
nova rename <server> <name>
os rename server <server> <new-name>
nova rescue <server>
os rescue server <server>
nova resize [--poll] <server> <flavor>
os resize server --flavor <flavor> [--wait] <server>
nova resize-confirm <server>
os resize server --confirm <server>
nova resume <server>
os resume server <server>
nova resize-revert <server>
os resize server --revert <server>
nova meta <server> <action> <key=value> [<key=value> ...]
os set server
--meta-data <key=value>
[--meta-data <key=value>] ...
<server>
os unset server
--meta-data <key>
[--meta-data <key>] ...
<server>
nova root-password <server>
os set server --root-password <server>
nova show <server>
os show server <server>
nova ssh [--port PORT] [--private] [--ipv6] [--login <login>] <server>
os ssh server
[--port PORT]
[--private]
[--ipv6]
[--login <login>]
<server>
nova suspend <server>
os suspend server <server>
nova unlock <server>
os unlock server <server>
nova unpause <server>
os unpause server <server>
nova unrescue <server>
os unrescue server <server>
usage
nova usage-list [--start <start>] [--end <end>]
os list usage ...
volume
nova volume-attach <server> <volume> <device>
os attach volume ...
nova volume-create [--snapshot_id <snapshot_id>]
[--display_name <display_name>]
[--display_description <display_description>]
[--volume_type <volume_type>]
<size>
os create volume ...
nova volume-delete <volume>
os delete volume ...
nova volume-detach <server> <volume>
os detach volume ...
nova nova volume-list
os list volume
nova volume-show <volume>
os show volume ...
volume-snapshot
nova volume-snapshot-create [--force <True|False>]
[--display_name <display_name>]
[--display_description <display_description>]
<volume_id>
os create volume-snapshot ...
nova volume-snapshot-delete <snapshot_id>
os delete volume-snapshot ...
nova volume-snapshot-list
os list volume-snapshot
nova volume-snapshot-show <snapshot>
os show volume-snapshot
volume-type
nova volume-type-create <name>
os create volume-type ...
nova volume-type-delete <id>
os delete volume-type ...
nova volume-type-list
os list volume-type
x509-cert
nova x509-create-cert [<private_key_file>] [<x509_cert>]
os create x509-cert ...
x509-root-cert
nova x509-get-root-cert [<filename>]
os show x509-root-cert ...
Image
<nowiki>#!csv , Nova Option, Environment Variable, , OSC Option, Environment Variable --force,, ,, --dry-run,, ,, --os-image-url <url>,OS_IMAGE_URL, ,, --os-image-api-version <ver>,OS_IMAGE_API_VERSION, ,--os-image-api-version <ver>,OS_IMAGE_API_VERSION --os-service-type <type>,OS_SERVICE_TYPE, ,, --os-endpoint-type <type>,OS_ENDPOINT_TYPE, ,, --cert-file <file>,, ,, --key-file <file>,, ,, --timeout <seconds>,, ,, --no-ssl-compression,, ,,</nowiki>
API v2.0
image
glance image-create [--id <IMAGE_ID>] [--name <NAME>]
[--disk-format <CONTAINER_FORMAT>]
[--container-format <DISK_FORMAT>]
[--owner <TENANT_ID>] [--size <SIZE>]
[--min-disk <DISK_GB>] [--min-ram <DISK_RAM>]
[--location <IMAGE_URL>] [--checksum <CHECKSUM>]
[--copy-from <IMAGE_URL>] [--public] [--protected]
[--property <key=value>]
os create image ...
glance image-delete <IMAGE_ID>
os delete image ...
glance image-list
os list image ...
glance image-show <IMAGE_ID>
os show image ...
glance member-images [options] <MEMBER>
os list image --member <member> [options]
glance show [options] <ID>
os show image ...
glance update [options] <ID> <field1=value1 field2=value2 ...>
os set image ...
image-member
glance member-create [--can-share] <IMAGE_ID> <TENANT_ID>
os create image-member ...
glance member-delete <IMAGE_ID> <TENANT_ID>
os list image-member <image> [options]
glance member-delete [options] <ID> <MEMBER>
os delete image-member ...
glance member-list [--image-id <IMAGE_ID>] [--tenant-id <TENANT_ID>]
os list image-member ...
Volume
<nowiki>#!csv , 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>,, ,,</nowiki>
API v1.0
credentials
cinder credentials
os list credential
limits
cinder rate-limits
os list limit --rate
cinder absolute-limits
os list limit --absolute
snapshot
cinder snapshot-create
<volume-id>
--force <True|False>
--display-name <display-name>
--display-description <display-description>
os create snapshot
--force
--display-name <display-name>
--display-description <display-description>
<volume-id>
cinder snapshot-delete <snapshot-id>
os delete snapshot <snapshot-id>
cinder snapshot-list
--all-tenants [<0|1>]
--display-name <display-name>
--status <status>
--volume-id <volume-id>
os list snapshot
--all-tenants [<0|1>]
--display-name <display-name>
--status <status>
--volume-id <volume-id>
cinder snapshot-rename
--display-description <display-description>
<snapshot-id>
<display-name>
os update snapshot
--display-description <display-description>
<snapshot-id>
<display-name>
cinder snapshot-show <snapshot-id>
os show snapshot <snapshot-id>
type
cinder type-create <type-name>
os create type <type-name>
cinder type-delete <type-id>
os delete type <type>
cinder type-list
os list type
cinder extra-specs-list
os tbd
cinder type-key <type-name-or-id> <action (set|unset)> <key=value>
os tbd
volume
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>
os create volume
[--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>
cinder delete <volume-id>
os delete volume <volume-id>
cinder list
--all-tenants [<0|1>]
--display-name <display-name>
--status <status>
os list volume
--long
cinder rename
--display-description <display-description>
<volume-id>
<display-name>
os update volume
--display-description <display-description>
<volume-id>
<display-name>
cinder show <volume-id>
os show volume <volume-id>
cinder force-delete <volume-id>
os tbd
cinder metadata
<volume-id>
<action>
<key=value>
os tbd
Network
quantum
<nowiki>#!csv , Command-line Option,Environment Variable -H HOST|--host=HOST -p PORT|--port=PORT -s|--ssl -v|--verbose -f LOGFILE|--logfile=LOGFILE -t TOKEN|--token=TOKEN --version=VERSION,QUANTUM_VERSION</nowiki>
API v2.0
- Verbs:
- quantum: create, delete, list, plug, show, update, unplug
- os: add, create, delete, list, remove, set, show
- Objects:
- quantum: iface, net, port
- os: interface, network, port
iface
plug_iface <tenant-id> <net-id> <port-id> <iface-id>
add interface <tenant> <network> <port> <interface>
show_iface <tenant-id> <net-id> <port-id>
show interface <tenant> <network> <port>
unplug_iface <tenant-id> <net-id> <port-id>
remove interface <tenant> <network> <port>
net
create_net <tenant-id> <net-name>
create network <tenant> <network-name>
delete_net <tenant-id> <net-id>
delete <tenant> <network>
list_nets <tenant-id>
list network <tenant>
list_nets_detail <tenant-id>
list network --detail <tenant>
show_net <tenant-id> <net-id>
show network <tenant> <network>
show_net_detail <tenant-id> <net-id>
show network --detail <tenant> <network>
update_net <tenant-id> <net-id> <new-name>
set network <tenant> <network> --name <name>
port
create_port <tenant-id> <net-id>
create port <tenant> <network>
delete_port <tenant-id> <net-id> <port-id>
delete port <tenant> <network> <port>
list_ports <tenant-id> <net-id>
list port <tenant> <network>
list_ports_detail <tenant-id> <net-id>
list port --detail <tenant> <network>
show_port <tenant-id> <net-id> <port-id>
show port <tenant> <network> <port>
show_port_detail <tenant-id> <net-id> <port-id>
show port --detail <tenant> <network> <port>
update_port <tenant-id> <net-id> <port-id> <params>
set port <tenant> <network> <port> <params>
Options
In general, options will be transformed into more UNIX-like usage
-
--enable true|falsebecomes--enable|--disable
(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."
