openstack/openstack-manuals
Code Issues Proposed changes

Updates to 'Command Reference' appendix

Browse Source 
Included updates to the Command Reference appendix. New commands
and some consistency changes made to neutron, nova, keystone, heat,
swift and cinder sections.

Change-Id: I5bbd03062ca4205f4d7c1e75913bec292d6ac7fa
This commit is contained in:
Deepti Navale 2013-10-15 14:24:08 +10:00
parent 55a9263b53
commit 749dedae2d
6 changed files with 150 additions and 89 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doc/common/section_cinder_cli_commands.xml
View File

@ -5,7 +5,7 @@
xml:id="cinder_commands">
<title>cinder commands</title>
<para>The cinder client is the command-line interface for the
OpenStack Identity API.</para>
OpenStack Block Storage API.</para>
<para>For help on a specific cinder command, enter:</para>
<screen><prompt>$</prompt> <userinput><command>cinder</command> <option>help</option> <replaceable>COMMAND</replaceable></userinput></screen>
<example>

2
doc/common/section_heat_cli_commands.xml
View File

@ -24,6 +24,8 @@
<example>
<title>Positional arguments</title>
<screen><computeroutput>&lt;subcommand>
action-resume Resume the stack.
action-suspend Suspend the stack.
create DEPRECATED! Use stack-create instead
delete DEPRECATED! Use stack-delete instead
describe DEPRECATED! Use stack-show instead

6
doc/common/section_keystone_cli_commands.xml
View File

@ -50,7 +50,8 @@ keystone [--version] [--timeout &lt;seconds>]
service-create Add service to Service Catalog
service-delete Delete service from Service Catalog
service-get Display service from Service Catalog
service-list List all services in Service Catalog<?sbr?> tenant-create Create new tenant
service-list List all services in Service Catalog
tenant-create Create new tenant
tenant-delete Delete tenant
tenant-get Display tenant details
tenant-list List all tenants
@ -96,7 +97,8 @@ keystone [--version] [--timeout &lt;seconds>]
--os-region-name &lt;region-name>
Defaults to env[OS_REGION_NAME]
--os-identity-api-version &lt;identity-api-version>
Defaults to env[OS_IDENTITY_API_VERSION] or 2.0<?sbr?> --os-token &lt;service-token>
Defaults to env[OS_IDENTITY_API_VERSION] or 2.0
--os-token &lt;service-token>
Specify an existing token to use instead of retrieving
one via authentication (e.g. with username &amp;
password). Defaults to env[OS_SERVICE_TOKEN]

130
doc/common/section_neutron_cli_commands.xml
View File

@ -14,54 +14,55 @@
<screen><computeroutput> neutron [--version] [-v] [-q] [-h] [--debug]
[--os-auth-strategy &lt;auth-strategy>] [--os-auth-url &lt;auth-url>]
[--os-tenant-name &lt;auth-tenant-name>]
[--os-tenant-id &lt;auth-tenant-id>]
[--os-username &lt;auth-username>] [--os-password &lt;auth-password>]
[--os-region-name &lt;auth-region-name>] [--os-token &lt;token>]
[--endpoint-type &lt;endpoint-type>] [--os-url &lt;url>] [--insecure]</computeroutput></screen>
[--endpoint-type &lt;endpoint-type>] [--os-url &lt;url>]
[--os-cacert &lt;ca-certificate>] [--insecure]</computeroutput></screen>
</example>
<example>
<title>Optional arguments</title>
<screen><computeroutput> --version show program's version number and exit
-v, --verbose Increase verbosity of output. Can be repeated.
-q, --quiet suppress output except warnings and errors
-h, --help show this help message and exit
--debug show tracebacks on errors
--os-auth-strategy &lt;auth-strategy>
Authentication strategy (Env: OS_AUTH_STRATEGY,
default keystone). For now, any other value will
disable the authentication
--os-auth-url &lt;auth-url>
Authentication URL (Env: OS_AUTH_URL)
--os-tenant-name &lt;auth-tenant-name>
Authentication tenant name (Env: OS_TENANT_NAME)
--os-username &lt;auth-username>
Authentication username (Env: OS_USERNAME)
--os-password &lt;auth-password>
Authentication password (Env: OS_PASSWORD)
--os-region-name &lt;auth-region-name>
Authentication region name (Env: OS_REGION_NAME)
--os-token &lt;token> Defaults to env[OS_TOKEN]
--endpoint-type &lt;endpoint-type>
Defaults to env[OS_ENDPOINT_TYPE] or publicURL.
--os-url &lt;url> Defaults to env[OS_URL]
--insecure Explicitly allow neutronclient to perform "insecure"
SSL (https) requests. The server's certificate will
not be verified against any certificate authorities.
This option should be used with caution.</computeroutput></screen>
</example>
<example>
<title>Commands</title>
<title>Positional Arguments</title>
<screen><computeroutput> agent-delete Delete a given agent.
<screen><computeroutput>
agent-delete Delete a given agent.
agent-list List agents.
agent-show Show information of a given agent.
agent-update Update a given agent.
cisco-credential-create Creates a credential.
cisco-credential-delete Delete a given credential.
cisco-credential-list List credentials that belong to a given tenant.
cisco-credential-show Show information of a given credential.
cisco-network-profile-create Creates a network profile.
cisco-network-profile-delete Delete a given network profile.
cisco-network-profile-list List network profiles that belong to a given tenant.
cisco-network-profile-show Show information of a given network profile.
cisco-network-profile-update Update network profile's information.
cisco-policy-profile-list List policy profiles that belong to a given tenant.
cisco-policy-profile-show Show information of a given policy profile.
cisco-policy-profile-update Update policy profile's information.
dhcp-agent-list-hosting-net List DHCP agents hosting a network.
dhcp-agent-network-add Add a network to a DHCP agent.
dhcp-agent-network-remove Remove a network from a DHCP agent.
ext-list List all extensions.
ext-show Show information of a given resource.
firewall-create Create a firewall.
firewall-delete Delete a given firewall.
firewall-list List firewalls that belong to a given tenant.
firewall-policy-create Create a firewall policy.
firewall-policy-delete Delete a given firewall policy.
firewall-policy-insert-rule Insert a rule into a given firewall policy.
firewall-policy-list List firewall policies that belong to a given tenant.
firewall-policy-remove-rule Remove a rule from a given firewall policy.
firewall-policy-show Show information of a given firewall policy.
firewall-policy-update Update a given firewall policy.
firewall-rule-create Create a firewall rule.
firewall-rule-delete Delete a given firewall rule.
firewall-rule-list List firewall rules that belong to a given tenant.
firewall-rule-show Show information of a given firewall rule.
firewall-rule-update Update a given firewall rule.
firewall-show Show information of a given firewall.
firewall-update Update a given firewall.
floatingip-associate Create a mapping between a floating ip and a fixed ip.
floatingip-create Create a floating ip for a given tenant.
floatingip-delete Delete a given floating ip.
@ -69,9 +70,15 @@
floatingip-list List floating ips that belong to a given tenant.
floatingip-show Show information of a given floating ip.
help print detailed help for another command
ipsec-site-connection-create Create an IPsecSiteConnection.
ipsec-site-connection-delete Delete a given IPsecSiteConnection.
ipsec-site-connection-list List IPsecSiteConnections that belong to a given tenant.
ipsec-site-connection-show Show information of a given IPsecSiteConnection.
ipsec-site-connection-update Update a given IPsecSiteConnection.
l3-agent-list-hosting-router List L3 agents hosting a router.
l3-agent-router-add Add a router to a L3 agent.
l3-agent-router-remove Remove a router from a L3 agent.
lb-agent-hosting-pool Get loadbalancer agent hosting a pool.
lb-healthmonitor-associate Create a mapping between a health monitor and a pool.
lb-healthmonitor-create Create a healthmonitor.
lb-healthmonitor-delete Delete a given healthmonitor.
@ -87,6 +94,7 @@
lb-pool-create Create a pool.
lb-pool-delete Delete a given pool.
lb-pool-list List pools that belong to a given tenant.
lb-pool-list-on-agent List the pools on a loadbalancer agent.
lb-pool-show Show information of a given pool.
lb-pool-stats Retrieve stats for a given pool.
lb-pool-update Update a given pool.
@ -95,7 +103,7 @@
lb-vip-list List vips that belong to a given tenant.
lb-vip-show Show information of a given vip.
lb-vip-update Update a given vip.
<?sbr?> net-create Create a network for a given tenant.
net-create Create a network for a given tenant.
net-delete Delete a given network.
net-external-list List external networks that belong to a given tenant.
net-gateway-connect Add an internal network interface to a router.
@ -142,10 +150,60 @@
security-group-rule-show Show information of a given security group rule.
security-group-show Show information of a given security group.
security-group-update Update a given security group.
service-provider-list List service providers.
subnet-create Create a subnet for a given tenant.
subnet-delete Delete a given subnet.
subnet-list List networks that belong to a given tenant.
subnet-show Show information of a given subnet.
subnet-update Update subnet's information.</computeroutput></screen>
subnet-update Update subnet's information.
vpn-ikepolicy-create Create an IKEPolicy.
vpn-ikepolicy-delete Delete a given IKE Policy.
vpn-ikepolicy-list List IKEPolicies that belong to a tenant.
vpn-ikepolicy-show Show information of a given IKEPolicy.
vpn-ikepolicy-update Update a given IKE Policy.
vpn-ipsecpolicy-create Create an ipsecpolicy.
vpn-ipsecpolicy-delete Delete a given ipsecpolicy.
vpn-ipsecpolicy-list List ipsecpolicies that belongs to a given tenant connection.
vpn-ipsecpolicy-show Show information of a given ipsecpolicy.
vpn-ipsecpolicy-update Update a given ipsec policy.
vpn-service-create Create a VPNService.
vpn-service-delete Delete a given VPNService.
vpn-service-list List VPNService configurations that belong to a given tenant.
vpn-service-show Show information of a given VPNService.
vpn-service-update Update a given VPNService.
</computeroutput></screen>
</example>
<example>
<title>Optional arguments</title>
<screen><computeroutput> --version show program's version number and exit
-v, --verbose Increase verbosity of output. Can be repeated.
-q, --quiet suppress output except warnings and errors
-h, --help show this help message and exit
--debug show tracebacks on errors
--os-auth-strategy &lt;auth-strategy>
Authentication strategy (Env: OS_AUTH_STRATEGY,
default keystone). For now, any other value will
disable the authentication
--os-auth-url &lt;auth-url>
Authentication URL (Env: OS_AUTH_URL)
--os-tenant-name &lt;auth-tenant-name>
Authentication tenant name (Env: OS_TENANT_NAME)
--os-tenant-id &lt;auth-tenant-id>
Authentication tenant name (Env: OS_TENANT_ID)
--os-username &lt;auth-username>
Authentication username (Env: OS_USERNAME)
--os-password &lt;auth-password>
Authentication password (Env: OS_PASSWORD)
--os-region-name &lt;auth-region-name>
Authentication region name (Env: OS_REGION_NAME)
--os-token &lt;token> Defaults to env[OS_TOKEN]
--endpoint-type &lt;endpoint-type>
Defaults to env[OS_ENDPOINT_TYPE] or publicURL.
--os-url &lt;url> Defaults to env[OS_URL]
--insecure Explicitly allow neutronclient to perform "insecure"
SSL (https) requests. The server's certificate will
not be verified against any certificate authorities.
This option should be used with caution.</computeroutput></screen>
</example>
</section>

28
doc/common/section_nova_cli_commands.xml
View File

@ -13,7 +13,8 @@
<screen><computeroutput>nova [--version] [--debug] [--os-cache] [--timings]
[--timeout &lt;seconds>] [--os-username &lt;auth-user-name>]
[--os-password &lt;auth-password>]
[--os-tenant-name &lt;auth-tenant-name>] [--os-auth-url &lt;auth-url>]
[--os-tenant-name &lt;auth-tenant-name>]
[--os-tenant-id &lt;auth-tenant-id>] [--os-auth-url &lt;auth-url>]
[--os-region-name &lt;region-name>] [--os-auth-system &lt;auth-system>]
[--service-type &lt;service-type>] [--service-name &lt;service-name>]
[--volume-service-name &lt;volume-service-name>]
@ -125,6 +126,7 @@
keypair-delete Delete keypair by its name.
keypair-list Print a list of keypairs for a user.
list List active servers.
list-secgroup List Security Group(s) of a server.
live-migration Migrates a running instance to a new machine.
lock Lock a server.
meta Set or Delete metadata on a server.
@ -209,6 +211,7 @@
volume-type-create Create a new volume type.
volume-type-delete Delete a specific flavor.
volume-type-list Print a list of available 'volume types'.
volume-update Update volume attachment.
x509-create-cert Create x509 cert for a user in tenant.
x509-get-root-cert Fetches the x509 root cert.
bash-completion Prints out a list of all possible commands and flags
@ -216,6 +219,17 @@
for tab-completion of commands.
help Display help about this program or one of its
subcommands.
cell-capacities Get cell capacities for all cells or a given cell.
cell-show Show details of a given cell.
host-servers-migrate
Migrate all instances of the specified host to other
available hosts.
net Show a network
net-create Create a network
net-delete Delete a network
net-list List networks
force-delete Force delete a server.
restore Restore a soft-deleted server.
baremetal-interface-add
Add a network interface to a baremetal node.
baremetal-interface-list
@ -231,17 +245,17 @@
Print a list of available baremetal nodes.
baremetal-node-show
Show information about a baremetal node.
migration-list Print a list of migrations.
host-meta Set or Delete metadata on all instances of a host.
host-evacuate Evacuate all instances from failed host to specified
one.
instance-action Show an action.
instance-action-list
List actions on a server.
list-extensions List all the os-api extensions that are available.
host-meta Set or Delete metadata on all instances of a host.
net Show a network.
net-create Create a network.
net-delete Delete a network.
net-list List networks</computeroutput></screen>
instance-action Show an action.
instance-action-list
List actions on a server.</computeroutput></screen>
</example>
<example>
<title>Optional arguments</title>
@ -257,6 +271,8 @@
Defaults to env[OS_PASSWORD].
--os-tenant-name &lt;auth-tenant-name>
Defaults to env[OS_TENANT_NAME].
--os-tenant-id &lt;auth-tenant-id>
Defaults to env[OS_TENANT_ID].
--os-auth-url &lt;auth-url>
Defaults to env[OS_AUTH_URL].
--os-region-name &lt;region-name>

71
doc/common/section_swift_cli_commands.xml
View File

@ -8,53 +8,36 @@
OpenStack Object Storage API.</para>
<para>For help on a specific swift command, enter:</para>
<screen><prompt>$</prompt> <userinput>swift <option>help</option> <replaceable>COMMAND</replaceable></userinput></screen>
<example>
<title>Usage</title>
<screen><prompt>$</prompt> <userinput><command>swift</command> <replaceable>COMMAND</replaceable> <option>[options]</option> <option>[args]</option></userinput></screen>
<example>
<title>Usage</title>
<screen><computeroutput>swift [--version] [--help] [--snet] [--verbose]
[--debug] [--quiet] [--auth &lt;auth_url>]
[--auth-version &lt;auth_version>] [--user &lt;username>]
[--key &lt;api_key>] [--retries &lt;num_retries>]
[--os-username &lt;auth-user-name>] [--os-password &lt;auth-password>]
[--os-tenant-name &lt;auth-tenant-name>]
[--os-tenant-id &lt;auth-tenant-id>]
[--os-auth-url &lt;auth-url>] [--os-auth-token &lt;auth-token>]
[--os-storage-url &lt;storage-url>] [--os-region-name &lt;region-name>]
[--os-service-type &lt;service-type>]
[--os-endpoint-type &lt;endpoint-type>]
[--os-cacert &lt;ca-certificate>] [--insecure]
[--no-ssl-compression]
&lt;subcommand> ... </computeroutput></screen>
</example>
<example>
<title>Commands</title>
<screen><computeroutput> stat [container] [object]
Displays information for the account, container, or object depending on the
args given (if any).
list [options] [container]
Lists the containers for the account or the objects for a container. -p or
--prefix is an option that will only list items beginning with that prefix.
-l produces output formatted like 'ls -l' and --lh like 'ls -lh'.
-d or --delimiter is option (for container listings only) that will roll up
items with the given delimiter (see http://docs.openstack.org/
api/openstack-object-storage/1.0/content/list-objects.html)
upload [options] container file_or_directory [file_or_directory] [...]
Uploads to the given container the files and directories specified by the
remaining args. -c or --changed is an option that will only upload files
that have changed since the last upload. -S &lt;size> or --segment-size &lt;size>
will upload the files in segments no larger than size. -C &lt;container> or
--segment-container &lt;container> will specify the location of the segments
to &lt;container>. --leave-segments are options as well (see --help for more).
post [options] [container] [object]
Updates meta information for the account, container, or object depending on
the args given. If the container is not found, it will be created
automatically; but this is not true for accounts and objects. Containers
also allow the -r (or --read-acl) and -w (or --write-acl) options. The -m
or --meta option is allowed on all and used to define the user meta data
items to set in the form Name:Value. This option can be repeated. Example:
post -m Color:Blue -m Size:Large
download --all OR download container [options] [object] [object] ...
Downloads everything in the account (with --all), or everything in a
container, or a list of objects depending on the args given. For a single
object download, you may use the -o [--output] &lt;filename> option to
redirect the output to a specific file or if "-" then just redirect to
stdout.
delete [options] --all OR delete container [options] [object] [object] ...
Deletes everything in the account (with --all), or everything in a
container, or a list of objects depending on the args given. Segments of
manifest objects will be deleted as well, unless you specify the
--leave-segments option.</computeroutput></screen>
<screen><computeroutput>&lt;subcommand>
delete Delete a container or objects within a container
download Download objects from containers
list Lists the containers for the account or the objects
for a container
post Updates meta information for the account, container,
or object
stat Displays information for the account, container,
or object
upload Uploads files or directories to the given container
</computeroutput></screen>
</example>
<example>
<title>Examples</title>