summaryrefslogtreecommitdiff
path: root/doc/source
diff options
context:
space:
mode:
authorAkihiro Motoki <amotoki@gmail.com>2017-05-21 00:59:46 +0900
committerAkihiro Motoki <amotoki@gmail.com>2017-07-10 11:25:33 +0000
commit423890a4950a725d6b493304d7b933d5b7c090d7 (patch)
tree3f979a7a165632bd9d36b65ece4e17f17a06ecaf /doc/source
parentc4ec6759b6aec38f1662ce0291ce87d9b5317c19 (diff)
downloadpython-neutronclient-423890a4950a725d6b493304d7b933d5b7c090d7.tar.gz
doc: autogenerate OSC plugin command reference
Recently cliff introduced a sphinx extension directive named autoprogram-cliff which genarates command-line help automatically. By using it, we no longer need to write command-line help document separately. Also fixes minor string substitution issue in a BGPVPN command. Note that the new cliff release with the directive is not released yet, but there are several number of OSC plugin commands proposed and having a local copy would help such developers. Change-Id: I6b1aee89f406ac449fbc43e210c4ca7ad901b19b
Diffstat (limited to 'doc/source')
-rw-r--r--doc/source/cli/osc/v2/firewall-group.rst228
-rw-r--r--doc/source/cli/osc/v2/firewall-policy.rst264
-rw-r--r--doc/source/cli/osc/v2/firewall-rule.rst296
-rw-r--r--doc/source/cli/osc/v2/network-trunk.rst173
-rw-r--r--doc/source/cli/osc/v2/networking-bgpvpn.rst381
-rw-r--r--doc/source/conf.py15
6 files changed, 50 insertions, 1307 deletions
diff --git a/doc/source/cli/osc/v2/firewall-group.rst b/doc/source/cli/osc/v2/firewall-group.rst
index b0c24a8..adb8d05 100644
--- a/doc/source/cli/osc/v2/firewall-group.rst
+++ b/doc/source/cli/osc/v2/firewall-group.rst
@@ -8,223 +8,23 @@ router ports within a project.
Network v2
-firewall group create
----------------------
+.. 'firewall group *' cannot be used below as it matches 'firewall group rule
+ *' or 'firewall group policy *'.
-Create a firewall group for a given project.
+.. autoprogram-cliff:: openstack.neutronclient.v2
+ :command: firewall group create
-.. program:: firewall group create
-.. code:: bash
+.. autoprogram-cliff:: openstack.neutronclient.v2
+ :command: firewall group delete
- openstack firewall group create
+.. autoprogram-cliff:: openstack.neutronclient.v2
+ :command: firewall group list
-.. _firewallgroup_create-firewallgroup:
-.. option:: --name <name>
+.. autoprogram-cliff:: openstack.neutronclient.v2
+ :command: firewall group set
- Name for the firewall group.
+.. autoprogram-cliff:: openstack.neutronclient.v2
+ :command: firewall group show
-.. option:: --enable
-
- Enable firewall group (default).
-
-.. option:: --disable
-
- Disable firewall group.
-
-.. option:: --public
-
- Make the firewall group public, which allows it to be used in all projects
- (as opposed to the default, which is to restrict its use to the current
- project).
-
-.. option:: --private
-
- Restrict use of the firewall group to the current project.
-
-.. 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.
-
-.. option:: --description <description>
-
- A description of the firewall group.
-
-.. option:: --ingress-firewall-policy <ingress-firewall-policy>
-
- Ingress firewall policy (name or ID).
-
-.. option:: --no-ingress-firewall-policy
-
- Detach ingress firewall policy from the firewall group.
-
-.. option:: --egress-firewall-policy <egress-firewall-policy>
-
- Egress firewall policy (name or ID).
-
-.. option:: --no-egress-firewall-policy
-
- Detach egress firewall policy from the firewall group.
-
-.. option:: --port <port>
-
- Port(s) to apply firewall group (name or ID).
-
-.. option:: --no-port
-
- Detach all port from the firewall group.
-
-firewall group delete
----------------------
-
-Delete firewall group(s)
-
-.. program:: firewall group delete
-.. code:: bash
-
- openstack firewall group delete
- <firewall-group> [<firewall-group> ...]
-
-.. _firewallgroup_delete-firewallgroup:
-.. describe:: <firewall-group>
-
- Firewall group(s) to delete (name or ID).
-
-firewall group list
--------------------
-
-List all firewall groups
-
-.. program:: firewall group list
-.. code:: bash
-
- openstack firewall group list
- [--long]
-
-.. option:: --long
-
- List additional fields in output.
-
-firewall group set
-------------------
-
-Set firewall group properties
-
-.. program:: firewall group set
-.. code:: bash
-
- openstack firewall group set
-
-.. _firewallgroup_set-firewallgroup:
-.. describe:: <firewall-group>
-
- Firewall group to set (name or ID).
-
-.. option:: --name <name>
-
- Set firewall group name.
-
-.. option:: --enable
-
- Enable firewall group (default).
-
-.. option:: --disable
-
- Disable firewall group.
-
-.. option:: --public
-
- Make the firewall group public, which allows it to be used in all projects
- (as opposed to the default, which is to restrict its use to the current
- project).
-
-.. option:: --private
-
- Restrict use of the firewall group to the current project.
-
-.. option:: --description <description>
-
- A description of the firewall group.
-
-.. option:: --ingress-firewall-policy <ingress-firewall-policy>
-
- Ingress firewall policy (name or ID).
-
-.. option:: --no-ingress-firewall-policy
-
- Detach ingress firewall policy from the firewall group.
-
-.. option:: --egress-firewall-policy
-
- Egress firewall policy (name or ID).
-
-.. option:: --no-egress-firewall-policy
-
- Detach egress firewall policy from the firewall group.
-
-.. option:: --port <port>
-
- Port(s) to apply firewall group.
-
-.. option:: --no-port
-
- Detach all port from the firewall group.
-
-firewall group show
--------------------
-
-Show information of a given firewall group
-
-.. program:: firewall group show
-.. code:: bash
-
- openstack firewall group show
- <firewall-group>
-
-.. _firewallgroup_show-firewallgroup:
-.. describe:: <firewall-group>
-
- Firewall group to display (name or ID).
-
-firewall group unset
---------------------
-
-Unset firewall group properties
-
-.. program:: firewall group unset
-.. code:: bash
-
- openstack firewall group unset
-
-.. _firewallgroup_unset-firewallgroup:
-.. describe:: <firewall-group>
-
- Firewall group to unset (name or ID).
-
-.. option:: --enable
-
- Disable firewall group.
-
-.. option:: --public
-
- Restrict use of the firewall group to the current project.
-
-.. option:: --ingress-firewall-policy
-
- Detach ingress firewall policy from the firewall group.
-
-.. option:: --egress-firewall-policy
-
- Detach egress firewall policy from the firewall group.
-
-.. option:: --port <port>
-
- Remove port(s) from the firewall group.
-
-.. option:: --all-port
-
- Remove all ports from the firewall group.
+.. autoprogram-cliff:: openstack.neutronclient.v2
+ :command: firewall group unset
diff --git a/doc/source/cli/osc/v2/firewall-policy.rst b/doc/source/cli/osc/v2/firewall-policy.rst
index c4a78dd..f05f834 100644
--- a/doc/source/cli/osc/v2/firewall-policy.rst
+++ b/doc/source/cli/osc/v2/firewall-policy.rst
@@ -10,265 +10,5 @@ which create or use the firewall group policy).
Network v2
-firewall group policy create
-----------------------------
-
-Create a firewall policy for a given project
-
-.. program:: firewall group policy create
-.. code:: bash
-
- openstack firewall group policy create
-
-.. _firewallpolicy_create-firewallpolicy:
-.. describe:: <name>
-
- Name for the firewall policy.
-
-.. option:: --enable
-
- Enable firewall policy (default).
-
-.. option:: --disable
-
- Disable firewall policy.
-
-.. option:: --public
-
- Make the firewall policy public, which allows it to be used in all projects
- (as opposed to the default, which is to restrict its use to the current
- project).
-
-.. option:: --private
-
- Restrict use of the firewall policy to the current project.
-
-.. 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.
-
-.. option:: --description <description>
-
- A description of the firewall policy.
-
-.. option:: --firewall-rule <firewall-rule>
-
- Firewall rule(s) to apply (name or ID).
-
-.. option:: --no-firewall-rule
-
- Remove all firewall rules from the firewall policy.
-
-.. option:: --audited
-
- Enable auditing for the policy.
-
-.. option:: --no-audited
-
- Disable auditing for the policy.
-
-
-firewall group policy delete
-----------------------------
-
-Delete a given firewall policy
-
-.. program:: firewall group policy delete
-.. code:: bash
-
- openstack firewall group policy delete
- <firewall-policy> [<firewall-policy> ...]
-
-.. _firewallpolicy_delete-firewallpolicy:
-.. describe:: <firewall-policy>
-
- Firewall policy(s) to delete (name or ID).
-
-firewall group policy list
---------------------------
-
-List all firewall policies
-
-.. program:: firewall group policy list
-.. code:: bash
-
- openstack firewall group policy list
- [--long]
-
-.. option:: --long
-
- List additional fields in output.
-
-firewall group policy set
--------------------------
-
-Set firewall policy properties
-
-.. program:: firewall group policy set
-.. code:: bash
-
- openstack firewall group policy set
-
-.. _firewallpolicy_set-firewallpolicy:
-.. describe:: <firewall-policy>
-
- Firewall policy to set (name or ID).
-
-.. option:: --name <name>
-
- Set firewall policy name.
-
-.. option:: --enable
-
- Enable firewall policy (default).
-
-.. option:: --disable
-
- Disable firewall policy.
-
-.. option:: --public
-
- Make the firewall policy public, which allows it to be used in all projects
- (as opposed to the default, which is to restrict its use to the current
- project).
-
-.. option:: --private
-
- Restrict use of the firewall policy to the current project.
-
-.. 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.
-
-.. option:: --description <description>
-
- A description of the firewall policy.
-
-.. option:: --firewall-rule <firewall-rule>
-
- Firewall rule(s) to apply (name or ID).
-
-.. option:: --no-firewall-rule
-
- Unset all firewall rules from firewall policy.
-
-.. option:: --audited
-
- Enable auditing for the policy.
-
-.. option:: --no-audited
-
- Disable auditing for the policy.
-
-
-firewall group policy show
---------------------------
-
-Show information of a given firewall policy
-
-.. program:: firewall group policy show
-.. code:: bash
-
- openstack firewall group policy show
- <firewall-policy>
-
-.. _firewallpolicy_show-firewallpolicy:
-.. describe:: <firewall-policy>
-
- Firewall policy to display (name or ID).
-
-firewall group policy unset
----------------------------
-
-Unset firewall policy properties
-
-.. program:: firewall group policy unset
-.. code:: bash
-
- openstack firewall group policy unset
-
-.. _firewallpolicy_unset-firewallpolicy:
-.. describe:: <firewall-policy>
-
- Firewall policy to unset (name or ID).
-
-.. option:: --enable
-
- Disable firewall policy.
-
-.. option:: --public
-
- Restrict use of the firewall policy to the current project.
-
-.. option:: --firewall-rule <firewall-rule>
-
- Firewall rule(s) to unset (name or ID).
-
-.. option:: --all-firewall-rule
-
- Remove all firewall rules from the firewall policy.
-
-.. option:: --audited
-
- Disable auditing for the policy.
-
-firewall group policy add rule
-------------------------------
-
-Adds a firewall rule in a firewall policy relative to the position of other
-rules.
-
-.. program:: firewall group policy add rule
-.. code:: bash
-
- openstack firewall group policy add rule
- <firewall-policy>
- <firewall-rule>
-
-.. _firewallpolicy_add_rule-firewallpolicy:
-.. describe:: <firewall-policy>
-
- Firewall policy to add rule (name or ID).
-
-.. describe:: <firewall-rule>
-
- Firewall rule to be inserted (name or ID).
-
-.. option:: --insert-after <firewall-rule>
-
- Insert the new rule after this existing rule (name or ID).
-
-.. option:: --insert-before <firewall-rule>
-
- Insert the new rule before this existing rule (name or ID).
-
-firewall group policy remove rule
----------------------------------
-
-Removes a firewall rule from a firewall policy.
-
-.. program:: firewall group policy remove rule
-.. code:: bash
-
- openstack firewall group policy remove rule
- <firewall-policy>
- <firewall-rule>
-
-.. _firewallpolicy_remove_rule-firewallpolicy:
-.. describe:: <firewall-policy>
-
- Firewall policy to remove rule (name or ID).
-
-.. describe:: <firewall-rule>
-
- Firewall rule to remove from policy (name or ID).
+.. autoprogram-cliff:: openstack.neutronclient.v2
+ :command: firewall group policy *
diff --git a/doc/source/cli/osc/v2/firewall-rule.rst b/doc/source/cli/osc/v2/firewall-rule.rst
index fdb5206..2e75c77 100644
--- a/doc/source/cli/osc/v2/firewall-rule.rst
+++ b/doc/source/cli/osc/v2/firewall-rule.rst
@@ -8,297 +8,5 @@ be taken on the matched data traffic.
Network v2
-firewall group rule create
---------------------------
-
-Create a firewall rule for a given project
-
-.. program:: firewall group rule create
-.. code:: bash
-
- openstack firewall group rule create
-
-.. option:: --name <name>
-
- Set firewall rule name.
-
-.. option:: --enable
-
- Enable firewall rule (default).
-
-.. option:: --disable
-
- Disable firewall rule.
-
-.. option:: --public
-
- Make the firewall rule public, which allows it to be used in all projects
- (as opposed to the default, which is to restrict its use to the current
- project).
-
-.. option:: --private
-
- Restrict use of the firewall rule to the current project.
-
-.. 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.
-
-.. option:: --description <description>
-
- A description of the firewall rule.
-
-.. option:: --protocol <protocol>
-
- Protocol for the firewall rule ('tcp', 'udp', 'icmp', 'any').
- Default is 'any'.
-
-.. option:: --action <action>
-
- Action for the firewall rule ('allow', 'deny', 'reject').
- Default is 'deny'.
-
-.. option:: --ip-version <ip-version>
-
- Set IP version 4 or 6 (default is 4).
-
-.. option:: --source-port <source-port>
-
- Source port number or range
- (integer in [1, 65535] or range like 123:456).
-
-.. option:: --no-source-port
-
- Detach source port number or range.
-
-.. option:: --destination-port <destination-port>
-
- Destination port number or range
- (integer in [1, 65535] or range like 123:456).
-
-.. option:: --no-destination-port
-
- Detach destination port number or range.
-
-.. option:: --source-ip-address <source-ip-address>
-
- Source IP address or subnet.
-
-.. option:: --no-source-ip-address
-
- Detach source IP address.
-
-.. option:: --destination-ip-address <destination-ip-address>
-
- Destination IP address or subnet.
-
-.. option:: --no-destination-ip-address
-
- Detach destination IP address.
-
-.. option:: --enable-rule
-
- Enable this rule (default is enabled).
-
-.. option:: --disable-rule
-
- Disable this rule.
-
-firewall group rule delete
---------------------------
-
-Delete a given firewall rule
-
-.. program:: firewall group rule delete
-.. code:: bash
-
- openstack firewall group rule delete
- <firewall-rule> [<firewall-rule> ...]
-
-.. _firewallrule_delete-firewallrule:
-.. describe:: <firewall-rule>
-
- Firewall rule(s) to delete (name or ID).
-
-firewall group rule list
-------------------------
-
-List all firewall rules
-
-.. program:: firewall group rule list
-.. code:: bash
-
- openstack firewall group rule list
- [--long]
-
-.. option:: --long
-
- List additional fields in output.
-
-firewall group rule set
------------------------
-
-Set firewall rule properties
-
-.. program:: firewall group rule set
-.. code:: bash
-
- openstack firewall group rule set
-
-.. _firewallrule_set-firewallrule:
-.. describe:: <firewall-rule>
-
- Firewall rule to set (name or ID).
-
-.. option:: --name <name>
-
- Set firewall rule name.
-
-.. option:: --enable
-
- Enable firewall rule (default).
-
-.. option:: --disable
-
- Disable firewall rule.
-
-.. option:: --public
-
- Make the firewall rule public, which allows it to be used in all projects
- (as opposed to the default, which is to restrict its use to the current
- project).
-
-.. option:: --private
-
- Restrict use of the firewall rule to the current project.
-
-.. 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.
-
-.. option:: --description <description>
-
- A description of the firewall rule.
-
-.. option:: --protocol <protocol>
-
- Protocol for the firewall rule ('tcp', 'udp', 'icmp', 'any').
-
-.. option:: --action <action>
-
- Action for the firewall rule ('allow', 'deny', 'reject').
-
-.. option:: --ip-version <ip-version>
-
- Set IP version 4 or 6 (default is 4).
-
-.. option:: --source-port <source-port>
-
- Source port number or range
- (integer in [1, 65535] or range like 123:456).
-
-.. option:: --no-source-port
-
- Detach source port number or range.
-
-.. option:: --destination-port <destination-port>
-
- Destination port number or range
- (integer in [1, 65535] or range like 123:456).
-
-.. option:: --no-destination-port
-
- Detach destination port number or range.
-
-.. option:: --source-ip-address <source-ip-address>
-
- Source IP address or subnet.
-
-.. option:: --no-source-ip-address
-
- Detach source IP address.
-
-.. option:: --destination-ip-address <destination-ip-address>
-
- Destination IP address or subnet.
-
-.. option:: --no-destination-ip-address
-
- Detach destination IP address.
-
-.. option:: --enable-rule
-
- Enable this rule (default is enabled).
-
-.. option:: --disable-rule
-
- Disable this rule.
-
-firewall group rule show
-------------------------
-
-Show information of a given firewall rule
-
-.. program:: firewall group rule show
-.. code:: bash
-
- openstack firewall group rule show
- <firewall-rule>
-
-.. _firewallrule_show-firewallrule:
-.. describe:: <firewall-rule>
-
- Firewall rule to display (name or ID).
-
-firewall group rule unset
--------------------------
-
-Unset firewall rule properties
-
-.. program:: firewall group rule unset
-.. code:: bash
-
- openstack firewall group rule unset
-
-.. _firewallrule_unset-firewallrule:
-.. describe:: <firewall-rule>
-
- Firewall rule to unset (name or ID).
-
-.. option:: --enable
-
- Disable firewall rule.
-
-.. option:: --public
-
- Restrict use of the firewall rule to the current project.
-
-.. option:: --source-port
-
- Detach source port number or range.
-
-.. option:: --destination-port
-
- Detach destination port number or range.
-
-.. option:: --source-ip-address
-
- Detach source IP address.
-
-.. option:: --destination-ip-address
-
- Detach destination IP address.
-
-.. option:: --enable-rule
-
- Disable this rule.
+.. autoprogram-cliff:: openstack.neutronclient.v2
+ :command: firewall group rule *
diff --git a/doc/source/cli/osc/v2/network-trunk.rst b/doc/source/cli/osc/v2/network-trunk.rst
index 06a63d2..22144a4 100644
--- a/doc/source/cli/osc/v2/network-trunk.rst
+++ b/doc/source/cli/osc/v2/network-trunk.rst
@@ -9,173 +9,8 @@ the server to connect to more networks.
Network v2
-network subport list
---------------------
+.. autoprogram-cliff:: openstack.neutronclient.v2
+ :command: network subport list
-List all subports for a given network trunk
-
-.. program:: network subport list
-.. code:: bash
-
- openstack network subport list
- --trunk <trunk>
-
-.. option:: --trunk <trunk>
-
- List subports belonging to this trunk (name or ID) (required)
-
-network trunk create
---------------------
-
-Create a network trunk for a given project
-
-.. program:: network trunk create
-.. code:: bash
-
- openstack network trunk create
- --parent-port <parent-port>
- [--subport <port=,segmentation-type=,segmentation-id=>]
- [--enable | --disable]
- [--project <project> [--project-domain <project-domain>]]
- [--description <description>]
- <name>
-
-.. option:: --parent-port <parent-port>
-
- Parent port belonging to this trunk (name or ID) (required)
-
-.. option:: --subport <port=,segmentation-type=,segmentation-id=>
-
- Subport to add. Subport is of form 'port=<name or ID>,segmentation-type=,segmentation-ID='
- (--subport) option can be repeated
-
-.. option:: --enable
-
- Enable trunk (default)
-
-.. option:: --disable
-
- Disable trunk
-
-.. 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.
-
-.. option:: --description <description>
-
- A description of the trunk.
-
-network trunk delete
---------------------
-
-Delete a given network trunk
-
-.. program:: network trunk delete
-.. code:: bash
-
- openstack network trunk delete
- <trunk> [<trunk> ...]
-
-.. _network_trunk_delete-trunk:
-.. describe:: <trunk>
-
- Trunk(s) to delete (name or ID)
-
-network trunk list
-------------------
-
-List all network trunks
-
-.. program:: network trunk list
-.. code:: bash
-
- openstack network trunk list
- [--long]
-
-.. option:: --long
-
- List additional fields in output
-
-network trunk set
------------------
-
-Set network trunk properties
-
-.. program:: network trunk set
-.. code:: bash
-
- openstack network trunk set
- [--name <name>]
- [--description <description>]
- [--subport <port=,segmentation-type=,segmentation-id=>]
- [--enable | --disable]
- <trunk>
-
-.. option:: --name <name>
-
- Set trunk name
-
-.. option:: --description <description>
-
- A description of the trunk.
-
-.. option:: --subport <port=,segmentation-type=,segmentation-id=>
-
- Subport to add. Subport is of form 'port=<name or ID>,segmentation-type=,segmentation-ID='
- (--subport) option can be repeated
-
-.. option:: --enable
-
- Enable trunk
-
-.. option:: --disable
-
- Disable trunk
-
-.. _network_trunk_set-trunk:
-.. describe:: <trunk>
-
- Trunk to modify (name or ID)
-
-network trunk show
-------------------
-
-Show information of a given network trunk
-
-.. program:: network trunk show
-.. code:: bash
-
- openstack network trunk show
- <trunk>
-
-.. _network_trunk_show-trunk:
-.. describe:: <trunk>
-
- Trunk to display (name or ID)
-
-network trunk unset
--------------------
-
-Unset subports from a given network trunk
-
-.. program:: network trunk unset
-.. code:: bash
-
- openstack network trunk unset
- --subport <subport>
- <trunk>
-
-.. option:: --subport <subport>
-
- Subport to delete (name or ID of the port) (required)
- (--subport) option can be repeated
-
-.. _network_trunk_unset-trunk:
-.. describe:: <trunk>
-
- Unset subports from this trunk (name or ID)
+.. autoprogram-cliff:: openstack.neutronclient.v2
+ :command: network trunk *
diff --git a/doc/source/cli/osc/v2/networking-bgpvpn.rst b/doc/source/cli/osc/v2/networking-bgpvpn.rst
index 69b3150..371e472 100644
--- a/doc/source/cli/osc/v2/networking-bgpvpn.rst
+++ b/doc/source/cli/osc/v2/networking-bgpvpn.rst
@@ -9,375 +9,26 @@ between L3VPNs and Neutron resources, i.e. Networks, Routers and Ports.
Network v2
-bgpvpn create
--------------
+.. autoprogram-cliff:: openstack.neutronclient.v2
+ :command: bgpvpn create
-Create a BGP VPN resource for a given project
+.. autoprogram-cliff:: openstack.neutronclient.v2
+ :command: bgpvpn delete
-.. program:: bgpvpn create
-.. code:: bash
+.. autoprogram-cliff:: openstack.neutronclient.v2
+ :command: bgpvpn list
- openstack bgpvpn create
+.. autoprogram-cliff:: openstack.neutronclient.v2
+ :command: bgpvpn set
-.. _bgpvpn_create-bgpvpn:
-.. option:: --project <project>
+.. autoprogram-cliff:: openstack.neutronclient.v2
+ :command: bgpvpn show
- Owner's project (name or ID)
+.. autoprogram-cliff:: openstack.neutronclient.v2
+ :command: bgpvpn unset
-.. option:: --project-domain <project-domain>
+.. autoprogram-cliff:: openstack.neutronclient.v2
+ :command: bgpvpn network association *
- Domain the project belongs to (name or ID). This can be used in case
- collisions between project names exist
-
-.. option:: --name <name>
-
- Name for the BGP VPN.
-
-.. option:: --route-target <route-target>
-
- Add Route Target to import list (repeat option for multiple Route Targets)
-
-.. option:: --import-target <import-target>
-
- Add Route Target to import list (repeat option for multiple Route Targets)
-
-.. option:: --export-target <export-target>
-
- Add Route Target to export list (repeat option for multiple RouteTargets)
-
-.. option:: --route-distinguisher <route-distinguisher>
-
- Add Route Distinguisher to the list of Route Distinguishers from which a
- Route Distinguishers will be picked from to advertise a VPN route (repeat
- option for multiple Route Distinguishers)
-
-.. option:: --type {l2,l3}
-
- BGP VPN type selection between IP VPN (l3) and Ethernet VPN (l2)
- (default: l3)
-
-bgpvpn set
-----------
-
-Set BGP VPN properties
-
-.. program:: bgpvpn set
-.. code:: bash
-
- openstack bgpvpn set
-
-.. _bgpvpn_set-bgpvpn:
-.. describe:: <bgpvpn>
-
- BGP VPN to update (name or ID)
-
-.. option:: --name <name>
-
- Name for the BGP VPN
-
-.. option:: --route-target <route-target>
-
- Add Route Target to import list (repeat option for multiple Route Targets)
-
-.. option:: --no-route-target
-
- Empty route target list.
-
-.. option:: --import-target <import-target>
-
- Add Route Target to import list (repeat option for multiple Route Targets)
-
-.. option:: --no-import-target
-
- Empty import route target list
-
-.. option:: --export-target <export-target>
-
- Add Route Target to export list (repeat option for multiple Route Targets)
-
-.. option:: --no-export-target
-
- Empty export route target list
-
-.. option:: --route-distinguisher <route-distinguisher>
-
- Add Route Distinguisher to the list of Route Distinguishers from which a
- Route Distinguishers will be picked from to advertise a VPN route (repeat
- option for multiple Route Distinguishers)
-
-.. option:: --no-route-distinguisher
-
- Empty route distinguisher list
-
-bgpvpn unset
-------------
-
-Unset BGP VPN properties
-
-.. program:: bgpvpn unset
-.. code:: bash
-
- openstack bgpvpn unset
-
-.. _bgpvpn_unset-bgpvpn:
-.. describe:: <bgpvpn>
-
- BGP VPN to update (name or ID)
-
-.. option:: --route-target <route-target>
-
- Remove Route Target from import/export list (repeat option for multiple
- Route Targets)
-
-.. option:: --all-route-target
-
- Empty route target list
-
-.. option:: --import-target <import-target>
-
- Remove Route Target from import list (repeat option for multiple Route
- Targets)
-
-.. option:: --all-import-target
-
- Empty import route target list
-
-.. option:: --export-target <export-target>
-
- Remove Route Target from export list (repeat option for multiple Route
- Targets)
-
-.. option:: --all-export-target
-
- Empty export route target list
-
-.. option:: --route-distinguisher <route-distinguisher>
-
- Remove Route Distinguisher from the list of Route Distinguishers from which
- a Route Distinguishers will be picked from to advertise a VPN route
- (repeat option for multiple Route Distinguishers)
-
-.. option:: --all-route-distinguisher
-
- Empty route distinguisher list
-
-bgpvpn delete
--------------
-
-Delete BGP VPN resource(s)
-
-.. program:: bgpvpn delete
-.. code:: bash
-
- openstack bgpvpn delete
- <bgpvpn> [<bgpvpn> ...]
-
-.. _bgpvpn_delete-bgpvpn:
-.. describe:: <bgpvpn>
- BGP VPN(s) to delete (name or ID)
-
-bgpvpn list
------------
-
-List BGP VPN resources
-
-.. program:: bgpvpn list
-.. code:: bash
-
- openstack bgpvpn list
-
-.. _bgpvpn_list-bgpvpn:
-.. 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.
-
-.. option:: --long
-
- List additional fields in output
-
-.. option:: --property <key=value>
-
- Filter property to apply on returned BGP VPNs (repeat to filter on multiple
- properties)
-
-bgpvpn show
------------
-
-Show information of a given BGP VPN
-
-.. program:: bgpvpn show
-.. code:: bash
-
- openstack bgpvpn show
-
-.. _bgpvpn_show-bgpvpn:
-.. describe:: <bgpvpn>
-
- BGP VPN to display (name or ID)
-
-bgpvpn network association create
----------------------------------
-
-Create a BGP VPN network association
-
-.. program:: bgpvpn network association create
-.. code:: bash
-
- openstack bgpvpn network association create
-
-.. _bgpvpn_net-assoc_create-bgpvpn:
-.. describe:: <bgpvpn>
-
- ID or name of the BGP VPN
-
-.. describe:: <network>
-
- ID or name of the network
-
-.. 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.
-
-bgpvpn network association delete
----------------------------------
-
-Remove a BGP VPN network association(s) for a given BGP VPN
-
-.. program:: bgpvpn network association delete
-.. code:: bash
-
- openstack bgpvpn network association delete
- <network association>[<network association> ...] <bgpvpn>
-
-.. _bgpvpn_net-assoc_delete-bgpvpn:
-.. describe:: <network association>
- ID(s) of the network association(s) to remove
-
-.. describe:: <bgpvpn>
- ID or name of the BGP VPN
-
-bgpvpn network association list
--------------------------------
-
-List BGP VPN network associations for a given BGP VPN
-
-.. program:: bgpvpn network association list
-.. code:: bash
-
- openstack bgpvpn network association list
-
-.. _bgpvpn_net-assoc_list-bgpvpn:
-.. describe:: <bgpvpn>
- ID or name of the BGP VPN
-
-.. option:: --long
-
- List additional fields in output
-
-bgpvpn network association show
--------------------------------
-
-Show information of a given BGP VPN network association
-
-.. program:: bgpvpn network association show
-.. code:: bash
-
- openstack bgpvpn network association show
-
-.. _bgpvpn_net-assoc_show-bgpvpn:
-.. describe:: <network association>
- ID of the network association to look up
-
-.. describe:: <bgpvpn>
- BGP VPN the association belongs to (name or ID)
-
-bgpvpn router association create
---------------------------------
-
-Create a BGP VPN router association
-
-.. program:: bgpvpn router association create
-.. code:: bash
-
- openstack bgpvpn router association create
-
-.. _bgpvpn_router-assoc_create-bgpvpn:
-.. describe:: <bgpvpn>
-
- ID or name of the BGP VPN
-
-.. describe:: <router>
-
- ID or name of the router.
-
-.. 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.
-
-bgpvpn router association delete
---------------------------------
-
-Delete a BGP VPN router association(s) for a given BGP VPN
-
-.. program:: bgpvpn router association delete
-.. code:: bash
-
- openstack bgpvpn router association delete
- <router association>[<router association> ...] <bgpvpn>
-
-.. _bgpvpn_router-assoc_delete-bgpvpn:
-.. describe:: <router association>
- ID(s) of the router association(s) to delete.
-
-.. describe:: <bgpvpn>
- ID or name of the BGP VPN
-
-bgpvpn router association list
-------------------------------
-
-List BGP VPN router associations for a given BGP VPN
-
-.. program:: bgpvpn router association list
-.. code:: bash
-
- openstack bgpvpn router association list
-
-.. _bgpvpn_router-assoc_list-bgpvpn:
-.. describe:: <bgpvpn>
- ID or name of the BGP VPN
-
-.. option:: --long
-
- List additional fields in output
-
-bgpvpn router association show
-------------------------------
-
-Show information of a given BGP VPN router association
-
-.. program:: bgpvpn router association show
-.. code:: bash
-
- openstack bgpvpn router association show
-
-.. _bgpvpn_router-assoc_show-bgpvpn:
-.. describe:: <router association>
- ID of the router association to look up
-
-.. describe:: <bgpvpn>
- BGP VPN the association belongs to (name or ID)
+.. autoprogram-cliff:: openstack.neutronclient.v2
+ :command: bgpvpn router association *
diff --git a/doc/source/conf.py b/doc/source/conf.py
index 4043a82..1bcb1db 100644
--- a/doc/source/conf.py
+++ b/doc/source/conf.py
@@ -5,9 +5,14 @@
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
-extensions = ['sphinx.ext.autodoc',
- 'reno.sphinxext',
- 'openstackdocstheme',
+extensions = [
+ 'sphinx.ext.autodoc',
+ 'reno.sphinxext',
+ 'openstackdocstheme',
+ # 'cliff.sphinxext',
+ # TODO(amotoki): Switch to cliff.sphinxext once cliff bug is fixed.
+ # https://bugs.launchpad.net/python-cliff/+bug/1692018
+ 'neutronclient.cliff_sphinxext',
]
# openstackdocstheme options
@@ -46,3 +51,7 @@ html_theme = 'openstackdocs'
# Output file base name for HTML help builder.
htmlhelp_basename = 'neutronclientdoc'
+
+# -- Options for cliff.sphinxext plugin ---------------------------------------
+
+autoprogram_cliff_application = 'openstack'