OpenStack runs a git service now, so instead of linking to github URLs, link to git.openstack.org. Versions for pbr in setup.py actually wind up being an error (and a very odd one) Remove them. The setup hook in setup.cfg is no longer needed. Change-Id: I8f48ac194e6c01e9bb06fa5df6f2b2bf28c01636
|9 years ago|
|doc||9 years ago|
|novaclient||9 years ago|
|tools||9 years ago|
|.coveragerc||10 years ago|
|.gitignore||10 years ago|
|.gitreview||11 years ago|
|.mailmap||9 years ago|
|.testr.conf||9 years ago|
|CONTRIBUTING.rst||9 years ago|
|HACKING.rst||9 years ago|
|LICENSE||11 years ago|
|MANIFEST.in||10 years ago|
|README.rst||9 years ago|
|openstack-common.conf||9 years ago|
|requirements.txt||9 years ago|
|run_tests.sh||9 years ago|
|setup.cfg||9 years ago|
|setup.py||9 years ago|
|test-requirements.txt||9 years ago|
|tox.ini||9 years ago|
Python bindings to the OpenStack Nova API
This is a client for the OpenStack Nova API. There's a Python API (the
novaclient module), and a command-line script (
nova). Each implements 100% of the OpenStack Nova API.
python-novaclient is licensed under the Apache License like the rest of OpenStack.
Installing this package gets you a shell command,
nova, that you can use to interact with any OpenStack cloud.
You'll need to provide your OpenStack username and password. You can do this with the
--os-tenant-name params, but it's easier to just set them as environment variables:
export OS_USERNAME=openstack export OS_PASSWORD=yadayada export OS_TENANT_NAME=myproject
You will also need to define the authentication url with
--os-auth-url and the version of the API with
--version. Or set them as an environment variables as well:
export OS_AUTH_URL=http://example.com:8774/v1.1/ export OS_COMPUTE_API_VERSION=1.1
If you are using Keystone, you need to set the NOVA_URL to the keystone endpoint:
Since Keystone can return multiple regions in the Service Catalog, you can specify the one you want with
export OS_REGION_NAME). It defaults to the first in the list returned.
You'll find complete documentation on the shell by running
usage: nova [--debug] [--no-cache] [--timings] [--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-type>] [--endpoint-type <endpoint-type>] [--os-compute-api-version <compute-api-ver>] [--insecure] [--bypass-url <bypass-url>] <subcommand> ... Command-line interface to the OpenStack Nova API. Positional arguments: <subcommand> absolute-limits Print a list of absolute limits for a user actions Retrieve server actions. add-fixed-ip Add new IP address to network. add-floating-ip Add a floating IP address to a server. aggregate-add-host Add the host to the specified aggregate. aggregate-create Create a new aggregate with the specified details. aggregate-delete Delete the aggregate by its id. aggregate-details Show details of the specified aggregate. aggregate-list Print a list of all aggregates. aggregate-remove-host Remove the specified host from the specified aggregate. aggregate-set-metadata Update the metadata associated with the aggregate. aggregate-update Update the aggregate's name and optionally availability zone. boot Boot a new server. console-log Get console log output of a server. credentials Show user credentials returned from auth delete Immediately shut down and delete a server. describe-resource Show details about a resource diagnostics Retrieve server diagnostics. dns-create Create a DNS entry for domain, name and ip. dns-create-private-domain Create the specified DNS domain. dns-create-public-domain Create the specified DNS domain. dns-delete Delete the specified DNS entry. dns-delete-domain Delete the specified DNS domain. dns-domains Print a list of available dns domains. dns-list List current DNS entries for domain and ip or domain and name. endpoints Discover endpoints that get returned from the authenticate services evacuate Evacuate a server from failed host flavor-create Create a new flavor. flavor-delete Delete a specific flavor. flavor-list Print a list of available 'flavors' (sizes of servers). flavor-show Show details about the given flavor. flavor-key Set or unset extra_spec for a flavor. flavor-access-list Print access information about the given flavor. flavor-access-add Add flavor access for the given tenant. flavor-access-remove Remove flavor access for the given tenant. floating-ip-create Allocate a floating IP for the current tenant. floating-ip-delete De-allocate a floating IP. floating-ip-list List floating ips for this tenant. floating-ip-pool-list List all floating ip pools. get-vnc-console Get a vnc console to a server. get-spice-console Get a spice console to a server. host-action Perform a power action on a host. host-update Update host settings. image-create Create a new image by taking a snapshot of a running server. image-delete Delete an image. image-list Print a list of available images to boot from. image-meta Set or Delete metadata on an image. image-show Show details about the given image. keypair-add Create a new key pair for use with instances keypair-delete Delete keypair by its name keypair-list Print a list of keypairs for a user list List active servers. live-migration Migrates a running instance to a new machine. lock Lock a server. meta Set or Delete metadata on a server. migrate Migrate a server. pause Pause a server. rate-limits Print a list of rate limits for a user reboot Reboot a server. rebuild Shutdown, re-image, and re-boot a server. remove-fixed-ip Remove an IP address from a server. remove-floating-ip Remove a floating IP address from a server. rename Rename a server. rescue Rescue a server. resize Resize a server. resize-confirm Confirm a previous resize. resize-revert Revert a previous resize (and return to the previous VM). resume Resume a server. root-password Change the root password for a server. secgroup-add-group-rule Add a source group rule to a security group. secgroup-add-rule Add a rule to a security group. secgroup-create Create a security group. secgroup-update Update a security group. secgroup-delete Delete a security group. secgroup-delete-group-rule Delete a source group rule from a security group. secgroup-delete-rule Delete a rule from a security group. secgroup-list List security groups for the curent tenant. secgroup-list-rules List rules for a security group. show Show details about the given server. ssh SSH into a server. start Start a server. stop Stop a server. suspend Suspend a server. unlock Unlock a server. unpause Unpause a server. unrescue Unrescue a server. usage-list List usage data for all tenants volume-attach Attach a volume to a server. volume-create Add a new volume. volume-delete Remove a volume. volume-detach Detach a volume from a server. volume-list List all the volumes. volume-show Show details about a volume. volume-snapshot-create Add a new snapshot. volume-snapshot-delete Remove a snapshot. volume-snapshot-list List all the snapshots. volume-snapshot-show Show details about a snapshot. 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'. x509-create-cert Create x509 cert for a user in tenant x509-get-root-cert Fetches the x509 root cert. bash-completion Prints all of the commands and options to stdout so that the nova.bash_completion script doesn't have to hard code them. help Display help about this program or one of its subcommands. Optional arguments: --debug Print debugging output --no-cache Don't use the auth token cache. --timings Print call timing info --os-username <auth-user-name> Defaults to env[OS_USERNAME]. --os-password <auth-password> Defaults to env[OS_PASSWORD]. --os-tenant-name <auth-tenant-name> Defaults to env[OS_TENANT_NAME]. --os-auth-url <auth-url> Defaults to env[OS_AUTH_URL]. --os-region-name <region-name> Defaults to env[OS_REGION_NAME]. --os-auth-system <auth-system> Defaults to env[OS_AUTH_SYSTEM]. --service-type <service-type> Defaults to compute for most actions --service-name <service-name> Defaults to env[NOVA_SERVICE_NAME] --volume-service-name <volume-service-type> Defaults to env[NOVA_VOLUME_SERVICE_NAME] --endpoint-type <endpoint-type> Defaults to env[NOVA_ENDPOINT_TYPE] or publicURL. --os-compute-api-version <compute-api-ver> Accepts 1.1, defaults to env[OS_COMPUTE_API_VERSION]. --username USERNAME Deprecated --insecure 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. --bypass-url <bypass-url> Use this API endpoint instead of the Service Catalog See "nova help COMMAND" for help on a specific command.
There's also a complete Python API, but it has not yet been documented.
Quick-start using keystone:
# use v2.0 auth with http://example.com:5000/v2.0/") >>> from novaclient.v1_1 import client >>> nt = client.Client(USER, PASS, TENANT, AUTH_URL, service_type="compute") >>> nt.flavors.list() [...] >>> nt.servers.list() [...] >>> nt.keypairs.list() [...]