summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorNakul Dahiwade <nakul.dahiwade@intel.com>2016-11-11 21:42:24 +0000
committerNakul Dahiwade <nakul.dahiwade@intel.com>2017-03-20 16:24:27 +0000
commit7ef1e9ea96ef15b63304a6bccaf30f8c269f2b76 (patch)
tree4ab88bee8ac05e515ee8203e52b53b4f3c14d053 /doc
parent69b7b9b0592d3699a02bb8d17539c20749281b8d (diff)
downloadpython-openstackclient-7ef1e9ea96ef15b63304a6bccaf30f8c269f2b76.tar.gz
OSC Network Flavor Profile
Implement Neutron feature of Network Flavor Profile into OpenstackClient This patch implements the following commands: network flavor profile create network flavor profile delete network flavor profile list network flavor profile show network flavor profile set SDK Version needed: 0.9.9 Change-Id: Ie6fe5e53122cfb2eda8d326851d54562739a8386 Partially-Implements: blueprint neutron-client-flavors
Diffstat (limited to 'doc')
-rw-r--r--doc/source/command-objects/network-flavor-profile.rst145
-rw-r--r--doc/source/commands.rst1
2 files changed, 146 insertions, 0 deletions
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/commands.rst b/doc/source/commands.rst
index a0c67cd4..ccd081e8 100644
--- a/doc/source/commands.rst
+++ b/doc/source/commands.rst
@@ -113,6 +113,7 @@ referring to both Compute and Volume quotas.
* ``network agent``: (**Network**) - A network agent is an agent that handles various tasks used to implement virtual networks
* ``network auto allocated topology``: (**Network**) - an auto-allocated topology for a project
* ``network flavor``: (**Network**) - allows the user to choose the type of service by a set of advertised service capabilities (e.g., LOADBALANCER, FWAAS, L3, VPN, etc) rather than by a provider type or named vendor
+* ``network flavor profile``: (**Network**) - predefined neutron service configurations: driver
* ``network meter``: (**Network**) - allow traffic metering in a network
* ``network meter rule``: (**Network**) - rules for network traffic metering
* ``network rbac``: (**Network**) - an RBAC policy for network resources