diff options
Diffstat (limited to 'doc/source/command-objects')
| -rw-r--r-- | doc/source/command-objects/group.rst | 10 | ||||
| -rw-r--r-- | doc/source/command-objects/network-agent.rst | 55 | ||||
| -rw-r--r-- | doc/source/command-objects/network-flavor-profile.rst | 145 | ||||
| -rw-r--r-- | doc/source/command-objects/network-qos-policy.rst | 19 | ||||
| -rw-r--r-- | doc/source/command-objects/network.rst | 5 | ||||
| -rw-r--r-- | doc/source/command-objects/port.rst | 5 | ||||
| -rw-r--r-- | doc/source/command-objects/project.rst | 7 | ||||
| -rw-r--r-- | doc/source/command-objects/quota.rst | 23 | ||||
| -rw-r--r-- | doc/source/command-objects/server.rst | 5 |
9 files changed, 270 insertions, 4 deletions
diff --git a/doc/source/command-objects/group.rst b/doc/source/command-objects/group.rst index 3c3199cf..ac938efd 100644 --- a/doc/source/command-objects/group.rst +++ b/doc/source/command-objects/group.rst @@ -16,7 +16,7 @@ Add user to group [--group-domain <group-domain>] [--user-domain <user-domain>] <group> - <user> + <user> [<user> ...] .. option:: --group-domain <group-domain> @@ -38,7 +38,8 @@ Add user to group .. describe:: <user> - User to add to <group> (name or ID) + User(s) to add to <group> (name or ID) + (repeat option to add multiple users) group contains user ------------------- @@ -172,7 +173,7 @@ Remove user from group [--group-domain <group-domain>] [--user-domain <user-domain>] <group> - <user> + <user> [<user> ...] .. option:: --group-domain <group-domain> @@ -194,7 +195,8 @@ Remove user from group .. describe:: <user> - User to remove from <group> (name or ID) + User(s) to remove from <group> (name or ID) + (repeat option to remove multiple users) group set --------- diff --git a/doc/source/command-objects/network-agent.rst b/doc/source/command-objects/network-agent.rst index 947e07cf..f69d0ece 100644 --- a/doc/source/command-objects/network-agent.rst +++ b/doc/source/command-objects/network-agent.rst @@ -10,6 +10,31 @@ agent is "True". Network v2 +network agent add network +------------------------- + +Add network to an agent + +.. program:: network agent add network +.. code:: bash + + openstack network agent add network + [--dhcp] + <agent-id> + <network> + +.. describe:: --dhcp + + Add a network to DHCP agent + +.. describe:: <agent-id> + + Agent to which a network is added (ID only) + +.. describe:: <network> + + Network to be added to an agent (ID or name) + network agent delete -------------------- @@ -37,6 +62,7 @@ List network agents openstack network agent list [--agent-type <agent-type>] [--host <host>] + [--network <network>] .. option:: --agent-type <agent-type> @@ -49,6 +75,10 @@ List network agents List only agents running on the specified host +.. option:: --network <network> + + List agents hosting a network (ID or name) + network agent set ----------------- @@ -94,3 +124,28 @@ Display network agent details .. describe:: <network-agent> Network agent to display (ID only) + +network agent remove network +---------------------------- + +Remove network from an agent + +.. program:: network agent remove network +.. code:: bash + + openstack network agent remove network + [--dhcp] + <agent-id> + <network> + +.. describe:: --dhcp + + Remove network from DHCP agent. + +.. describe:: <agent-id> + + Agent to which a network is removed (ID only) + +.. describe:: <network> + + Network to be removed from an agent (ID or name) diff --git a/doc/source/command-objects/network-flavor-profile.rst b/doc/source/command-objects/network-flavor-profile.rst new file mode 100644 index 00000000..fdb95059 --- /dev/null +++ b/doc/source/command-objects/network-flavor-profile.rst @@ -0,0 +1,145 @@ +====================== +network flavor profile +====================== + +A **network flavor profile** allows administrators to create, delete, list, +show and update network service profile, which details a framework to enable +operators to configure and users to select from different abstract +representations of a service implementation in the Networking service. +It decouples the logical configuration from its instantiation enabling +operators to create user options according to deployment needs. + +Network v2 + +network flavor profile create +----------------------------- + +Create a new network flavor profile + +.. program:: network flavor profile create +.. code:: bash + + openstack network flavor profile create + [--project <project> [--project-domain <project-domain>]] + [--description <description>] + [--enable | --disable] + (--driver <driver> | --metainfo <metainfo> | --driver <driver> --metainfo <metainfo>) + +.. 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 + +.. option:: --description <description> + + Description for the flavor profile + + *Network version 2 only* + +.. option:: --enable + + Enable the flavor profile (default) + +.. option:: --disable + + Disable the flavor profile + +.. option:: --driver <driver> + + Python module path to driver + + *Network version 2 only* + +.. option:: --metainfo <metainfo> + + Metainfo for the flavor profile + + *Network version 2 only* + + +network flavor profile delete +----------------------------- + +Delete network flavor profile + +.. program:: network flavor profile delete +.. code:: bash + + openstack network flavor profile delete + <flavor-profile-id> [<flavor-profile-id> ...] + +.. describe:: <flavor-profile-id> + + Flavor profile(s) to delete (ID only) + +network flavor profile list +--------------------------- + +List network flavor profiles + +.. program:: network flavor profile list +.. code:: bash + + openstack network flavor profile list + +network flavor profile set +-------------------------- + +Set network flavor profile properties + +.. program:: network flavor profile set +.. code:: bash + + openstack network flavor profile set + [--description <description>] + [--driver <driver>] + [--enable | --disable] + [--metainfo <metainfo>] + <flavor-profile-id> + + +.. option:: --description <description> + + Description of the flavor profile + +.. option:: --driver <driver> + + Python module path to driver + +.. option:: --enable (Default) + + Enable the flavor profile + +.. option:: --disable + + Disable the flavor profile + +.. option:: --metainfo <metainfo> + + Metainfo for the flavor profile + +.. describe:: <flavor-profile-id> + + Flavor profile to update (ID only) + +network flavor profile show +--------------------------- + +Show network flavor profile + +.. program:: network flavor profile show +.. code:: bash + + openstack network flavor profile show + <flavor-profile-id> + +.. describe:: <flavor-profile-id> + + Flavor profile to display (ID only) diff --git a/doc/source/command-objects/network-qos-policy.rst b/doc/source/command-objects/network-qos-policy.rst index 7ec6776c..a75c32fe 100644 --- a/doc/source/command-objects/network-qos-policy.rst +++ b/doc/source/command-objects/network-qos-policy.rst @@ -73,6 +73,25 @@ List Network QoS policies .. code:: bash openstack network qos policy list + [--project <project> [--project-domain <project-domain>]] + [--share | --no-share] + +.. option:: --project <project> + + List qos policies 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 qos policies shared between projects + +.. option:: --no-share + + List qos policies not shared between projects network qos policy set ---------------------- diff --git a/doc/source/command-objects/network.rst b/doc/source/command-objects/network.rst index dc597443..9162dbff 100644 --- a/doc/source/command-objects/network.rst +++ b/doc/source/command-objects/network.rst @@ -203,6 +203,7 @@ List networks [--provider-network-type <provider-network-type>] [--provider-physical-network <provider-physical-network>] [--provider-segment <provider-segment>] + [--agent <agent-id>] .. option:: --external @@ -290,6 +291,10 @@ List networks *Network version 2 only* +.. option:: --agent <agent-id> + + List networks hosted by agent (ID only) + network set ----------- diff --git a/doc/source/command-objects/port.rst b/doc/source/command-objects/port.rst index 5080addb..98642b9a 100644 --- a/doc/source/command-objects/port.rst +++ b/doc/source/command-objects/port.rst @@ -219,6 +219,7 @@ Set port properties [--host <host-id>] [--enable | --disable] [--name <name>] + [--mac-address <mac-address>] [--security-group <security-group>] [--no-security-group] [--enable-port-security | --disable-port-security] @@ -285,6 +286,10 @@ Set port properties Set port name +.. option:: --mac-address + + Set port's MAC address (admin only) + .. option:: --security-group <security-group> Security group to associate with this port (name or ID) diff --git a/doc/source/command-objects/project.rst b/doc/source/command-objects/project.rst index 018cea3e..cb0941ca 100644 --- a/doc/source/command-objects/project.rst +++ b/doc/source/command-objects/project.rst @@ -95,6 +95,7 @@ List projects openstack project list [--domain <domain>] [--user <user>] + [--my-projects] [--long] [--sort <key>[:<direction>,<key>:<direction>,..]] @@ -110,6 +111,12 @@ List projects .. versionadded:: 3 +.. option:: --my-projects + + List projects for the authenticated user. Supersedes other filters. + + .. versionadded:: 3 + .. option:: --long List additional fields in output diff --git a/doc/source/command-objects/quota.rst b/doc/source/command-objects/quota.rst index 70e28dd8..f39536af 100644 --- a/doc/source/command-objects/quota.rst +++ b/doc/source/command-objects/quota.rst @@ -7,6 +7,29 @@ single object with multiple properties. Block Storage v1, v2, Compute v2, Network v2 +quota list +---------- + +List quotas for all projects with non-default quota values + +.. program:: quota list +.. code:: bash + + openstack quota list + --compute | --network | --volume + +.. option:: --network + + List network quotas + +.. option:: --compute + + List compute quotas + +.. option:: --volume + + List volume quotas + quota set --------- diff --git a/doc/source/command-objects/server.rst b/doc/source/command-objects/server.rst index b2ae965a..047bf181 100644 --- a/doc/source/command-objects/server.rst +++ b/doc/source/command-objects/server.rst @@ -33,9 +33,14 @@ Add floating IP address to server .. code:: bash openstack server add floating ip + [--fixed-ip-address <fixed-ip-address>] <server> <ip-address> +.. option:: --fixed-ip-address <fixed-ip-address> + + Fixed IP address to associate with this floating IP address + .. describe:: <server> Server (name or ID) to receive the floating IP address |