diff options
Diffstat (limited to 'doc/source/command-objects')
| -rw-r--r-- | doc/source/command-objects/network.rst | 28 | ||||
| -rw-r--r-- | doc/source/command-objects/port.rst | 10 | ||||
| -rw-r--r-- | doc/source/command-objects/router.rst | 2 | ||||
| -rw-r--r-- | doc/source/command-objects/security-group-rule.rst | 37 | ||||
| -rw-r--r-- | doc/source/command-objects/subnet-pool.rst | 8 | ||||
| -rw-r--r-- | doc/source/command-objects/subnet.rst | 4 | ||||
| -rw-r--r-- | doc/source/command-objects/volume-type.rst | 13 |
7 files changed, 84 insertions, 18 deletions
diff --git a/doc/source/command-objects/network.rst b/doc/source/command-objects/network.rst index 622568e4..e2f5eaf0 100644 --- a/doc/source/command-objects/network.rst +++ b/doc/source/command-objects/network.rst @@ -59,7 +59,7 @@ Create new network .. option:: --availability-zone-hint <availability-zone> Availability Zone in which to create this network - (requires the Network Availability Zone extension, + (Network Availability Zone extension required, repeat option to set multiple availability zones) *Network version 2 only* @@ -72,8 +72,8 @@ Create new network .. option:: --external - Set this network as an external network. - Requires the "external-net" extension to be enabled. + Set this network as an external network + (external-net extension required) *Network version 2 only* @@ -92,8 +92,8 @@ Create new network .. option:: --no-default - Do not use the network as the default external network. - By default, no network is set as an external network. + Do not use the network as the default external network + (default) *Network version 2 only* @@ -171,6 +171,7 @@ Set network properties [--name <name>] [--enable | --disable] [--share | --no-share] + [--external [--default | --no-default] | --internal] <network> .. option:: --name <name> @@ -193,6 +194,23 @@ Set network properties Do not share the network between projects +.. option:: --external + + Set this network as an external network. + (external-net extension required) + +.. option:: --internal + + Set this network as an internal network + +.. option:: --default + + Set the network as the default external network + +.. option:: --no-default + + Do not use the network as the default external network. + .. _network_set-network: .. describe:: <network> diff --git a/doc/source/command-objects/port.rst b/doc/source/command-objects/port.rst index cc7723ea..36e83082 100644 --- a/doc/source/command-objects/port.rst +++ b/doc/source/command-objects/port.rst @@ -45,8 +45,8 @@ Create new port .. option:: --vnic-type <vnic-type> - VNIC type for this port (direct | direct-physical | macvtap | normal | baremetal). - If unspecified during port creation, default value will be 'normal'. + VNIC type for this port (direct | direct-physical | macvtap | normal | baremetal, + default: normal) .. option:: --binding-profile <binding-profile> @@ -141,7 +141,7 @@ Set port properties .. option:: --no-fixed-ip - Clear existing information of fixed-ips + Clear existing information of fixed IP addresses .. option:: --device <device-id> @@ -153,8 +153,8 @@ Set port properties .. option:: --vnic-type <vnic-type> - VNIC type for this port (direct | direct-physical | macvtap | normal | baremetal). - If unspecified during port creation, default value will be 'normal'. + VNIC type for this port (direct | direct-physical | macvtap | normal | baremetal, + default: normal) .. option:: --binding-profile <binding-profile> diff --git a/doc/source/command-objects/router.rst b/doc/source/command-objects/router.rst index dc645712..1503516e 100644 --- a/doc/source/command-objects/router.rst +++ b/doc/source/command-objects/router.rst @@ -87,7 +87,7 @@ Create new router .. option:: --availability-zone-hint <availability-zone> Availability Zone in which to create this router - (requires the Router Availability Zone extension, + (Router Availability Zone extension required, repeat option to set multiple availability zones) .. _router_create-name: diff --git a/doc/source/command-objects/security-group-rule.rst b/doc/source/command-objects/security-group-rule.rst index fa07c377..2f212e5e 100644 --- a/doc/source/command-objects/security-group-rule.rst +++ b/doc/source/command-objects/security-group-rule.rst @@ -16,6 +16,9 @@ Create a new security group rule [--proto <proto>] [--src-ip <ip-address> | --src-group <group>] [--dst-port <port-range>] + [--ingress | --egress] + [--ethertype <ethertype>] + [--project <project> [--project-domain <project-domain>]] <group> .. option:: --proto <proto> @@ -24,7 +27,8 @@ Create a new security group rule .. option:: --src-ip <ip-address> - Source IP address block (may use CIDR notation; default: 0.0.0.0/0) + Source IP address block + (may use CIDR notation; default for IPv4 rule: 0.0.0.0/0) .. option:: --src-group <group> @@ -35,6 +39,37 @@ Create a new security group rule Destination port, may be a single port or port range: 137:139 (only required for IP protocols tcp and udp) +.. option:: --ingress + + Rule applies to incoming network traffic (default) + + *Network version 2 only* + +.. option:: --egress + + Rule applies to outgoing network traffic + + *Network version 2 only* + +.. option:: --ethertype <ethertype> + + Ethertype of network traffic (IPv4, IPv6; default: IPv4) + + *Network version 2 only* + +.. option:: --project <project> + + Owner's 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* + .. describe:: <group> Create rule 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 80a9c013..3b7d0e91 100644 --- a/doc/source/command-objects/subnet-pool.rst +++ b/doc/source/command-objects/subnet-pool.rst @@ -49,8 +49,8 @@ Create subnet pool .. option:: --address-scope <address-scope> - Set address scope associated with the subnet pool (name or ID). - Prefixes must be unique across address scopes. + Set address scope associated with the subnet pool (name or ID), + prefixes must be unique across address scopes .. _subnet_pool_create-name: .. describe:: <name> @@ -128,8 +128,8 @@ Set subnet pool properties .. option:: --address-scope <address-scope> - Set address scope associated with the subnet pool (name or ID). - Prefixes must be unique across address scopes. + Set address scope associated with the subnet pool (name or ID), + prefixes must be unique across address scopes .. option:: --no-address-scope diff --git a/doc/source/command-objects/subnet.rst b/doc/source/command-objects/subnet.rst index 50be5b0a..35134f46 100644 --- a/doc/source/command-objects/subnet.rst +++ b/doc/source/command-objects/subnet.rst @@ -206,7 +206,7 @@ Set subnet properties subnet show ----------- -Show subnet details +Display subnet details .. program:: subnet show .. code:: bash @@ -217,4 +217,4 @@ Show subnet details .. _subnet_show-subnet: .. describe:: <subnet> - Subnet to show (name or ID) + Subnet to display (name or ID) diff --git a/doc/source/command-objects/volume-type.rst b/doc/source/command-objects/volume-type.rst index 64b1bd52..b7aea632 100644 --- a/doc/source/command-objects/volume-type.rst +++ b/doc/source/command-objects/volume-type.rst @@ -151,12 +151,25 @@ Unset volume type properties os volume type unset [--property <key>] + [--project <project>] + [--project-domain <project-domain>] <volume-type> .. option:: --property <key> Property to remove from volume type (repeat option to remove multiple properties) +.. option:: --project <project> + + Removes volume type access from project (name or ID) (admin only) + + *Volume 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. + .. _volume_type_unset-volume-type: .. describe:: <volume-type> |