summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorAnindita Das <anindita.das@intel.com>2016-10-05 15:57:53 +0000
committerAnindita Das <anindita.das@intel.com>2017-02-22 02:45:51 +0000
commitedaeece7f144545bff9a7b00fccd2ec598ee2144 (patch)
treefd8dc3f06a6652b8712fa6756100460be08ea358 /doc
parent62938c02e077049e3e4ebb393045ba0fa783c72d (diff)
downloadpython-openstackclient-edaeece7f144545bff9a7b00fccd2ec598ee2144.tar.gz
OSC Network Flavor
Implements Neutron feature of Network Flavor into OpenstackClient This patch implements the following commands: network flavor create network flavor delete network flavor list network flavor show network flavor set Works with openstacksdk version 0.9.8 Change-Id: I29d7a62341010a1d067a8ca93bccb7d9b8d4c425 Partially-Implements: blueprint neutron-client-flavors Partially-Implements: blueprint network-commands-options
Diffstat (limited to 'doc')
-rw-r--r--doc/source/command-objects/network-flavor.rst133
-rw-r--r--doc/source/command-objects/network-service-provider.rst1
-rw-r--r--doc/source/commands.rst1
3 files changed, 135 insertions, 0 deletions
diff --git a/doc/source/command-objects/network-flavor.rst b/doc/source/command-objects/network-flavor.rst
new file mode 100644
index 00000000..1324499e
--- /dev/null
+++ b/doc/source/command-objects/network-flavor.rst
@@ -0,0 +1,133 @@
+==============
+network flavor
+==============
+
+A **network flavor** extension allows the user selection of operator-curated
+flavors during resource creations. It allows administrators to create network
+service flavors.
+
+Network v2
+
+.. _network_flavor_create:
+network flavor create
+---------------------
+
+Create network flavor
+
+.. program:: network flavor create
+.. code:: bash
+
+ openstack network flavor create
+ --service-type <service-type>
+ [--description <description>]
+ [--enable | --disable]
+ [--project <project> [--project-domain <project-domain>]]
+ <name>
+
+.. option:: --service-type <service-type>
+
+ Service type to which the flavor applies to: e.g. VPN.
+ (See openstack :ref:'network_service_provider_list` (required)
+
+.. option:: --description <description>
+
+ Description for the flavor
+
+.. option:: --enable
+
+ Enable the flavor (default)
+
+.. option:: --disable
+
+ Disable the flavor
+
+.. option:: --project <project>
+
+ Owner's 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.
+
+.. describe:: <name>
+
+ Name for the flavor
+
+.. _network_flavor_delete:
+network flavor delete
+---------------------
+
+Delete network flavor(s)
+
+.. program:: network flavor delete
+.. code:: bash
+
+ openstack network flavor delete
+ <flavor> [<flavor> ...]
+
+.. describe:: <flavor>
+
+ Flavor(s) to delete (name or ID)
+
+network flavor list
+-------------------
+
+List network flavors
+
+.. program:: network flavor list
+.. code:: bash
+
+ openstack network flavor list
+
+.. _network_flavor_set:
+network flavor set
+------------------
+
+Set network flavor properties
+
+.. program:: network flavor set
+.. code:: bash
+
+ openstack network flavor set
+ [--name <name>]
+ [--description <description>]
+ [--enable | --disable]
+ <flavor>
+
+.. option:: --name <name>
+
+ Set flavor name
+
+.. option:: --description <description>
+
+ Set network flavor description
+
+.. option:: --enable
+
+ Enable network flavor
+
+.. option:: --disable
+
+ Disable network flavor
+
+.. describe:: <flavor>
+
+ Flavor to update (name or ID)
+
+.. _network_flavor_show:
+network flavor show
+-------------------
+
+Show network flavor
+
+.. program:: network flavor show
+.. code:: bash
+
+ openstack network flavor show
+ <flavor>
+
+.. describe:: <flavor>
+
+ Flavor to display (name or ID)
diff --git a/doc/source/command-objects/network-service-provider.rst b/doc/source/command-objects/network-service-provider.rst
index 8db2ab44..8ccec455 100644
--- a/doc/source/command-objects/network-service-provider.rst
+++ b/doc/source/command-objects/network-service-provider.rst
@@ -7,6 +7,7 @@ networking service
Network v2
+.. _network_service_provider_list:
network service provider list
-----------------------------
diff --git a/doc/source/commands.rst b/doc/source/commands.rst
index ece9b34e..68c50d24 100644
--- a/doc/source/commands.rst
+++ b/doc/source/commands.rst
@@ -111,6 +111,7 @@ referring to both Compute and Volume quotas.
* ``module``: (**Internal**) - installed Python modules in the OSC process
* ``network``: (**Compute**, **Network**) - a virtual network for connecting servers and other resources
* ``network agent``: (**Network**) - A network agent is an agent that handles various tasks used to implement virtual networks
+* ``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 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