diff options
Diffstat (limited to 'doc/source/command-objects')
| -rw-r--r-- | doc/source/command-objects/consistency-group-snapshot.rst | 96 | ||||
| -rw-r--r-- | doc/source/command-objects/consistency-group.rst | 36 | ||||
| -rw-r--r-- | doc/source/command-objects/floating-ip.rst | 21 | ||||
| -rw-r--r-- | doc/source/command-objects/image.rst | 6 | ||||
| -rw-r--r-- | doc/source/command-objects/network-service-provider.rst | 18 | ||||
| -rw-r--r-- | doc/source/command-objects/network.rst | 16 | ||||
| -rw-r--r-- | doc/source/command-objects/port.rst | 18 | ||||
| -rw-r--r-- | doc/source/command-objects/subnet.rst | 8 |
8 files changed, 217 insertions, 2 deletions
diff --git a/doc/source/command-objects/consistency-group-snapshot.rst b/doc/source/command-objects/consistency-group-snapshot.rst new file mode 100644 index 00000000..b7b1423e --- /dev/null +++ b/doc/source/command-objects/consistency-group-snapshot.rst @@ -0,0 +1,96 @@ +========================== +consistency group snapshot +========================== + +Block Storage v2 + +consistency group snapshot create +--------------------------------- + +Create new consistency group snapshot. + +.. program:: consistency group snapshot create +.. code:: bash + + os consistency group snapshot create + [--consistency-group <consistency-group>] + [--description <description>] + [<snapshot-name>] + +.. option:: --consistency-group <consistency-group> + + Consistency group to snapshot (name or ID) + (default to be the same as <snapshot-name>) + +.. option:: --description <description> + + Description of this consistency group snapshot + +.. _consistency_group_snapshot_create-snapshot-name: +.. option:: <snapshot-name> + + Name of new consistency group snapshot (default to None) + +consistency group snapshot delete +--------------------------------- + +Delete consistency group snapshot(s) + +.. program:: consistency group snapshot delete +.. code:: bash + + os consistency group snapshot delete + <consistency-group-snapshot> [<consistency-group-snapshot> ...] + +.. _consistency_group_snapshot_delete-consistency-group-snapshot: +.. describe:: <consistency-group-snapshot> + + Consistency group snapshot(s) to delete (name or ID) + +consistency group snapshot list +------------------------------- + +List consistency group snapshots. + +.. program:: consistency group snapshot list +.. code:: bash + + os consistency group snapshot list + [--all-projects] + [--long] + [--status <status>] + [--consistency-group <consistency-group>] + +.. option:: --all-projects + + Show detail for all projects. Admin only. + (defaults to False) + +.. option:: --long + + List additional fields in output + +.. option:: --status <status> + + Filters results by a status + ("available", "error", "creating", "deleting" or "error_deleting") + +.. option:: --consistency-group <consistency-group> + + Filters results by a consistency group (name or ID) + +consistency group snapshot show +------------------------------- + +Display consistency group snapshot details. + +.. program:: consistency group snapshot show +.. code:: bash + + os consistency group snapshot show + <consistency-group-snapshot> + +.. _consistency_group_snapshot_show-consistency-group-snapshot: +.. describe:: <consistency-group-snapshot> + + Consistency group snapshot to display (name or ID) diff --git a/doc/source/command-objects/consistency-group.rst b/doc/source/command-objects/consistency-group.rst index f24df0d1..c8c4577c 100644 --- a/doc/source/command-objects/consistency-group.rst +++ b/doc/source/command-objects/consistency-group.rst @@ -4,6 +4,42 @@ consistency group Block Storage v2 +consistency group create +------------------------ + +Create new consistency group. + +.. program:: consistency group create +.. code:: bash + + os consistency group create + --volume-type <volume-type> | --consistency-group-source <consistency-group> + [--description <description>] + [--availability-zone <availability-zone>] + [<name>] + +.. option:: --volume-type <volume-type> + + Volume type of this consistency group (name or ID) + +.. option:: --consistency-group-source <consistency-group> + + Existing consistency group (name or ID) + +.. option:: --description <description> + + Description of this consistency group + +.. option:: --availability-zone <availability-zone> + + Availability zone for this consistency group + (not available if creating consistency group from source) + +.. _consistency_group_create-name: +.. option:: <name> + + Name of new consistency group (default to None) + consistency group list ---------------------- diff --git a/doc/source/command-objects/floating-ip.rst b/doc/source/command-objects/floating-ip.rst index 2ab21f36..b2cc8af0 100644 --- a/doc/source/command-objects/floating-ip.rst +++ b/doc/source/command-objects/floating-ip.rst @@ -72,6 +72,27 @@ List floating IP(s) .. code:: bash os floating ip list + [--network <network>] + [--port <port>] + [--fixed-ip-address <fixed-ip-address>] + +.. option:: --network <network> + + List floating IP(s) according to given network (name or ID) + + *Network version 2 only* + +.. option:: --port <port> + + List floating IP(s) according to given port (name or ID) + + *Network version 2 only* + +.. option:: --fixed-ip-address <fixed-ip-address> + + List floating IP(s) according to given fixed IP address + + *Network version 2 only* floating ip show ---------------- diff --git a/doc/source/command-objects/image.rst b/doc/source/command-objects/image.rst index 842eab8d..5184f446 100644 --- a/doc/source/command-objects/image.rst +++ b/doc/source/command-objects/image.rst @@ -78,7 +78,8 @@ Create/upload an image .. option:: --disk-format <disk-format> - Image disk format (default: raw) + Image disk format. The supported options are: ami, ari, aki, vhd, vmdk, + raw, qcow2, vhdx, vdi, and iso. The default format is: raw .. option:: --size <size> @@ -337,7 +338,8 @@ Set image properties .. option:: --disk-format <disk-format> - Image disk format (default: raw) + Image disk format. The supported options are: ami, ari, aki, vhd, vmdk, + raw, qcow2, vhdx, vdi, and iso. .. option:: --size <size> diff --git a/doc/source/command-objects/network-service-provider.rst b/doc/source/command-objects/network-service-provider.rst new file mode 100644 index 00000000..344bb880 --- /dev/null +++ b/doc/source/command-objects/network-service-provider.rst @@ -0,0 +1,18 @@ +======================== +network service provider +======================== + +A **network service provider** is a particular driver that implements a +networking service + +Network v2 + +network service provider list +----------------------------- + +List service providers + +.. program:: network service provider list +.. code:: bash + + os network service provider list diff --git a/doc/source/command-objects/network.rst b/doc/source/command-objects/network.rst index 4b72d5e0..06a5247a 100644 --- a/doc/source/command-objects/network.rst +++ b/doc/source/command-objects/network.rst @@ -30,6 +30,7 @@ Create new network [--provider-network-type <provider-network-type>] [--provider-physical-network <provider-physical-network>] [--provider-segment <provider-segment>] + [--qos-policy <qos-policy>] [--transparent-vlan | --no-transparent-vlan] <name> @@ -144,6 +145,12 @@ Create new network *Network version 2 only* +.. option:: --qos-policy <qos-policy> + + QoS policy to attach to this network (name or ID) + + *Network version 2 only* + .. option:: --transparent-vlan Make the network VLAN transparent @@ -303,6 +310,7 @@ Set network properties [--provider-network-type <provider-network-type>] [--provider-physical-network <provider-physical-network>] [--provider-segment <provider-segment>] + [--qos-policy <qos-policy> | --no-qos-policy] [--transparent-vlan | --no-transparent-vlan] <network> @@ -370,6 +378,14 @@ Set network properties VLAN ID for VLAN networks or Tunnel ID for GRE/VXLAN networks +.. option:: --qos-policy <qos-policy> + + QoS policy to attach to this network (name or ID) + +.. option:: --no-qos-policy + + Remove the QoS policy attached to this network + .. option:: --transparent-vlan Make the network VLAN transparent diff --git a/doc/source/command-objects/port.rst b/doc/source/command-objects/port.rst index 173d99b1..3aff2f77 100644 --- a/doc/source/command-objects/port.rst +++ b/doc/source/command-objects/port.rst @@ -29,6 +29,7 @@ Create new port [--mac-address <mac-address>] [--security-group <security-group> | --no-security-group] [--project <project> [--project-domain <project-domain>]] + [--enable-port-security | --disable-port-security] <name> .. option:: --network <network> @@ -99,6 +100,14 @@ Create new port Domain the project belongs to (name or ID). This can be used in case collisions between project names exist. +.. option:: --enable-port-security + + Enable port security for this port (Default) + +.. option:: --disable-port-security + + Disable port security for this port + .. _port_create-name: .. describe:: <name> @@ -182,6 +191,7 @@ Set port properties [--name <name>] [--security-group <security-group>] [--no-security-group] + [--enable-port-security | --disable-port-security] <port> .. option:: --description <description> @@ -251,6 +261,14 @@ Set port properties Clear existing security groups associated with this port +.. option:: --enable-port-security + + Enable port security for this port + +.. option:: --disable-port-security + + Disable port security for this port + .. _port_set-port: .. describe:: <port> diff --git a/doc/source/command-objects/subnet.rst b/doc/source/command-objects/subnet.rst index e2059875..61526192 100644 --- a/doc/source/command-objects/subnet.rst +++ b/doc/source/command-objects/subnet.rst @@ -231,6 +231,7 @@ Set subnet properties [--no-allocation-pool] [--dhcp | --no-dhcp] [--dns-nameserver <dns-nameserver>] + [--no-dns-nameserver] [--gateway <gateway-ip>] [--host-route destination=<subnet>,gateway=<ip-address>] [--no-host-route] @@ -263,6 +264,12 @@ Set subnet properties DNS server for this subnet (repeat option to set multiple DNS servers) +.. option:: --no-dns-nameservers + + Clear existing information of DNS servers. + Specify both --dns-nameserver and --no-dns-nameservers + to overwrite the current DNS server information. + .. option:: --gateway <gateway> Specify a gateway for the subnet. The options are: @@ -289,6 +296,7 @@ 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 |