diff options
Diffstat (limited to 'doc/source/command-objects')
| -rw-r--r-- | doc/source/command-objects/image.rst | 4 | ||||
| -rw-r--r-- | doc/source/command-objects/network-segment.rst | 101 | ||||
| -rw-r--r-- | doc/source/command-objects/network.rst | 55 | ||||
| -rw-r--r-- | doc/source/command-objects/port.rst | 11 | ||||
| -rw-r--r-- | doc/source/command-objects/subnet-pool.rst | 48 | ||||
| -rw-r--r-- | doc/source/command-objects/subnet.rst | 63 | ||||
| -rw-r--r-- | doc/source/command-objects/usage.rst | 10 | ||||
| -rw-r--r-- | doc/source/command-objects/volume-backup.rst | 31 | ||||
| -rw-r--r-- | doc/source/command-objects/volume-service.rst | 3 | ||||
| -rw-r--r-- | doc/source/command-objects/volume-transfer-request.rst | 37 | ||||
| -rw-r--r-- | doc/source/command-objects/volume.rst | 9 |
11 files changed, 356 insertions, 16 deletions
diff --git a/doc/source/command-objects/image.rst b/doc/source/command-objects/image.rst index d6451af7..842eab8d 100644 --- a/doc/source/command-objects/image.rst +++ b/doc/source/command-objects/image.rst @@ -1,6 +1,6 @@ -====== +===== image -====== +===== Image v1, v2 diff --git a/doc/source/command-objects/network-segment.rst b/doc/source/command-objects/network-segment.rst index 56a11e1e..242dcbe9 100644 --- a/doc/source/command-objects/network-segment.rst +++ b/doc/source/command-objects/network-segment.rst @@ -9,6 +9,75 @@ within a network may not be guaranteed. Network v2 +network segment create +---------------------- + +Create new network segment + +.. caution:: This is a beta command and subject to change. + Use global option ``--os-beta-command`` to + enable this command. + +.. program:: network segment create +.. code:: bash + + os network segment create + [--description <description>] + [--physical-network <physical-network>] + [--segment <segment>] + --network <network> + --network-type <network-type> + <name> + +.. option:: --description <description> + + Network segment description + +.. option:: --physical-network <physical-network> + + Physical network name of this network segment + +.. option:: --segment <segment> + + Segment identifier for this network segment which is + based on the network type, VLAN ID for vlan network + type and tunnel ID for geneve, gre and vxlan network + types + +.. option:: --network <network> + + Network this network segment belongs to (name or ID) + +.. option:: --network-type <network-type> + + Network type of this network segment + (flat, geneve, gre, local, vlan or vxlan) + +.. _network_segment_create-name: +.. describe:: <name> + + New network segment name + +network segment delete +---------------------- + +Delete network segment(s) + +.. caution:: This is a beta command and subject to change. + Use global option ``--os-beta-command`` to + enable this command. + +.. program:: network segment delete +.. code:: bash + + os network segment delete + <network-segment> [<network-segment> ...] + +.. _network_segment_delete-segment: +.. describe:: <network-segment> + + Network segment(s) to delete (name or ID) + network segment list -------------------- @@ -33,6 +102,36 @@ List network segments List network segments that belong to this network (name or ID) +network segment set +------------------- + +Set network segment properties + +.. caution:: This is a beta command and subject to change. + Use global option ``--os-beta-command`` to + enable this command. + +.. program:: network segment set +.. code:: bash + + os network segment set + [--description <description>] + [--name <name>] + <network-segment> + +.. option:: --description <description> + + Set network segment description + +.. option:: --name <name> + + Set network segment name + +.. _network_segment_set-segment: +.. describe:: <network-segment> + + Network segment to modify (name or ID) + network segment show -------------------- @@ -51,4 +150,4 @@ Display network segment details .. _network_segment_show-segment: .. describe:: <network-segment> - Network segment to display (ID only) + Network segment to display (name or ID) diff --git a/doc/source/command-objects/network.rst b/doc/source/command-objects/network.rst index 5d9a5ca8..d133674f 100644 --- a/doc/source/command-objects/network.rst +++ b/doc/source/command-objects/network.rst @@ -23,6 +23,7 @@ Create new network [--project <project> [--project-domain <project-domain>]] [--enable | --disable] [--share | --no-share] + [--description <description>] [--availability-zone-hint <availability-zone>] [--enable-port-security | --disable-port-security] [--external [--default | --no-default] | --internal] @@ -65,6 +66,10 @@ Create new network Do not share the network between projects +.. option:: --description <description> + + Set network description + .. option:: --availability-zone-hint <availability-zone> Availability Zone in which to create this network @@ -181,17 +186,60 @@ List networks .. code:: bash os network list - [--external] + [--external | --internal] [--long] + [--name <name>] + [--enable | --disable] + [--project <project> [--project-domain <project-domain>]] + [--share | --no-share] + [--status <status>] .. option:: --external List external networks +.. option:: --internal + + List internal networks + .. option:: --long List additional fields in output +.. option:: --name <name> + + List networks according to their name + +.. option:: --enable + + List enabled networks + +.. option:: --disable + + List disabled networks + +.. option:: --project <project> + + List networks according to their project (name or ID) + +.. option:: --project-domain <project-domain> + + Domain the project belongs to (name or ID). + This can be used in case collisions between project names exist. + +.. option:: --share + + List networks shared between projects + +.. option:: --no-share + + List networks not shared between projects + +.. option:: --status <status> + + List networks according to their status + ('ACTIVE', 'BUILD', 'DOWN', 'ERROR') + network set ----------- @@ -206,6 +254,7 @@ Set network properties [--name <name>] [--enable | --disable] [--share | --no-share] + [--description <description>] [--enable-port-security | --disable-port-security] [--external [--default | --no-default] | --internal] [--provider-network-type <provider-network-type>] @@ -234,6 +283,10 @@ Set network properties Do not share the network between projects +.. option:: --description <description> + + Set network description + .. option:: --enable-port-security Enable port security by default for ports created on diff --git a/doc/source/command-objects/port.rst b/doc/source/command-objects/port.rst index 49e68407..e3e783ad 100644 --- a/doc/source/command-objects/port.rst +++ b/doc/source/command-objects/port.rst @@ -115,7 +115,8 @@ List ports os port list [--device-owner <device-owner>] - [--router <router>] + [--router <router> | --server <server>] + [--network <network>] .. option:: --device-owner <device-owner> @@ -126,6 +127,14 @@ List ports List only ports attached to this router (name or ID) +.. option:: --server <server> + + List only ports attached to this server (name or ID) + +.. option:: --network <network> + + List only ports attached to this network (name or ID) + port set -------- diff --git a/doc/source/command-objects/subnet-pool.rst b/doc/source/command-objects/subnet-pool.rst index 005b8357..28a735d6 100644 --- a/doc/source/command-objects/subnet-pool.rst +++ b/doc/source/command-objects/subnet-pool.rst @@ -19,6 +19,7 @@ Create subnet pool [--default-prefix-length <default-prefix-length>] [--min-prefix-length <min-prefix-length>] [--max-prefix-length <max-prefix-length>] + [--description <description>] [--project <project> [--project-domain <project-domain>]] [--address-scope <address-scope>] [--default | --no-default] @@ -38,6 +39,10 @@ Create subnet pool Set subnet pool maximum prefix length +.. option:: --description <description> + + Set subnet pool description + .. option:: --project <project> Owner's project (name or ID) @@ -104,11 +109,49 @@ List subnet pools os subnet pool list [--long] + [--share | --no-share] + [--default | --no-default] + [--project <project> [--project-domain <project-domain>]] + [--name <name>] + [--address-scope <address-scope>] .. option:: --long List additional fields in output +.. option:: --share + + List subnets shared between projects + +.. option:: --no-share + + List subnets not shared between projects + +.. option:: --default + + List subnets used as the default external subnet pool + +.. option:: --no-default + + List subnets not used as the default external subnet pool + +.. option:: --project <project> + + List subnets according to their project (name or ID) + +.. option:: --project-domain <project-domain> + + Domain the project belongs to (name or ID). + This can be used in case collisions between project names exist. + +.. option:: --name <name> + + List only subnets of given name in output + +.. option:: --address-scope <address-scope> + + List only subnets of given address scope (name or ID) in output + subnet pool set --------------- @@ -125,6 +168,7 @@ Set subnet pool properties [--max-prefix-length <max-prefix-length>] [--address-scope <address-scope> | --no-address-scope] [--default | --no-default] + [--description <description>] <subnet-pool> .. option:: --name <name> @@ -165,6 +209,10 @@ Set subnet pool properties Set this as a non-default subnet pool +.. option:: --description <description> + + Set subnet pool description + .. _subnet_pool_set-subnet-pool: .. describe:: <subnet-pool> diff --git a/doc/source/command-objects/subnet.rst b/doc/source/command-objects/subnet.rst index 16092bcd..00401dda 100644 --- a/doc/source/command-objects/subnet.rst +++ b/doc/source/command-objects/subnet.rst @@ -26,6 +26,7 @@ Create new subnet [--gateway <gateway>] [--host-route destination=<subnet>,gateway=<ip-address>] [--ip-version {4,6}] + [--description <description>] [--ipv6-ra-mode {dhcpv6-stateful,dhcpv6-stateless,slaac}] [--ipv6-address-mode {dhcpv6-stateful,dhcpv6-stateless,slaac}] [--network-segment <network-segment>] @@ -100,6 +101,10 @@ Create new subnet IP version is determined from the subnet pool and this option is ignored. +.. option:: --description <description> + + Set subnet description + .. option:: --ipv6-ra-mode {dhcpv6-stateful,dhcpv6-stateless,slaac} IPv6 RA (Router Advertisement) mode, @@ -161,6 +166,11 @@ List subnets [--long] [--ip-version {4,6}] [--dhcp | --no-dhcp] + [--project <project> [--project-domain <project-domain>]] + [--network <network>] + [--gateway <gateway>] + [--name <name>] + [--subnet-range <subnet-range>] .. option:: --long @@ -186,6 +196,32 @@ List subnets Must be a valid device owner value for a network port (repeat option to list multiple service types) +.. option:: --project <project> + + List only subnets which belong to a given project (name or ID) in output + +.. option:: --project-domain <project-domain> + + Domain the project belongs to (name or ID). + This can be used in case collisions between project names exist. + +.. option:: --network <network> + + List only subnets which belong to a given network (name or ID) in output + +.. option:: --gateway <gateway> + + List only subnets of given gateway IP in output + +.. option:: --name <name> + + List only subnets of given name in output + +.. option:: --subnet-range <subnet-range> + + List only subnets of given subnet range (in CIDR notation) in output + e.g.: ``--subnet-range 10.10.0.0/16`` + subnet set ---------- @@ -196,12 +232,15 @@ Set subnet properties os subnet set [--allocation-pool start=<ip-address>,end=<ip-address>] + [--no-allocation-pool] [--dhcp | --no-dhcp] [--dns-nameserver <dns-nameserver>] [--gateway <gateway-ip>] [--host-route destination=<subnet>,gateway=<ip-address>] + [--no-host-route] [--service-type <service-type>] [--name <new-name>] + [--description <description>] <subnet> .. option:: --allocation-pool start=<ip-address>,end=<ip-address> @@ -210,6 +249,12 @@ Set subnet properties ``start=192.168.199.2,end=192.168.199.254`` (repeat option to add multiple IP addresses) +.. option:: --no-allocation-pool + + Clear associated allocation pools from this subnet. + Specify both --allocation-pool and --no-allocation-pool + to overwrite the current allocation pool information. + .. option:: --dhcp Enable DHCP @@ -235,7 +280,12 @@ Set subnet properties ``destination=10.10.0.0/16,gateway=192.168.71.254`` destination: destination subnet (in CIDR notation) gateway: nexthop IP address - (repeat option to add multiple routes) + +.. option:: --no-host-route + + Clear associated host routes from this subnet. + Specify both --host-route and --no-host-route + to overwrite the current host route information. .. option:: --service-type <service-type> @@ -243,6 +293,9 @@ Set subnet properties ``network:floatingip_agent_gateway``. Must be a valid device owner value for a network port (repeat option to set multiple service types) +.. option:: --description <description> + + Set subnet description .. option:: --name @@ -292,9 +345,9 @@ Unset subnet properties .. option:: --allocation-pool start=<ip-address>,end=<ip-address> - Allocation pool to be removed from this subnet e.g.: - ``start=192.168.199.2,end=192.168.199.254`` - (repeat option to unset multiple Allocation pools) + Allocation pool IP addresses to be removed from this + subnet e.g.: ``start=192.168.199.2,end=192.168.199.254`` + (repeat option to unset multiple allocation pools) .. option:: --host-route destination=<subnet>,gateway=<ip-address> @@ -314,4 +367,4 @@ Unset subnet properties .. _subnet_unset-subnet: .. describe:: <subnet> - subnet to modify (name or ID) + Subnet to modify (name or ID) diff --git a/doc/source/command-objects/usage.rst b/doc/source/command-objects/usage.rst index 0c866086..589123a6 100644 --- a/doc/source/command-objects/usage.rst +++ b/doc/source/command-objects/usage.rst @@ -13,8 +13,8 @@ List resource usage per project .. code:: bash os usage list - --start <start> - --end <end> + [--start <start>] + [--end <end>] .. option:: --start <start> @@ -33,9 +33,9 @@ Show resource usage for a single project .. code:: bash os usage show - --project <project> - --start <start> - --end <end> + [--project <project>] + [--start <start>] + [--end <end>] .. option:: --project <project> diff --git a/doc/source/command-objects/volume-backup.rst b/doc/source/command-objects/volume-backup.rst index 3a8f0213..05b02345 100644 --- a/doc/source/command-objects/volume-backup.rst +++ b/doc/source/command-objects/volume-backup.rst @@ -115,6 +115,37 @@ Restore volume backup Volume to restore to (name or ID) +volume backup set +----------------- + +Set volume backup properties + +.. program:: volume backup set +.. code:: bash + + os volume backup set + [--name <name>] + [--description <description>] + [--state <state>] + <backup> + +.. option:: --name <name> + + New backup name + +.. option:: --description <description> + + New backup description + +.. option:: --state <state> + + New backup state ("available" or "error") (admin only) + +.. _backup_set-volume-backup: +.. describe:: <backup> + + Backup to modify (name or ID) + volume backup show ------------------ diff --git a/doc/source/command-objects/volume-service.rst b/doc/source/command-objects/volume-service.rst index d7495968..4fea41fe 100644 --- a/doc/source/command-objects/volume-service.rst +++ b/doc/source/command-objects/volume-service.rst @@ -41,7 +41,8 @@ Set volume service properties os volume service set [--enable | --disable] [--disable-reason <reason>] - <host> <service> + <host> + <service> .. option:: --enable diff --git a/doc/source/command-objects/volume-transfer-request.rst b/doc/source/command-objects/volume-transfer-request.rst index 47299995..b89289a8 100644 --- a/doc/source/command-objects/volume-transfer-request.rst +++ b/doc/source/command-objects/volume-transfer-request.rst @@ -4,6 +4,27 @@ volume transfer request Block Storage v1, v2 +volume transfer request accept +------------------------------ + +Accept volume transfer request + +.. program:: volume transfer request accept +.. code:: bash + + os volume transfer request accept + <transfer-request> + <auth-key> + +.. _volume_transfer_request_accept: +.. describe:: <transfer-request> + + Volume transfer request to accept (name or ID) + +.. describe:: <auth-key> + + Authentication key of transfer request + volume transfer request create ------------------------------ @@ -56,3 +77,19 @@ Lists all volume transfer requests. Shows detail for all projects. Admin only. (defaults to False) + +volume transfer request show +---------------------------- + +Show volume transfer request details + +.. program:: volume transfer request show +.. code:: bash + + os volume transfer request show + <transfer-request> + +.. _volume_transfer_request_show-transfer-request: +.. describe:: <transfer-request> + + Volume transfer request to display (name or ID) diff --git a/doc/source/command-objects/volume.rst b/doc/source/command-objects/volume.rst index 141c980a..26d4ead6 100644 --- a/doc/source/command-objects/volume.rst +++ b/doc/source/command-objects/volume.rst @@ -193,6 +193,7 @@ Set volume properties [--property <key=value> [...] ] [--image-property <key=value> [...] ] [--state <state>] + [--bootable | --non-bootable] <volume> .. option:: --name <name> @@ -211,6 +212,14 @@ Set volume properties Set a property on this volume (repeat option to set multiple properties) +.. option:: --bootable + + Mark volume as bootable + +.. option:: --non-bootable + + Mark volume as non-bootable + .. option:: --image-property <key=value> Set an image property on this volume |