summaryrefslogtreecommitdiff
path: root/doc/source/command-objects
diff options
context:
space:
mode:
authorreedip <reedip.banerjee@nectechnologies.in>2016-04-15 13:21:08 +0900
committerReedip <reedip.banerjee@nectechnologies.in>2016-06-29 03:22:25 +0000
commit45b026d7c8e4675a598192bcf4c88f22005cc1d2 (patch)
tree1b81b3a74e9a75bfd9e59e05208ce31d193272e8 /doc/source/command-objects
parent21ac9230e80202b9a736960ace369f0a20af837f (diff)
downloadpython-openstackclient-45b026d7c8e4675a598192bcf4c88f22005cc1d2.tar.gz
Add command to unset information from Subnets
This patch introduces the ``subnet unset`` command to clear the host-routes, allocation-pools and dns-nameservers from subnets. Implements: blueprint network-property-unset Change-Id: I31324a2423f6d2315eed27445dfdcfe863e0b550
Diffstat (limited to 'doc/source/command-objects')
-rw-r--r--doc/source/command-objects/subnet.rst38
1 files changed, 38 insertions, 0 deletions
diff --git a/doc/source/command-objects/subnet.rst b/doc/source/command-objects/subnet.rst
index fe77ccfd..30516789 100644
--- a/doc/source/command-objects/subnet.rst
+++ b/doc/source/command-objects/subnet.rst
@@ -235,3 +235,41 @@ Display subnet details
.. describe:: <subnet>
Subnet to display (name or ID)
+
+subnet unset
+------------
+
+Unset subnet properties
+
+.. program:: subnet unset
+.. code:: bash
+
+ os subnet unset
+ [--allocation-pool start=<ip-address>,end=<ip-address> [...]]
+ [--dns-nameserver <dns-nameserver> [...]]
+ [--host-route destination=<subnet>,gateway=<ip-address> [...]]
+ <subnet>
+
+.. option:: --dns-nameserver <dns-nameserver>
+
+ DNS server to be removed from this subnet
+ (repeat option to unset multiple DNS servers)
+
+.. option:: --allocation-pool start=<ip-address>,end=<ip-address>
+
+ Allocation pool to be removed from this subnet e.g.:
+ ``start=192.168.199.2,end=192.168.199.254``
+ (repeat option to unset multiple Allocation pools)
+
+.. option:: --host-route destination=<subnet>,gateway=<ip-address>
+
+ Route to be removed from this subnet e.g.:
+ ``destination=10.10.0.0/16,gateway=192.168.71.254``
+ destination: destination subnet (in CIDR notation)
+ gateway: nexthop IP address
+ (repeat option to unset multiple host routes)
+
+.. _subnet_unset-subnet:
+.. describe:: <subnet>
+
+ subnet to modify (name or ID)