summaryrefslogtreecommitdiff
path: root/doc/source/command-objects
diff options
context:
space:
mode:
authorAnkur Gupta <ankur.gupta@intel.com>2016-10-27 23:37:27 -0500
committerAkihiro Motoki <amotoki@gmail.com>2017-02-22 15:38:16 -0500
commit1169434f42a751ca9ef37fed2fa2fd04fe8b6f8b (patch)
tree938bc5354945edfd4134e422c01c19f3e7664ab9 /doc/source/command-objects
parent3746fd2caf1dd3853a4def5f8f5f228bb1b1871a (diff)
downloadpython-openstackclient-1169434f42a751ca9ef37fed2fa2fd04fe8b6f8b.tar.gz
Auto allocated topology for OSC
Implementation of Auto-allocated topology into OSC. Dependency merged and released in SDK v. 0.9.11 Partially Implements: blueprint network-auto-allocated-topology Change-Id: I16120910893b0b26b0f7f77a184b0378448458c5
Diffstat (limited to 'doc/source/command-objects')
-rw-r--r--doc/source/command-objects/network-auto-allocated-topology.rst69
1 files changed, 69 insertions, 0 deletions
diff --git a/doc/source/command-objects/network-auto-allocated-topology.rst b/doc/source/command-objects/network-auto-allocated-topology.rst
new file mode 100644
index 00000000..4ed68cda
--- /dev/null
+++ b/doc/source/command-objects/network-auto-allocated-topology.rst
@@ -0,0 +1,69 @@
+===============================
+network auto allocated topology
+===============================
+
+An **auto allocated topology** allows admins to quickly set up external
+connectivity for end-users. Only one auto allocated topology is allowed per
+project. For more information on how to set up the resources required
+for auto allocated topology review the documentation at:
+http://docs.openstack.org/newton/networking-guide/config-auto-allocation.html
+
+Network v2
+
+network auto allocated topology create
+--------------------------------------
+
+Create the auto allocated topology for project
+
+.. program:: network auto allocated topology create
+.. code:: bash
+
+ openstack network auto allocated topology create
+ [--or-show]
+ [--check-resources]
+ [--project <project> [--project-domain <project-domain>]]
+
+.. option:: --or-show
+
+ If topology exists returns the topologies information (Default).
+
+.. option:: --check-resources
+
+ Validate the requirements for auto allocated topology.
+ Does not return a topology.
+
+.. option:: --project <project>
+
+ Return the auto allocated topology for a given project.
+ Default is current project.
+
+.. option:: --project-domain <project-domain>
+
+ Domain the project belongs to (name or ID).
+ This can be used in case collisions between project names exist.
+
+.. _network_auto_allocated_topology_create:
+
+
+network auto allocated topology delete
+--------------------------------------
+
+Delete auto allocated topology for project
+
+.. program:: network auto allocated topology delete
+.. code:: bash
+
+ openstack network auto allocated topology delete
+ [--project <project> [--project-domain <project-domain>]]
+
+.. option:: --project <project>
+
+ Delete auto allocated topology for a given project.
+ Default is the current project.
+
+.. option:: --project-domain <project-domain>
+
+ Domain the project belongs to (name or ID).
+ This can be used in case collisions between project names exist.
+
+.. _network_auto_allocated_topology_delete: