Index

Symbols | A | B | C | D | E | F | G | H | I | K | L | M | N | O | P | Q | R | S | T | U | V

Symbols

--absolute
limits-show command line option
--address-type <address-type>
server-ssh command line option
--adminurl <url>
endpoint-create command line option
--all
container-list command line option
flavor-list command line option
object-delete command line option
--all-projects
server-delete command line option
volume-list command line option
--availability-zone <availability-zone>
volume-create command line option
--availability-zone <zone-name>
server-create command line option
--block-device-mapping <dev-name=mapping>
server-create command line option
--block-migration
server-migrate command line option
--catalog
service-show command line option
--checksum <checksum>
image-create command line option
--class
quota-set command line option
quota-show command line option
--compute
extension-list command line option
--config-drive <config-drive-volume>|True
server-create command line option
--confirm
server-resize command line option
--consumer-key <consumer-key>
access-token-create command line option
request-token-create command line option
--consumer-secret <consumer-secret>
access-token-create command line option
--container <container>
backup-create command line option
--container-format <container-format>
image-create command line option
--copy-from <image-url>
image-create command line option
--cores <new-cores>
quota-set command line option
--default
quota-show command line option
--delimiter <delimiter>
object-delete command line option
--description
identity-provider-create command line option
--description <description>
backup-create command line option
consumer-create command line option
consumer-set command line option
domain-create command line option
domain-set command line option
group-create command line option
group-set command line option
project-create command line option
project-set command line option
region-create command line option
region-set command line option
request-token-create command line option
service-create command line option
service-set command line option
snapshot-create command line option
snapshot-set command line option
user-create command line option
user-set command line option
volume-create command line option
volume-set command line option
--device <device>
server-add-volume command line option
--dhcp <dhcp-id>
network-list command line option
--diagnostics
server-show command line option
--disable
domain-create command line option
domain-set command line option
endpoint-create command line option
endpoint-set command line option
identity-provider-create command line option
identity-provider-set command line option
network-create command line option
network-set command line option
project-create command line option
project-set command line option
service-create command line option
service-set command line option
user-create command line option
user-set command line option
--disk <size-gb>
flavor-create command line option
--disk-format <disk-format>
image-create command line option
--disk-overcommit
server-migrate command line option
--domain <domain>
group-create command line option
group-delete command line option
group-list command line option
group-show command line option
project-create command line option
project-delete command line option
project-list command line option
project-show command line option
request-token-create command line option
role-add command line option
role-assignment-list command line option
role-list command line option
role-remove command line option
user-create command line option
user-delete command line option
user-list command line option
user-show command line option
--effective
role-assignment-list command line option
--email <email-address>
user-create command line option
user-set command line option
--enable
domain-create command line option
domain-set command line option
endpoint-create command line option
endpoint-set command line option
identity-provider-create command line option
identity-provider-set command line option
network-create command line option
network-set command line option
project-create command line option
project-set command line option
service-create command line option
service-set command line option
user-create command line option
user-set command line option
--end <end>
usage-list command line option
usage-show command line option
--end-marker <end-marker>
container-list command line option
object-delete command line option
--ephemeral-disk <size-gb>
flavor-create command line option
--expiration <expiration>
trust-create command line option
--external
network-list command line option
--file <dest-filename=source-filename>
server-create command line option
--file <file>
image-create command line option
--file <filename>
image-save command line option
object-save command line option
--fixed-ips <new-fixed-ips>
quota-set command line option
--flavor <flavor>
server-create command line option
server-delete command line option
server-resize command line option
--floating-ips <new-floating-ips>
quota-set command line option
--force
image-create command line option
snapshot-create command line option
volume-delete command line option
--gigabytes <new-gigabytes>
quota-set command line option
--group <group>
role-add command line option
role-assignment-list command line option
role-list command line option
role-remove command line option
user-list command line option
--hard
server-reboot command line option
--hint <key=value>
server-create command line option
--host <hostname>
server-delete command line option
--id <id>
flavor-create command line option
image-create command line option
--identity
extension-list command line option
--identity <keyfile>
server-ssh command line option
--identity-provider <identity-provider>
federation-protocol-create command line option
federation-protocol-delete command line option
federation-protocol-list command line option
federation-protocol-set command line option
federation-protocol-show command line option
--image <image>
server-create command line option
server-delete command line option
server-rebuild command line option
volume-create command line option
--impersonate
trust-create command line option
--injected-file-size <new-injected-file-size>
quota-set command line option
--injected-files <new-injected-files>
quota-set command line option
--injected-path-size <new-injected-path-size>
quota-set command line option
--instance-name <server-name-regex>
server-delete command line option
--instances <new-instances>
quota-set command line option
--interface <interface>
endpoint-list command line option
endpoint-set command line option
--internalurl <url>
endpoint-create command line option
--ip <ip-address-regex>
server-delete command line option
--ip6 <ip-address-regex>
server-delete command line option
--key-name <key-name>
server-create command line option
--key-pairs <new-key-pairs>
quota-set command line option
--limit <limit>
container-list command line option
object-delete command line option
--lines <num-lines>
console-log-show command line option
--live <hostname>
server-migrate command line option
--location <image-url>
image-create command line option
--login <login-name>
server-ssh command line option
--long
aggregate-list command line option
backup-list command line option
command line option
container-list command line option
endpoint-list command line option
extension-list command line option
flavor-list command line option
group-list command line option
image-list command line option
network-list command line option
object-delete command line option
policy-list command line option
project-list command line option
server-delete command line option
service-list command line option
snapshot-list command line option
user-list command line option
volume-list command line option
volume-type-list command line option
--mapping <mapping>
federation-protocol-create command line option
federation-protocol-set command line option
--marker <marker>
container-list command line option
object-delete command line option
--matching <hostname>
hypervisor-list command line option
--max <count>
server-create command line option
--min <count>
server-create command line option
--min-disk <disk-gb>
image-create command line option
image-set command line option
--min-ram <disk-ram>
image-create command line option
image-set command line option
--name <image-name>
server-image-create command line option
--name <name-regex>
server-delete command line option
--name <name>
aggregate-set command line option
backup-create command line option
domain-set command line option
group-set command line option
image-set command line option
network-set command line option
project-set command line option
role-set command line option
service-create command line option
service-set command line option
snapshot-create command line option
snapshot-set command line option
user-set command line option
volume-list command line option
volume-set command line option
--name <new-name>
server-set command line option
--network
extension-list command line option
--nic <nic-config-string>
server-create command line option
--no-disk-overcommit
server-migrate command line option
--no-share
network-create command line option
network-set command line option
--novnc
console-url-show command line option
--option <config-options>
server-ssh command line option
--or-show
domain-create command line option
group-create command line option
user-create command line option
--owner <project>
image-create command line option
image-set command line option
--parent-region <region-id>
region-create command line option
region-list command line option
region-set command line option
--password <password>
server-rebuild command line option
user-create command line option
user-set command line option
--password-prompt
user-create command line option
user-set command line option
--port <port>
server-ssh command line option
--prefix <prefix>
container-list command line option
object-delete command line option
--private
flavor-create command line option
flavor-list command line option
image-create command line option
image-list command line option
image-set command line option
server-ssh command line option
--project <project>
ec2-credentials-create command line option
request-token-create command line option
role-add command line option
role-assignment-list command line option
role-list command line option
role-remove command line option
trust-create command line option
usage-show command line option
user-create command line option
user-list command line option
user-role-list command line option
user-set command line option
volume-create command line option
--project-domain <domain>
trust-create command line option
--properties <new-properties>
quota-set command line option
--property <key=value>
aggregate-create command line option
aggregate-set command line option
flavor-set command line option
image-create command line option
image-list command line option
image-set command line option
project-create command line option
project-set command line option
server-create command line option
server-set command line option
snapshot-set command line option
volume-create command line option
volume-set command line option
volume-type-create command line option
volume-type-set command line option
--property <key>
flavor-unset command line option
server-unset command line option
snapshot-unset command line option
volume-type-unset command line option
volume-unset command line option
--protected
image-create command line option
image-set command line option
--public
flavor-create command line option
flavor-list command line option
image-create command line option
image-list command line option
image-set command line option
server-ssh command line option
--public-key
command line option
--public-key <file>
command line option
--publicurl <url>
endpoint-create command line option
--ram <new-ram>
quota-set command line option
--ram <size-mb>
flavor-create command line option
--rate
limits-show command line option
--region <region-id>
endpoint-create command line option, [1]
endpoint-list command line option
endpoint-set command line option
--remote-id <remote-id>
identity-provider-create command line option
identity-provider-set command line option
--remote-id-file <file-name>
identity-provider-create command line option
identity-provider-set command line option
--request-key <request-key>
access-token-create command line option
request-token-authorize command line option
--request-secret <request-secret>
access-token-create command line option
--reservation-id <reservation-id>
server-delete command line option
--reserved
limits-show command line option
--revert
server-resize command line option
--role <role>
request-token-authorize command line option
role-assignment-list command line option
trust-create command line option
--root-password
server-set command line option
--rules <filename>
mapping-create command line option
mapping-set command line option
--rxtx-factor <factor>
flavor-create command line option
--secgroup-rules <new-secgroup-rules>
quota-set command line option
--secgroups <new-secgroups>
quota-set command line option
--security-group <security-group-name>
server-create command line option
--service <service>
endpoint-list command line option
endpoint-set command line option
--share
network-create command line option
network-set command line option
--shared
image-list command line option
--shared-migration
server-migrate command line option
--size <size>
image-create command line option
volume-set command line option
--size <size> (required)
volume-create command line option
--snapshot <snapshot>
volume-create command line option
--snapshots <new-snapshots>
quota-set command line option
--soft
server-reboot command line option
--sort <key>[:<direction>]
image-list command line option
--source <source>
volume-create command line option
--spice
console-url-show command line option
--start <start>
usage-list command line option
usage-show command line option
--status <status>
server-delete command line option
volume-list command line option
--store <store>
image-create command line option
--swap <size-gb>
flavor-create command line option
--trustee-domain <domain>
trust-create command line option
--trustor-domain <domain>
trust-create command line option
--type <type>
policy-create command line option
policy-set command line option
service-set command line option
--type <volume-type>
volume-create command line option
--unprotected
image-create command line option
image-set command line option
--url <url>
endpoint-set command line option
region-create command line option
region-set command line option
--user <user>
ec2-credentials-create command line option
ec2-credentials-delete command line option
ec2-credentials-list command line option
ec2-credentials-show command line option
group-list command line option
project-list command line option
role-add command line option
role-assignment-list command line option
role-list command line option
role-remove command line option
volume-create command line option
--user-data <user-data>
server-create command line option
--vcpus <num-cpu>
flavor-create command line option
--verifier <verifier>
access-token-create command line option
--volume
extension-list command line option
--volume <volume>
image-create command line option
server-create command line option
--volumes <new-volumes>
quota-set command line option
--wait
server-create command line option
server-image-create command line option
server-migrate command line option
server-reboot command line option
server-rebuild command line option
server-resize command line option
--xvpvnc
console-url-show command line option
--zone <availability-zone>
aggregate-create command line option
aggregate-set command line option

A

access-token-create command line option
--consumer-key <consumer-key>
--consumer-secret <consumer-secret>
--request-key <request-key>
--request-secret <request-secret>
--verifier <verifier>
aggregate-create command line option
--property <key=value>
--zone <availability-zone>
aggregate-list command line option
--long
aggregate-set command line option
--name <name>
--property <key=value>
--zone <availability-zone>
AuthorizationFailure

B

backup-create command line option
--container <container>
--description <description>
--name <name>
backup-list command line option
--long
BadRequest

C

ClientException
command line option
--long
--public-key
--public-key <file>
CommandError
Conflict
console-log-show command line option
--lines <num-lines>
console-url-show command line option
--novnc
--spice
--xvpvnc
consumer-create command line option
--description <description>
consumer-set command line option
--description <description>
container-list command line option
--all
--end-marker <end-marker>
--limit <limit>
--long
--marker <marker>
--prefix <prefix>

D

domain-create command line option
--description <description>
--disable
--enable
--or-show
domain-set command line option
--description <description>
--disable
--enable
--name <name>

E

ec2-credentials-create command line option
--project <project>
--user <user>
ec2-credentials-delete command line option
--user <user>
ec2-credentials-list command line option
--user <user>
ec2-credentials-show command line option
--user <user>
endpoint-create command line option
--adminurl <url>
--disable
--enable
--internalurl <url>
--publicurl <url>
--region <region-id>, [1]
endpoint-list command line option
--interface <interface>
--long
--region <region-id>
--service <service>
endpoint-set command line option
--disable
--enable
--interface <interface>
--region <region-id>
--service <service>
--url <url>
EndpointNotFound
environment variable
OS_AUTH_PLUGIN
OS_AUTH_URL, [1]
OS_CACERT
OS_DEFAULT_DOMAIN
OS_DOMAIN_NAME
OS_IDENTITY_API_VERSION
OS_PASSWORD, [1]
OS_PROJECT_DOMAIN_NAME
OS_PROJECT_NAME, [1]
OS_REGION_NAME
OS_TOKEN, [1]
OS_TRUST_ID
OS_URL, [1]
OS_USERNAME, [1]
OS_USER_DOMAIN_NAME
OS_XXXX_API_VERSION
extension-list command line option
--compute
--identity
--long
--network
--volume

F

federation-protocol-create command line option
--identity-provider <identity-provider>
--mapping <mapping>
federation-protocol-delete command line option
--identity-provider <identity-provider>
federation-protocol-list command line option
--identity-provider <identity-provider>
federation-protocol-set command line option
--identity-provider <identity-provider>
--mapping <mapping>
federation-protocol-show command line option
--identity-provider <identity-provider>
find() (in module openstackclient.network.common)
flavor-create command line option
--disk <size-gb>
--ephemeral-disk <size-gb>
--id <id>
--private
--public
--ram <size-mb>
--rxtx-factor <factor>
--swap <size-gb>
--vcpus <num-cpu>
flavor-list command line option
--all
--long
--private
--public
flavor-set command line option
--property <key=value>
flavor-unset command line option
--property <key>
Forbidden
from_response() (in module openstackclient.common.exceptions)

G

group-create command line option
--description <description>
--domain <domain>
--or-show
group-delete command line option
--domain <domain>
group-list command line option
--domain <domain>
--long
--user <user>
group-set command line option
--description <description>
--name <name>
group-show command line option
--domain <domain>

H

http_status (openstackclient.common.exceptions.BadRequest attribute)
(openstackclient.common.exceptions.Conflict attribute)
(openstackclient.common.exceptions.Forbidden attribute)
(openstackclient.common.exceptions.HTTPNotImplemented attribute)
(openstackclient.common.exceptions.NotFound attribute)
(openstackclient.common.exceptions.OverLimit attribute)
(openstackclient.common.exceptions.Unauthorized attribute)
HTTPNotImplemented
hypervisor-list command line option
--matching <hostname>

I

identity-provider-create command line option
--description
--disable
--enable
--remote-id <remote-id>
--remote-id-file <file-name>
identity-provider-set command line option
--disable
--enable
--remote-id <remote-id>
--remote-id-file <file-name>
image-create command line option
--checksum <checksum>
--container-format <container-format>
--copy-from <image-url>
--disk-format <disk-format>
--file <file>
--force
--id <id>
--location <image-url>
--min-disk <disk-gb>
--min-ram <disk-ram>
--owner <project>
--private
--property <key=value>
--protected
--public
--size <size>
--store <store>
--unprotected
--volume <volume>
image-list command line option
--long
--private
--property <key=value>
--public
--shared
--sort <key>[:<direction>]
image-save command line option
--file <filename>
image-set command line option
--min-disk <disk-gb>
--min-ram <disk-ram>
--name <name>
--owner <project>
--private
--property <key=value>
--protected
--public
--unprotected

K

KeyValueAction (class in openstackclient.common.parseractions)

L

limits-show command line option
--absolute
--rate
--reserved

M

mapping-create command line option
--rules <filename>
mapping-set command line option
--rules <filename>
message (openstackclient.common.exceptions.BadRequest attribute)
(openstackclient.common.exceptions.Conflict attribute)
(openstackclient.common.exceptions.Forbidden attribute)
(openstackclient.common.exceptions.HTTPNotImplemented attribute)
(openstackclient.common.exceptions.NotFound attribute)
(openstackclient.common.exceptions.OverLimit attribute)
(openstackclient.common.exceptions.Unauthorized attribute)

N

network-create command line option
--disable
--enable
--no-share
--share
network-list command line option
--dhcp <dhcp-id>
--external
--long
network-set command line option
--disable
--enable
--name <name>
--no-share
--share
NotFound
NoTokenLookupException

O

object-delete command line option
--all
--delimiter <delimiter>
--end-marker <end-marker>
--limit <limit>
--long
--marker <marker>
--prefix <prefix>
object-save command line option
--file <filename>
openstackclient.__init__ (module)
openstackclient.api.utils (module)
openstackclient.common.exceptions (module)
openstackclient.common.parseractions (module)
openstackclient.network.common (module)
OS_AUTH_PLUGIN
OS_AUTH_URL, [1]
OS_CACERT
OS_DEFAULT_DOMAIN
OS_DOMAIN_NAME
OS_IDENTITY_API_VERSION
OS_PASSWORD, [1]
OS_PROJECT_DOMAIN_NAME
OS_PROJECT_NAME, [1]
OS_REGION_NAME
OS_TOKEN, [1]
OS_TRUST_ID
OS_URL, [1]
OS_USER_DOMAIN_NAME
OS_USERNAME, [1]
OS_XXXX_API_VERSION
OverLimit

P

policy-create command line option
--type <type>
policy-list command line option
--long
policy-set command line option
--type <type>
project-create command line option
--description <description>
--disable
--domain <domain>
--enable
--property <key=value>
project-delete command line option
--domain <domain>
project-list command line option
--domain <domain>
--long
--user <user>
project-set command line option
--description <description>
--disable
--enable
--name <name>
--property <key=value>
project-show command line option
--domain <domain>

Q

quota-set command line option
--class
--cores <new-cores>
--fixed-ips <new-fixed-ips>
--floating-ips <new-floating-ips>
--gigabytes <new-gigabytes>
--injected-file-size <new-injected-file-size>
--injected-files <new-injected-files>
--injected-path-size <new-injected-path-size>
--instances <new-instances>
--key-pairs <new-key-pairs>
--properties <new-properties>
--ram <new-ram>
--secgroup-rules <new-secgroup-rules>
--secgroups <new-secgroups>
--snapshots <new-snapshots>
--volumes <new-volumes>
quota-show command line option
--class
--default

R

RangeAction (class in openstackclient.common.parseractions)
region-create command line option
--description <description>
--parent-region <region-id>
--url <url>
region-list command line option
--parent-region <region-id>
region-set command line option
--description <description>
--parent-region <region-id>
--url <url>
request-token-authorize command line option
--request-key <request-key>
--role <role>
request-token-create command line option
--consumer-key <consumer-key>
--description <description>
--domain <domain>
--project <project>
role-add command line option
--domain <domain>
--group <group>
--project <project>
--user <user>
role-assignment-list command line option
--domain <domain>
--effective
--group <group>
--project <project>
--role <role>
--user <user>
role-list command line option
--domain <domain>
--group <group>
--project <project>
--user <user>
role-remove command line option
--domain <domain>
--group <group>
--project <project>
--user <user>
role-set command line option
--name <name>

S

server-add-volume command line option
--device <device>
server-create command line option
--availability-zone <zone-name>
--block-device-mapping <dev-name=mapping>
--config-drive <config-drive-volume>|True
--file <dest-filename=source-filename>
--flavor <flavor>
--hint <key=value>
--image <image>
--key-name <key-name>
--max <count>
--min <count>
--nic <nic-config-string>
--property <key=value>
--security-group <security-group-name>
--user-data <user-data>
--volume <volume>
--wait
server-delete command line option
--all-projects
--flavor <flavor>
--host <hostname>
--image <image>
--instance-name <server-name-regex>
--ip <ip-address-regex>
--ip6 <ip-address-regex>
--long
--name <name-regex>
--reservation-id <reservation-id>
--status <status>
server-image-create command line option
--name <image-name>
--wait
server-migrate command line option
--block-migration
--disk-overcommit
--live <hostname>
--no-disk-overcommit
--shared-migration
--wait
server-reboot command line option
--hard
--soft
--wait
server-rebuild command line option
--image <image>
--password <password>
--wait
server-resize command line option
--confirm
--flavor <flavor>
--revert
--wait
server-set command line option
--name <new-name>
--property <key=value>
--root-password
server-show command line option
--diagnostics
server-ssh command line option
--address-type <address-type>
--identity <keyfile>
--login <login-name>
--option <config-options>
--port <port>
--private
--public
server-unset command line option
--property <key>
service-create command line option
--description <description>
--disable
--enable
--name <name>
service-list command line option
--long
service-set command line option
--description <description>
--disable
--enable
--name <name>
--type <type>
service-show command line option
--catalog
simple_filter() (in module openstackclient.api.utils)
snapshot-create command line option
--description <description>
--force
--name <name>
snapshot-list command line option
--long
snapshot-set command line option
--description <description>
--name <name>
--property <key=value>
snapshot-unset command line option
--property <key>

T

trust-create command line option
--expiration <expiration>
--impersonate
--project <project>
--project-domain <domain>
--role <role>
--trustee-domain <domain>
--trustor-domain <domain>

U

Unauthorized
UnsupportedVersion
usage-list command line option
--end <end>
--start <start>
usage-show command line option
--end <end>
--project <project>
--start <start>
user-create command line option
--description <description>
--disable
--domain <domain>
--email <email-address>
--enable
--or-show
--password <password>
--password-prompt
--project <project>
user-delete command line option
--domain <domain>
user-list command line option
--domain <domain>
--group <group>
--long
--project <project>
user-role-list command line option
--project <project>
user-set command line option
--description <description>
--disable
--email <email-address>
--enable
--name <name>
--password <password>
--password-prompt
--project <project>
user-show command line option
--domain <domain>

V

volume-create command line option
--availability-zone <availability-zone>
--description <description>
--image <image>
--project <project>
--property <key=value>
--size <size> (required)
--snapshot <snapshot>
--source <source>
--type <volume-type>
--user <user>
volume-delete command line option
--force
volume-list command line option
--all-projects
--long
--name <name>
--status <status>
volume-set command line option
--description <description>
--name <name>
--property <key=value>
--size <size>
volume-type-create command line option
--property <key=value>
volume-type-list command line option
--long
volume-type-set command line option
--property <key=value>
volume-type-unset command line option
--property <key>
volume-unset command line option
--property <key>