diff options
Diffstat (limited to 'doc/source/command-objects')
| -rw-r--r-- | doc/source/command-objects/hypervisor.rst | 5 | ||||
| -rw-r--r-- | doc/source/command-objects/keypair.rst | 22 | ||||
| -rw-r--r-- | doc/source/command-objects/limits.rst | 3 | ||||
| -rw-r--r-- | doc/source/command-objects/network-rbac.rst | 2 | ||||
| -rw-r--r-- | doc/source/command-objects/network.rst | 43 | ||||
| -rw-r--r-- | doc/source/command-objects/port.rst | 37 | ||||
| -rw-r--r-- | doc/source/command-objects/router.rst | 23 | ||||
| -rw-r--r-- | doc/source/command-objects/security-group-rule.rst | 31 | ||||
| -rw-r--r-- | doc/source/command-objects/subnet-pool.rst | 14 | ||||
| -rw-r--r-- | doc/source/command-objects/volume-backup.rst | 36 | ||||
| -rw-r--r-- | doc/source/command-objects/volume.rst | 51 |
11 files changed, 248 insertions, 19 deletions
diff --git a/doc/source/command-objects/hypervisor.rst b/doc/source/command-objects/hypervisor.rst index d6d0469b..3053a758 100644 --- a/doc/source/command-objects/hypervisor.rst +++ b/doc/source/command-objects/hypervisor.rst @@ -14,11 +14,16 @@ List hypervisors os hypervisor list [--matching <hostname>] + [--long] .. option:: --matching <hostname> Filter hypervisors using <hostname> substring +.. option:: --long + + List additional fields in output + hypervisor show --------------- diff --git a/doc/source/command-objects/keypair.rst b/doc/source/command-objects/keypair.rst index af50a651..c9bf085b 100644 --- a/doc/source/command-objects/keypair.rst +++ b/doc/source/command-objects/keypair.rst @@ -3,14 +3,16 @@ keypair ======= The badly named keypair is really the public key of an OpenSSH key pair to be -used for access to created servers. +used for access to created servers. You can also create a private key for +access to a created server by not passing any argument to the keypair create +command. Compute v2 keypair create -------------- -Create new public key +Create new public or private key for server ssh access .. program:: keypair create .. code:: bash @@ -21,16 +23,16 @@ Create new public key .. option:: --public-key <file> - Filename for public key to add + Filename for public key to add. If not used, creates a private key. .. describe:: <name> - New public key name + New public or private key name keypair delete -------------- -Delete public key(s) +Delete public or private key(s) .. program:: keypair delete .. code:: bash @@ -40,12 +42,12 @@ Delete public key(s) .. describe:: <key> - Public key(s) to delete (name only) + Name of key(s) to delete (name only) keypair list ------------ -List public key fingerprints +List key fingerprints .. program:: keypair list .. code:: bash @@ -55,7 +57,7 @@ List public key fingerprints keypair show ------------ -Display public key details +Display key details .. program:: keypair show .. code:: bash @@ -66,8 +68,8 @@ Display public key details .. option:: --public-key - Show only bare public key (name only) + Show only bare public key paired with the generated key .. describe:: <key> - Public key to display (name only) + Public or private key to display (name only) diff --git a/doc/source/command-objects/limits.rst b/doc/source/command-objects/limits.rst index 87a5b33c..ef4171ac 100644 --- a/doc/source/command-objects/limits.rst +++ b/doc/source/command-objects/limits.rst @@ -15,7 +15,8 @@ Show compute and block storage limits .. code:: bash os limits show - --absolute [--reserved] | --rate + --absolute | --rate + [--reserved] [--project <project>] [--domain <domain>] diff --git a/doc/source/command-objects/network-rbac.rst b/doc/source/command-objects/network-rbac.rst index 8acf0979..113242f4 100644 --- a/doc/source/command-objects/network-rbac.rst +++ b/doc/source/command-objects/network-rbac.rst @@ -52,7 +52,7 @@ Create network RBAC policy .. _network_rbac_create-rbac-policy: .. describe:: <rbac-object> - The object to which this RBAC policy affects (name or ID for network objects, ID only for QoS policy objects) + The object to which this RBAC policy affects (name or ID) network rbac delete ------------------- diff --git a/doc/source/command-objects/network.rst b/doc/source/command-objects/network.rst index d133674f..4b72d5e0 100644 --- a/doc/source/command-objects/network.rst +++ b/doc/source/command-objects/network.rst @@ -193,53 +193,96 @@ List networks [--project <project> [--project-domain <project-domain>]] [--share | --no-share] [--status <status>] + [--provider-network-type <provider-network-type>] + [--provider-physical-network <provider-physical-network>] + [--provider-segment <provider-segment>] .. option:: --external List external networks + *Network version 2 only* + .. option:: --internal List internal networks + *Network version 2 only* + .. option:: --long List additional fields in output + *Network version 2 only* + .. option:: --name <name> List networks according to their name + *Network version 2 only* + .. option:: --enable List enabled networks + *Network version 2 only* + .. option:: --disable List disabled networks + *Network version 2 only* + .. option:: --project <project> List networks according to their project (name or ID) + *Network version 2 only* + .. option:: --project-domain <project-domain> Domain the project belongs to (name or ID). This can be used in case collisions between project names exist. + *Network version 2 only* + .. option:: --share List networks shared between projects + *Network version 2 only* + .. option:: --no-share List networks not shared between projects + *Network version 2 only* + .. option:: --status <status> List networks according to their status ('ACTIVE', 'BUILD', 'DOWN', 'ERROR') +.. option:: --provider-network-type <provider-network-type> + + List networks according to their physical mechanisms. + The supported options are: flat, geneve, gre, local, vlan, vxlan. + + *Network version 2 only* + +.. option:: --provider-physical-network <provider-physical-network> + + List networks according to name of the physical network + + *Network version 2 only* + +.. option:: --provider-segment <provider-segment> + + List networks according to VLAN ID for VLAN networks + or Tunnel ID for GENEVE/GRE/VXLAN networks + + *Network version 2 only* + network set ----------- diff --git a/doc/source/command-objects/port.rst b/doc/source/command-objects/port.rst index 6b318faf..173d99b1 100644 --- a/doc/source/command-objects/port.rst +++ b/doc/source/command-objects/port.rst @@ -27,6 +27,7 @@ Create new port [--host <host-id>] [--enable | --disable] [--mac-address <mac-address>] + [--security-group <security-group> | --no-security-group] [--project <project> [--project-domain <project-domain>]] <name> @@ -80,6 +81,15 @@ Create new port MAC address of this port +.. option:: --security-group <security-group> + + Security group to associate with this port (name or ID) + (repeat option to set multiple security groups) + +.. option:: --no-security-group + + Associate no security groups with this port + .. option:: --project <project> Owner's project (name or ID) @@ -122,6 +132,8 @@ List ports [--device-owner <device-owner>] [--router <router> | --server <server>] [--network <network>] + [--mac-address <mac-address>] + [--long] .. option:: --device-owner <device-owner> @@ -140,6 +152,14 @@ List ports List only ports attached to this network (name or ID) +.. option:: --mac-address <mac-address> + + List only ports with this MAC address + +.. option:: --long + + List additional fields in output + port set -------- @@ -160,6 +180,8 @@ Set port properties [--host <host-id>] [--enable | --disable] [--name <name>] + [--security-group <security-group>] + [--no-security-group] <port> .. option:: --description <description> @@ -220,6 +242,15 @@ Set port properties Set port name +.. option:: --security-group <security-group> + + Security group to associate with this port (name or ID) + (repeat option to set multiple security groups) + +.. option:: --no-security-group + + Clear existing security groups associated with this port + .. _port_set-port: .. describe:: <port> @@ -252,6 +283,7 @@ Unset port properties os port unset [--fixed-ip subnet=<subnet>,ip-address=<ip-address> [...]] [--binding-profile <binding-profile-key> [...]] + [--security-group <security-group> [...]] <port> .. option:: --fixed-ip subnet=<subnet>,ip-address=<ip-address> @@ -265,6 +297,11 @@ Unset port properties Desired key which should be removed from binding-profile (repeat option to unset multiple binding:profile data) +.. option:: --security-group <security-group> + + Security group which should be removed from this port (name or ID) + (repeat option to unset multiple security groups) + .. _port_unset-port: .. describe:: <port> diff --git a/doc/source/command-objects/router.rst b/doc/source/command-objects/router.rst index 15163980..56b95ffa 100644 --- a/doc/source/command-objects/router.rst +++ b/doc/source/command-objects/router.rst @@ -134,12 +134,26 @@ List routers .. code:: bash os router list + [--name <name>] + [--enable | --disable] [--long] .. option:: --long List additional fields in output +.. option:: --name <name> + + List routers according to their name + +.. option:: --enable + + List enabled routers + +.. option:: --disable + + List disabled routers + router remove port ------------------ @@ -198,6 +212,7 @@ Set router properties [--distributed | --centralized] [--description <description>] [--route destination=<subnet>,gateway=<ip-address> | --no-route] + [--ha | --no-ha] <router> .. option:: --name <name> @@ -235,6 +250,14 @@ Set router properties Clear routes associated with the router +.. option:: --ha + + Set the router as highly available (disabled router only) + +.. option:: --no-ha + + Clear high availablability attribute of the router (disabled router only) + .. _router_set-router: .. describe:: <router> diff --git a/doc/source/command-objects/security-group-rule.rst b/doc/source/command-objects/security-group-rule.rst index 5284b2dc..2a063bb0 100644 --- a/doc/source/command-objects/security-group-rule.rst +++ b/doc/source/command-objects/security-group-rule.rst @@ -22,6 +22,7 @@ Create a new security group rule [--ingress | --egress] [--ethertype <ethertype>] [--project <project> [--project-domain <project-domain>]] + [--description <description>] <group> .. option:: --src-ip <ip-address> @@ -97,6 +98,12 @@ Create a new security group rule *Network version 2 only* +.. option:: --description <description> + + Set security group rule description + + *Network version 2 only* + .. describe:: <group> Create rule in this security group (name or ID) @@ -126,6 +133,8 @@ List security group rules os security group rule list [--all-projects] + [--protocol <protocol>] + [--ingress | --egress] [--long] [<group>] @@ -142,6 +151,28 @@ List security group rules *Compute version 2 does not have additional fields to display.* + +.. option:: --protocol + + List rules by the IP protocol (ah, dhcp, egp, esp, gre, icmp, igmp, + ipv6-encap, ipv6-frag, ipv6-icmp, ipv6-nonxt,ipv6-opts, ipv6-route, + ospf, pgm, rsvp, sctp, tcp, udp, udplite, vrrp and integer + representations [0-255]) + + *Network version 2* + +.. option:: --ingress + + List rules applied to incoming network traffic + + *Network version 2 only* + +.. option:: --egress + + List rules applied to outgoing network traffic + + *Network version 2 only* + .. describe:: <group> List all rules in this security group (name or ID) diff --git a/doc/source/command-objects/subnet-pool.rst b/doc/source/command-objects/subnet-pool.rst index 28a735d6..bd1356f3 100644 --- a/doc/source/command-objects/subnet-pool.rst +++ b/doc/source/command-objects/subnet-pool.rst @@ -121,23 +121,23 @@ List subnet pools .. option:: --share - List subnets shared between projects + List subnet pools shared between projects .. option:: --no-share - List subnets not shared between projects + List subnet pools not shared between projects .. option:: --default - List subnets used as the default external subnet pool + List subnet pools used as the default external subnet pool .. option:: --no-default - List subnets not used as the default external subnet pool + List subnet pools not used as the default external subnet pool .. option:: --project <project> - List subnets according to their project (name or ID) + List subnet pools according to their project (name or ID) .. option:: --project-domain <project-domain> @@ -146,11 +146,11 @@ List subnet pools .. option:: --name <name> - List only subnets of given name in output + List only subnet pools of given name in output .. option:: --address-scope <address-scope> - List only subnets of given address scope (name or ID) in output + List only subnet pools of given address scope (name or ID) in output subnet pool set --------------- diff --git a/doc/source/command-objects/volume-backup.rst b/doc/source/command-objects/volume-backup.rst index 246fd38e..2cccffae 100644 --- a/doc/source/command-objects/volume-backup.rst +++ b/doc/source/command-objects/volume-backup.rst @@ -88,12 +88,48 @@ List volume backups .. code:: bash os volume backup list + [--long] + [--name <name>] + [--status <status>] + [--volume <volume>] + [--marker <marker>] + [--limit <limit>] + [--all-projects] .. _volume_backup_list-backup: .. option:: --long List additional fields in output +.. options:: --name <name> + + Filters results by the backup name + +.. options:: --status <status> + + Filters results by the backup status + ('creating', 'available', 'deleting', 'error', 'restoring' or 'error_restoring') + +.. options:: --volume <volume> + + Filters results by the volume which they backup (name or ID)" + +.. options:: --marker <marker> + + The last backup of the previous page (name or ID) + + *Volume version 2 only* + +.. options:: --limit <limit> + + Maximum number of backups to display + + *Volume version 2 only* + +.. option:: --all-projects + + Include all projects (admin only) + volume backup restore --------------------- diff --git a/doc/source/command-objects/volume.rst b/doc/source/command-objects/volume.rst index 8f123361..abd433b6 100644 --- a/doc/source/command-objects/volume.rst +++ b/doc/source/command-objects/volume.rst @@ -197,6 +197,48 @@ List volumes *Volume version 2 only* +volume migrate +-------------- + +Migrate volume to a new host + +.. program:: volume migrate +.. code:: bash + + os volume migrate + --host <host> + [--force-host-copy] + [--lock-volume | --unlock-volume] + <volume> + +.. option:: --host <host> + + Destination host (takes the form: host@backend-name#pool) (required) + +.. option:: --force-host-copy + + Enable generic host-based force-migration, + which bypasses driver optimizations + +.. option:: --lock-volume + + If specified, the volume state will be locked and will not allow + a migration to be aborted (possibly by another operation) + + *Volume version 2 only* + +.. option:: --unlock-volume + + If specified, the volume state will not be locked and the a + migration can be aborted (default) (possibly by another operation) + + *Volume version 2 only* + +.. _volume_migrate-volume: +.. describe:: <volume> + + Volume to migrate (name or ID) + volume set ---------- @@ -213,6 +255,7 @@ Set volume properties [--image-property <key=value> [...] ] [--state <state>] [--bootable | --non-bootable] + [--read-only | --read-write] <volume> .. option:: --name <name> @@ -239,6 +282,14 @@ Set volume properties Mark volume as non-bootable +.. option:: --read-only + + Set volume to read-only access mode + +.. option:: --read-write + + Set volume to read-write access mode + .. option:: --image-property <key=value> Set an image property on this volume |