diff options
Diffstat (limited to 'doc/source/command-objects')
| -rw-r--r-- | doc/source/command-objects/consistency-group.rst | 46 | ||||
| -rw-r--r-- | doc/source/command-objects/flavor.rst | 4 | ||||
| -rw-r--r-- | doc/source/command-objects/image.rst | 37 | ||||
| -rw-r--r-- | doc/source/command-objects/ip-availability.rst | 2 | ||||
| -rw-r--r-- | doc/source/command-objects/meter.rst | 91 | ||||
| -rw-r--r-- | doc/source/command-objects/network-agent.rst | 13 | ||||
| -rw-r--r-- | doc/source/command-objects/network-qos-rule.rst | 165 | ||||
| -rw-r--r-- | doc/source/command-objects/request-token.rst | 3 |
8 files changed, 354 insertions, 7 deletions
diff --git a/doc/source/command-objects/consistency-group.rst b/doc/source/command-objects/consistency-group.rst index 658d9425..e54ac65f 100644 --- a/doc/source/command-objects/consistency-group.rst +++ b/doc/source/command-objects/consistency-group.rst @@ -4,6 +4,28 @@ consistency group Block Storage v2 +consistency group add volume +---------------------------- + +Add volume(s) to consistency group. + +.. program:: consistency group add volume +.. code:: bash + + os consistency group add volume + <consistency-group> + <volume> [<volume> ...] + +.. _consistency_group_add_volume: +.. describe:: <consistency-group> + + Consistency group to contain <volume> (name or ID) + +.. describe:: <volume> + + Volume(s) to add to <consistency-group> (name or ID) + (repeat option to add multiple volumes) + consistency group create ------------------------ @@ -86,13 +108,35 @@ List consistency groups. List additional fields in output +consistency group remove volume +------------------------------- + +Remove volume(s) from consistency group. + +.. program:: consistency group remove volume +.. code:: bash + + os consistency group remove volume + <consistency-group> + <volume> [<volume> ...] + +.. _consistency_group_remove_volume: +.. describe:: <consistency-group> + + Consistency group containing <volume> (name or ID) + +.. describe:: <volume> + + Volume(s) to remove from <consistency-group> (name or ID) + (repeat option to remove multiple volumes) + consistency group set --------------------- Set consistency group properties. .. program:: consistency group set - .. code:: bash +.. code:: bash openstack consistency group set [--name <name>] diff --git a/doc/source/command-objects/flavor.rst b/doc/source/command-objects/flavor.rst index 0900f2ed..971628d7 100644 --- a/doc/source/command-objects/flavor.rst +++ b/doc/source/command-objects/flavor.rst @@ -42,9 +42,9 @@ Create new flavor Ephemeral disk size in GB (default 0G) -.. option:: --swap <size-gb> +.. option:: --swap <size-mb> - Swap space size in GB (default 0G) + Swap space size in MB (default 0M) .. option:: --vcpus <num-cpu> diff --git a/doc/source/command-objects/image.rst b/doc/source/command-objects/image.rst index 7ebcb54a..7a9ead5c 100644 --- a/doc/source/command-objects/image.rst +++ b/doc/source/command-objects/image.rst @@ -76,7 +76,8 @@ Create/upload an image .. option:: --container-format <container-format> - Image container format (default: bare) + Image container format. The supported options are: ami, ari, aki, + bare, docker, ova, ovf. The default format is: bare .. option:: --disk-format <disk-format> @@ -325,6 +326,7 @@ Set image properties [--ramdisk-id <ramdisk-id>] [--activate|--deactivate] [--project <project> [--project-domain <project-domain>]] + [--accept | --reject | --pending] <image> .. option:: --name <name> @@ -341,7 +343,8 @@ Set image properties .. option:: --container-format <container-format> - Image container format (default: bare) + Image container format. The supported options are: ami, ari, aki, + bare, docker, ova, ovf. .. option:: --disk-format <disk-format> @@ -490,6 +493,36 @@ Set image properties .. versionadded:: 2 +.. option:: --accept + + Accept the image membership. + + If `--project` is passed, this will update the membership status for the + given project, otherwise `--project` will default to the project the user + is authenticated to. + + .. versionadded:: 2 + +.. option:: --reject + + Reject the image membership. + + If `--project` is passed, this will update the membership status for the + given project, otherwise `--project` will default to the project the user + is authenticated to. + + .. versionadded:: 2 + +.. option:: --pending + + Reset the image membership to 'pending'. + + If `--project` is passed, this will update the membership status for the + given project, otherwise `--project` will default to the project the user + is authenticated to. + + .. versionadded:: 2 + .. _image_set-image: .. describe:: <image> diff --git a/doc/source/command-objects/ip-availability.rst b/doc/source/command-objects/ip-availability.rst index 73d0599a..dd39e649 100644 --- a/doc/source/command-objects/ip-availability.rst +++ b/doc/source/command-objects/ip-availability.rst @@ -54,7 +54,7 @@ subnet within the network as well. openstack ip availability show <network> -.. _ip_availability_show-network +.. _ip_availability_show-network: .. describe:: <network> Show IP availability for a specific network (name or ID) diff --git a/doc/source/command-objects/meter.rst b/doc/source/command-objects/meter.rst new file mode 100644 index 00000000..6077ce92 --- /dev/null +++ b/doc/source/command-objects/meter.rst @@ -0,0 +1,91 @@ +============= +network meter +============= + +A **network meter** allows operators to measure +traffic for a specific IP range. The following commands +are specific to the L3 metering extension. + +Network v2 + +network meter create +-------------------- + +Create network meter + +.. program:: network meter create +.. code:: bash + + openstack network meter create + [--project <project> [--project-domain <project-domain>]] + [--description <description>] + [--share | --no-share] + <name> + +.. option:: --project <project> + + Owner's project (name of ID) + + *Network version 2 only* + +.. option:: --description <description> + + Description of meter + + *Network version 2 only* + +.. option:: --share + + Share the meter between projects + +.. option:: --no-share + + Do not share the meter between projects (Default) + +.. _network_meter_create: +.. describe:: <name> + + New meter name + +network meter delete +-------------------- + +Delete network meter(s) + +.. program:: network meter delete +.. code:: bash + + openstack network meter delete + <meter> [<meter> ...] + +.. _network_meter_delete: +.. describe:: <meter> + + Meter(s) to delete (name or ID) + +network meter list +------------------ + +List network meters + +.. program:: network meter list +.. code:: bash + + openstack network meter list + + +network meter show +------------------ + +Show network meter + +.. program:: network meter show +.. code:: bash + + openstack network meter show + <meter> + +.. _network_meter_show: +.. describe:: <meter> + + Meter to display (name or ID) diff --git a/doc/source/command-objects/network-agent.rst b/doc/source/command-objects/network-agent.rst index b95f2e50..947e07cf 100644 --- a/doc/source/command-objects/network-agent.rst +++ b/doc/source/command-objects/network-agent.rst @@ -35,6 +35,19 @@ List network agents .. code:: bash openstack network agent list + [--agent-type <agent-type>] + [--host <host>] + +.. option:: --agent-type <agent-type> + + List only agents with the specified agent type. + The supported agent types are: dhcp, open-vswitch, + linux-bridge, ofa, l3, loadbalancer, metering, + metadata, macvtap, nic. + +.. option:: --host <host> + + List only agents running on the specified host network agent set ----------------- diff --git a/doc/source/command-objects/network-qos-rule.rst b/doc/source/command-objects/network-qos-rule.rst new file mode 100644 index 00000000..b98244b1 --- /dev/null +++ b/doc/source/command-objects/network-qos-rule.rst @@ -0,0 +1,165 @@ +================ +network qos rule +================ + +A **Network QoS rule** specifies a rule defined in a Network QoS policy; its +type is defined by the parameter 'type'. Can be assigned, within a Network QoS +policy, to a port or a network. Each Network QoS policy can contain several +rules, each of them + +Network v2 + +network qos rule create +----------------------- + +Create new Network QoS rule + +.. program:: network qos rule create +.. code:: bash + + os network qos rule create + --type <type> + [--max-kbps <max-kbps>] + [--max-burst-kbits <max-burst-kbits>] + [--dscp-marks <dscp-marks>] + [--min-kbps <min-kbps>] + [--ingress | --egress] + <qos-policy> + +.. option:: --type <type> + + QoS rule type (minimum-bandwidth, dscp-marking, bandwidth-limit) + +.. option:: --max-kbps <min-kbps> + + Maximum bandwidth in kbps + +.. option:: --max-burst-kbits <max-burst-kbits> + + Maximum burst in kilobits, 0 means automatic + +.. option:: --dscp-mark <dscp-mark> + + DSCP mark: value can be 0, even numbers from 8-56, excluding 42, 44, 50, + 52, and 54 + +.. option:: --min-kbps <min-kbps> + + Minimum guaranteed bandwidth in kbps + +.. option:: --ingress + + Ingress traffic direction from the project point of view + +.. option:: --egress + + Egress traffic direction from the project point of view + +.. describe:: <qos-policy> + + QoS policy that contains the rule (name or ID) + +network qos rule delete +----------------------- + +Delete Network QoS rule + +.. program:: network qos rule delete +.. code:: bash + + os network qos rule delete + <qos-policy> + <rule-id> + +.. describe:: <qos-policy> + + QoS policy that contains the rule (name or ID) + +.. describe:: <rule-id> + + Network QoS rule to delete (ID) + +network qos rule list +--------------------- + +List Network QoS rules + +.. program:: network qos rule list +.. code:: bash + + os network qos rule list + <qos-policy> + +.. describe:: <qos-policy> + + QoS policy that contains the rule (name or ID) + +network qos rule set +-------------------- + +Set Network QoS rule properties + +.. program:: network qos rule set +.. code:: bash + + os network qos rule set + [--max-kbps <max-kbps>] + [--max-burst-kbits <max-burst-kbits>] + [--dscp-marks <dscp-marks>] + [--min-kbps <min-kbps>] + [--ingress | --egress] + <qos-policy> + <rule-id> + +.. option:: --max-kbps <min-kbps> + + Maximum bandwidth in kbps + +.. option:: --max-burst-kbits <max-burst-kbits> + + Maximum burst in kilobits, 0 means automatic + +.. option:: --dscp-mark <dscp-mark> + + DSCP mark: value can be 0, even numbers from 8-56, excluding 42, 44, 50, + 52, and 54 + +.. option:: --min-kbps <min-kbps> + + Minimum guaranteed bandwidth in kbps + +.. option:: --ingress + + Ingress traffic direction from the project point of view + +.. option:: --egress + + Egress traffic direction from the project point of view + +.. describe:: <qos-policy> + + QoS policy that contains the rule (name or ID) + +.. describe:: <rule-id> + + Network QoS rule to delete (ID) + +network qos rule show +--------------------- + +Display Network QoS rule details + +.. program:: network qos rule show +.. code:: bash + + os network qos rule show + <qos-policy> + <rule-id> + +.. describe:: <qos-policy> + + QoS policy that contains the rule (name or ID) + +.. describe:: <rule-id> + + Network QoS rule to delete (ID) diff --git a/doc/source/command-objects/request-token.rst b/doc/source/command-objects/request-token.rst index ec72dd14..3c80780f 100644 --- a/doc/source/command-objects/request-token.rst +++ b/doc/source/command-objects/request-token.rst @@ -24,7 +24,8 @@ Authorize a request token .. option:: --role <role> - Roles to authorize (name or ID) (repeat to set multiple values) (required) + Roles to authorize (name or ID) + (repeat option to set multiple values) (required) request token create -------------------- |