summaryrefslogtreecommitdiff
path: root/doc/source/cli/command-objects/network-flavor-profile.rst
diff options
context:
space:
mode:
authorDoug Hellmann <doug@doughellmann.com>2017-06-13 15:55:33 -0400
committerAndreas Jaeger <aj@suse.com>2017-06-23 11:54:32 +0200
commit9599ffe65d9dcd4b3aa780d346eccd1e760890bf (patch)
tree9281e521e50b8bed66eca087bc11fa03adf2aed3 /doc/source/cli/command-objects/network-flavor-profile.rst
parent19c8cabeca1ea3c83da734ab5269318b27eb5634 (diff)
downloadpython-openstackclient-9599ffe65d9dcd4b3aa780d346eccd1e760890bf.tar.gz
reorganize existing documentation according to the new standard layout
Move existing content around based on the doc-migration specification. Replace :doc: markup with :ref: to have sphinx keep track of where the files move and generate valid hyperlinks. Add a few toctrees and index pages for the new directories. Depends-On: Ia750cb049c0f53a234ea70ce1f2bbbb7a2aa9454 Change-Id: I253ee8f89d3ec40e39310c18bb87ed1d3d5de330 Signed-off-by: Doug Hellmann <doug@doughellmann.com>
Diffstat (limited to 'doc/source/cli/command-objects/network-flavor-profile.rst')
-rw-r--r--doc/source/cli/command-objects/network-flavor-profile.rst145
1 files changed, 145 insertions, 0 deletions
diff --git a/doc/source/cli/command-objects/network-flavor-profile.rst b/doc/source/cli/command-objects/network-flavor-profile.rst
new file mode 100644
index 00000000..fdb95059
--- /dev/null
+++ b/doc/source/cli/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)