Attachment 700150 Details for Bug 904350 – nova man page

[patch] nova man page

nova.1 (text/plain), 9.18 KB, created by Russell Bryant on 2013-02-20 17:49:11 UTC

(hide)

Description:

Filename:

MIME Type:

Creator: Russell Bryant

Created: 2013-02-20 17:49:11 UTC

Size: 9.18 KB

patch

obsolete

>.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.40.12.
>.TH NOVA "1" "February 2013" "nova 2.10.0" "User Commands"
>.SH NAME
>nova \- Client for the OpenStack Compute API
>.SH DESCRIPTION
>usage: nova [\-\-version] [\-\-debug] [\-\-no\-cache] [\-\-timings]
>.IP
>[\-\-os\-username <auth\-user\-name>] [\-\-os\-password <auth\-password>]
>[\-\-os\-tenant\-name <auth\-tenant\-name>] [\-\-os\-auth\-url <auth\-url>]
>[\-\-os\-region\-name <region\-name>] [\-\-os\-auth\-system <auth\-system>]
>[\-\-service\-type <service\-type>] [\-\-service\-name <service\-name>]
>[\-\-volume\-service\-name <volume\-service\-name>]
>[\-\-endpoint\-type <endpoint\-type>]
>[\-\-os\-compute\-api\-version <compute\-api\-ver>] [\-\-insecure]
>[\-\-bypass\-url <bypass\-url>]
><subcommand> ...
>.PP
>Command\-line interface to the OpenStack Nova API.
>.SS "Positional arguments:"
>.IP
><subcommand>
>.TP
>absolute\-limits
>Print a list of absolute limits for a user
>.TP
>actions
>Retrieve server actions.
>.TP
>add\-fixed\-ip
>Add new IP address to network.
>.TP
>add\-floating\-ip
>Add a floating IP address to a server.
>.TP
>add\-secgroup
>Add a Security Group to a server.
>.TP
>aggregate\-add\-host
>Add the host to the specified aggregate.
>.TP
>aggregate\-create
>Create a new aggregate with the specified details.
>.TP
>aggregate\-delete
>Delete the aggregate by its id.
>.TP
>aggregate\-details
>Show details of the specified aggregate.
>.TP
>aggregate\-list
>Print a list of all aggregates.
>.IP
>aggregate\-remove\-host
>.IP
>Remove the specified host from the specified
>aggregate.
>.IP
>aggregate\-set\-metadata
>.IP
>Update the metadata associated with the aggregate.
>.TP
>aggregate\-update
>Update the aggregate's name and optionally
>availability zone.
>.TP
>backup
>Backup a instance by create a 'backup' type snapshot
>.TP
>boot
>Boot a new server.
>.IP
>cloudpipe\-configure
>.IP
>Create a cloudpipe instance for the given project
>.TP
>cloudpipe\-create
>Create a cloudpipe instance for the given project
>.TP
>cloudpipe\-list
>Print a list of all cloudpipe instances.
>.TP
>console\-log
>Get console log output of a server.
>.TP
>credentials
>Show user credentials returned from auth
>.TP
>delete
>Immediately shut down and delete specified server(s).
>.TP
>diagnostics
>Retrieve server diagnostics.
>.TP
>dns\-create
>Create a DNS entry for domain, name and ip.
>.IP
>dns\-create\-private\-domain
>.IP
>Create the specified DNS domain.
>.IP
>dns\-create\-public\-domain
>.IP
>Create the specified DNS domain.
>.TP
>dns\-delete
>Delete the specified DNS entry.
>.TP
>dns\-delete\-domain
>Delete the specified DNS domain.
>.TP
>dns\-domains
>Print a list of available dns domains.
>.TP
>dns\-list
>List current DNS entries for domain and ip or domain
>and name.
>.TP
>endpoints
>Discover endpoints that get returned from the
>authenticate services
>.TP
>fixed\-ip\-get
>Get info on a fixed ip
>.TP
>fixed\-ip\-reserve
>Reserve a fixed ip
>.TP
>fixed\-ip\-unreserve
>Unreserve a fixed ip
>.TP
>flavor\-access\-add
>Add flavor access for the given tenant.
>.TP
>flavor\-access\-list
>Print access information about the given flavor.
>.IP
>flavor\-access\-remove
>.IP
>Remove flavor access for the given tenant.
>.TP
>flavor\-create
>Create a new flavor
>.TP
>flavor\-delete
>Delete a specific flavor
>.TP
>flavor\-key
>Set or unset extra_spec for a flavor.
>.TP
>flavor\-list
>Print a list of available 'flavors' (sizes of
>servers).
>.TP
>flavor\-show
>Show details about the given flavor.
>.TP
>floating\-ip\-create
>Allocate a floating IP for the current tenant.
>.TP
>floating\-ip\-delete
>De\-allocate a floating IP.
>.TP
>floating\-ip\-list
>List floating ips for this tenant.
>.IP
>floating\-ip\-pool\-list
>.IP
>List all floating ip pools.
>.TP
>get\-vnc\-console
>Get a vnc console to a server.
>.TP
>host\-action
>Perform a power action on a host.
>.TP
>host\-describe
>Describe a specific host
>.TP
>host\-list
>List all hosts by service
>.TP
>host\-update
>Update host settings.
>.TP
>hypervisor\-list
>List hypervisors.
>.TP
>hypervisor\-servers
>List instances belonging to specific hypervisors.
>.TP
>hypervisor\-show
>Display the details of the specified hypervisor.
>.TP
>hypervisor\-stats
>Get hypervisor statistics over all compute nodes.
>.TP
>hypervisor\-uptime
>Display the uptime of the specified hypervisor.
>.TP
>image\-create
>Create a new image by taking a snapshot of a running
>server.
>.TP
>image\-delete
>Delete an image.
>.TP
>image\-list
>Print a list of available images to boot from.
>.TP
>image\-meta
>Set or Delete metadata on an image.
>.TP
>image\-show
>Show details about the given image.
>.TP
>keypair\-add
>Create a new key pair for use with instances
>.TP
>keypair\-delete
>Delete keypair by its id
>.TP
>keypair\-list
>Print a list of keypairs for a user
>.TP
>list
>List active servers.
>.TP
>live\-migration
>Migrates a running instance to a new machine.
>.TP
>lock
>Lock a server.
>.TP
>meta
>Set or Delete metadata on a server.
>.TP
>migrate
>Migrate a server. The new host will be selected by the
>scheduler.
>.TP
>network\-list
>Print a list of available networks.
>.TP
>network\-show
>Show details about the given network.
>.TP
>pause
>Pause a server.
>.TP
>quota\-class\-show
>List the quotas for a quota class.
>.TP
>quota\-class\-update
>Update the quotas for a quota class.
>.TP
>quota\-defaults
>List the default quotas for a tenant.
>.TP
>quota\-show
>List the quotas for a tenant.
>.TP
>quota\-update
>Update the quotas for a tenant.
>.TP
>rate\-limits
>Print a list of rate limits for a user
>.TP
>reboot
>Reboot a server.
>.TP
>rebuild
>Shutdown, re\-image, and re\-boot a server.
>.TP
>remove\-fixed\-ip
>Remove an IP address from a server.
>.TP
>remove\-floating\-ip
>Remove a floating IP address from a server.
>.TP
>remove\-secgroup
>Remove a Security Group from a server.
>.TP
>rename
>Rename a server.
>.TP
>rescue
>Rescue a server.
>.TP
>reset\-state
>Reset the state of an instance
>.TP
>resize
>Resize a server.
>.TP
>resize\-confirm
>Confirm a previous resize.
>.TP
>resize\-revert
>Revert a previous resize (and return to the previous
>VM).
>.TP
>resume
>Resume a server.
>.TP
>root\-password
>Change the root password for a server.
>.IP
>secgroup\-add\-group\-rule
>.IP
>Add a source group rule to a security group.
>.TP
>secgroup\-add\-rule
>Add a rule to a security group.
>.TP
>secgroup\-create
>Create a security group.
>.TP
>secgroup\-delete
>Delete a security group.
>.IP
>secgroup\-delete\-group\-rule
>.IP
>Delete a source group rule from a security group.
>.IP
>secgroup\-delete\-rule
>.IP
>Delete a rule from a security group.
>.TP
>secgroup\-list
>List security groups for the current tenant.
>.IP
>secgroup\-list\-rules
>.IP
>List rules for a security group.
>.TP
>service\-disable
>Enable the service
>.TP
>service\-enable
>Enable the service
>.TP
>service\-list
>Show a list of all running services. Filter by host &
>service name.
>.TP
>show
>Show details about the given server.
>.TP
>ssh
>SSH into a server.
>.TP
>start
>Start a server.
>.TP
>stop
>Stop a server.
>.TP
>suspend
>Suspend a server.
>.TP
>unlock
>Unlock a server.
>.TP
>unpause
>Unpause a server.
>.TP
>unrescue
>Unrescue a server.
>.TP
>usage\-list
>List usage data for all tenants
>.TP
>volume\-attach
>Attach a volume to a server.
>.TP
>volume\-create
>Add a new volume.
>.TP
>volume\-delete
>Remove a volume.
>.TP
>volume\-detach
>Detach a volume from a server.
>.TP
>volume\-list
>List all the volumes.
>.TP
>volume\-show
>Show details about a volume.
>.IP
>volume\-snapshot\-create
>.IP
>Add a new snapshot.
>.IP
>volume\-snapshot\-delete
>.IP
>Remove a snapshot.
>.IP
>volume\-snapshot\-list
>.IP
>List all the snapshots.
>.IP
>volume\-snapshot\-show
>.IP
>Show details about a snapshot.
>.TP
>volume\-type\-create
>Create a new volume type.
>.TP
>volume\-type\-delete
>Delete a specific flavor
>.TP
>volume\-type\-list
>Print a list of available 'volume types'.
>.TP
>x509\-create\-cert
>Create x509 cert for a user in tenant
>.TP
>x509\-get\-root\-cert
>Fetches the x509 root cert.
>.TP
>bash\-completion
>Prints all of the commands and options to stdout so
>that the
>.TP
>help
>Display help about this program or one of its
>subcommands.
>.TP
>list\-extensions
>List all the os\-api extensions that are available.
>.SS "Optional arguments:"
>.TP
>\fB\-\-version\fR
>show program's version number and exit
>.TP
>\fB\-\-debug\fR
>Print debugging output
>.TP
>\fB\-\-no\-cache\fR
>Don't use the auth token cache.
>.TP
>\fB\-\-timings\fR
>Print call timing info
>.TP
>\fB\-\-os\-username\fR <auth\-user\-name>
>Defaults to env[OS_USERNAME].
>.TP
>\fB\-\-os\-password\fR <auth\-password>
>Defaults to env[OS_PASSWORD].
>.TP
>\fB\-\-os\-tenant\-name\fR <auth\-tenant\-name>
>Defaults to env[OS_TENANT_NAME].
>.TP
>\fB\-\-os\-auth\-url\fR <auth\-url>
>Defaults to env[OS_AUTH_URL].
>.TP
>\fB\-\-os\-region\-name\fR <region\-name>
>Defaults to env[OS_REGION_NAME].
>.TP
>\fB\-\-os\-auth\-system\fR <auth\-system>
>Defaults to env[OS_AUTH_SYSTEM].
>.TP
>\fB\-\-service\-type\fR <service\-type>
>Defaults to compute for most actions
>.TP
>\fB\-\-service\-name\fR <service\-name>
>Defaults to env[NOVA_SERVICE_NAME]
>.TP
>\fB\-\-volume\-service\-name\fR <volume\-service\-name>
>Defaults to env[NOVA_VOLUME_SERVICE_NAME]
>.TP
>\fB\-\-endpoint\-type\fR <endpoint\-type>
>Defaults to env[NOVA_ENDPOINT_TYPE] or publicURL.
>.TP
>\fB\-\-os\-compute\-api\-version\fR <compute\-api\-ver>
>Accepts 1.1, defaults to env[OS_COMPUTE_API_VERSION].
>.TP
>\fB\-\-insecure\fR
>Explicitly allow novaclient 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.
>.TP
>\fB\-\-bypass\-url\fR <bypass\-url>
>Use this API endpoint instead of the Service Catalog
>.PP
>See "nova help COMMAND" for help on a specific command.

Actions: View | Diff

Attachments on bug 904350: 700150 | 700188