diff options
Diffstat (limited to 'doc/source/command-objects')
| -rw-r--r-- | doc/source/command-objects/network-segment.rst | 101 | ||||
| -rw-r--r-- | doc/source/command-objects/network.rst | 10 | ||||
| -rw-r--r-- | doc/source/command-objects/port.rst | 5 | ||||
| -rw-r--r-- | doc/source/command-objects/subnet-pool.rst | 10 | ||||
| -rw-r--r-- | doc/source/command-objects/subnet.rst | 9 | ||||
| -rw-r--r-- | doc/source/command-objects/volume-transfer-request.rst | 37 |
6 files changed, 171 insertions, 1 deletions
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 8cc250d5..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 @@ -249,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>] @@ -277,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 771f2f8d..04cf59a2 100644 --- a/doc/source/command-objects/port.rst +++ b/doc/source/command-objects/port.rst @@ -116,6 +116,7 @@ List ports os port list [--device-owner <device-owner>] [--router <router> | --server <server>] + [--network <network>] .. option:: --device-owner <device-owner> @@ -130,6 +131,10 @@ List ports 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 3330d62d..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) @@ -163,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> @@ -203,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 d2ea6132..64130ee1 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, @@ -233,6 +238,7 @@ Set subnet properties [--host-route destination=<subnet>,gateway=<ip-address>] [--service-type <service-type>] [--name <new-name>] + [--description <description>] <subnet> .. option:: --allocation-pool start=<ip-address>,end=<ip-address> @@ -274,6 +280,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 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) |