1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2024-09-14 20:13:21 +02:00

Make use of named links in documentation notes (#37027)

* Make use of named links in documentation notes

Now that it is possible to name external links, we are making use of
this to make the documentation better.

* Add improvements to ACI documentation

* Disable QA for long line

* Add :menuselection: and :guilabel:

* Improve links on some modules
This commit is contained in:
Dag Wieers 2018-03-06 00:05:13 +01:00 committed by GitHub
parent c8ef07e015
commit cb79957b5f
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
54 changed files with 147 additions and 116 deletions

View file

@ -51,7 +51,7 @@ Using the ACI modules
--------------------- ---------------------
The Ansible ACI modules provide a user-friendly interface to managing your ACI environment using Ansible playbooks. The Ansible ACI modules provide a user-friendly interface to managing your ACI environment using Ansible playbooks.
For instance ensuring that a specific tenant exists, is done using the following Ansible task: For instance ensuring that a specific tenant exists, is done using the following Ansible task using module `aci_tenant <aci_tenant>`:
.. code-block:: yaml .. code-block:: yaml
@ -67,6 +67,37 @@ For instance ensuring that a specific tenant exists, is done using the following
A complete list of existing ACI modules is available for `the latest stable release <http://docs.ansible.com/ansible/latest/modules/list_of_network_modules.html#aci>`_ as well as `the current development version <http://docs.ansible.com/ansible/devel/modules/list_of_network_modules.html#aci>`_. A complete list of existing ACI modules is available for `the latest stable release <http://docs.ansible.com/ansible/latest/modules/list_of_network_modules.html#aci>`_ as well as `the current development version <http://docs.ansible.com/ansible/devel/modules/list_of_network_modules.html#aci>`_.
Querying ACI configuration
..........................
A module can also be used to query a specific object.
.. code-block:: yaml
- name: Query tenant customer-xyz
aci_tenant:
host: my-apic-1
username: admin
password: my-password
tenant: customer-xyz
state: query
Or query all objects.
.. code-block:: yaml
- name: Query all tenants
aci_tenant:
host: my-apic-1
username: admin
password: my-password
state: query
register: all_tenants
After registering the return values of the `aci_tenant <aci_tenant>` task as shown above, you can access all tenant information from variable ``all_tenants``.
Common parameters Common parameters
................. .................
@ -125,7 +156,7 @@ Return values
The following values are always returned: The following values are always returned:
current current
The resulting state of the managed object. The resulting state of the managed object, or results of your query.
The following values are returned when ``output_level: info``: The following values are returned when ``output_level: info``:
@ -173,7 +204,7 @@ ACI authentication
Password-based authentication Password-based authentication
............................. .............................
If you want to logon using a username and password, you can use the following parameters with your ACI modules: If you want to log on using a username and password, you can use the following parameters with your ACI modules:
.. code-block:: yaml .. code-block:: yaml
@ -208,16 +239,16 @@ Configure your local user
,,,,,,,,,,,,,,,,,,,,,,,,, ,,,,,,,,,,,,,,,,,,,,,,,,,
Perform the following steps: Perform the following steps:
- Add the X.509 certificate to your ACI AAA local user at **ADMIN > AAA** - Add the X.509 certificate to your ACI AAA local user at :guilabel:`ADMIN` » :guilabel:`AAA`
- Click **AAA Authentication** - Click :guilabel:`AAA Authentication`
- Check that in the **Authentication** field the **Realm** field displays **Local** - Check that in the :guilabel:`Authentication` field the :guilabel:`Realm` field displays :guilabel:`Local`
- Expand **Security Management > Local Users** - Expand :guilabel:`Security Management` » :guilabel:`Local Users`
- Click the name of the user you want to add a certificate to, in the **User Certificates** area - Click the name of the user you want to add a certificate to, in the :guilabel:`User Certificates` area
- Click the **+** sign and in the **Create X509 Certificate** enter a certificate name in the **Name** field - Click the :guilabel:`+` sign and in the :guilabel:`Create X509 Certificate` enter a certificate name in the :guilabel:`Name` field
* If you use the basename of your private key here, you don't need to enter ``certificate_name`` in Ansible * If you use the basename of your private key here, you don't need to enter ``certificate_name`` in Ansible
- Copy and paste your X.509 certificate in the **Data** field. - Copy and paste your X.509 certificate in the :guilabel:`Data` field.
You can automate this by using the following Ansible task: You can automate this by using the following Ansible task:

View file

@ -23,8 +23,8 @@ notes:
appears to be an inconsistency wrt. the idempotent nature appears to be an inconsistency wrt. the idempotent nature
of the APIC REST API. The vendor has been informed. of the APIC REST API. The vendor has been informed.
More information in :ref:`the ACI documentation <aci_guide_known_issues>`. More information in :ref:`the ACI documentation <aci_guide_known_issues>`.
- More information about the internal APIC class B(aaa:User) at - More information about the internal APIC class B(aaa:User) from
U(https://developer.cisco.com/docs/apic-mim-ref/). L(the APIC Management Information Model reference,https://developer.cisco.com/docs/apic-mim-ref/).
author: author:
- Dag Wieers (@dagwieers) - Dag Wieers (@dagwieers)
requirements: requirements:

View file

@ -20,8 +20,8 @@ description:
notes: notes:
- The C(aaa_user) must exist before using this module in your playbook. - The C(aaa_user) must exist before using this module in your playbook.
The M(aci_aaa_user) module can be used for this. The M(aci_aaa_user) module can be used for this.
- More information about the internal APIC class B(aaa:UserCert) at - More information about the internal APIC class B(aaa:UserCert) from
U(https://developer.cisco.com/docs/apic-mim-ref/). L(the APIC Management Information Model reference,https://developer.cisco.com/docs/apic-mim-ref/).
author: author:
- Dag Wieers (@dagwieers) - Dag Wieers (@dagwieers)
version_added: '2.5' version_added: '2.5'

View file

@ -18,8 +18,8 @@ short_description: Manage Fabric interface policy leaf profile interface selecto
description: description:
- Manage Fabric interface policy leaf profile interface selectors on Cisco ACI fabrics. - Manage Fabric interface policy leaf profile interface selectors on Cisco ACI fabrics.
notes: notes:
- More information about the internal APIC classes B(infra:HPortS), B(infra:RsAccBaseGrp) and B(infra:PortBlk) at - More information about the internal APIC classes B(infra:HPortS), B(infra:RsAccBaseGrp) and B(infra:PortBlk) from
U(https://developer.cisco.com/media/mim-ref). L(the APIC Management Information Model reference,https://developer.cisco.com/docs/apic-mim-ref/)
author: author:
- Bruno Calogero (@brunocalogero) - Bruno Calogero (@brunocalogero)
version_added: '2.5' version_added: '2.5'

View file

@ -18,8 +18,8 @@ description:
- Connect to external virtual and physical domains by using - Connect to external virtual and physical domains by using
attachable Access Entity Profiles (AEP) on Cisco ACI fabrics. attachable Access Entity Profiles (AEP) on Cisco ACI fabrics.
notes: notes:
- More information about the internal APIC classes B(infra:AttEntityP) and B(infra:ProvAcc) at - More information about the internal APIC classes B(infra:AttEntityP) and B(infra:ProvAcc) from
U(https://developer.cisco.com/docs/apic-mim-ref/). L(the APIC Management Information Model reference,https://developer.cisco.com/docs/apic-mim-ref/).
author: author:
- Swetha Chunduri (@schunduri) - Swetha Chunduri (@schunduri)
version_added: '2.4' version_added: '2.4'

View file

@ -20,8 +20,8 @@ description:
notes: notes:
- The C(aep) and C(domain) parameters should exist before using this module. - The C(aep) and C(domain) parameters should exist before using this module.
The M(aci_aep) and M(aci_domain) can be used for these. The M(aci_aep) and M(aci_domain) can be used for these.
- More information about the internal APIC class B(infra:RsDomP) at - More information about the internal APIC class B(infra:RsDomP) from
U(https://developer.cisco.com/docs/apic-mim-ref/). L(the APIC Management Information Model reference,https://developer.cisco.com/docs/apic-mim-ref/).
author: author:
- Dag Wieers (@dagwieers) - Dag Wieers (@dagwieers)
version_added: '2.5' version_added: '2.5'

View file

@ -20,8 +20,8 @@ notes:
- This module does not manage EPGs, see M(aci_epg) to do this. - This module does not manage EPGs, see M(aci_epg) to do this.
- The C(tenant) used must exist before using this module in your playbook. - The C(tenant) used must exist before using this module in your playbook.
The M(aci_tenant) module can be used for this. The M(aci_tenant) module can be used for this.
- More information about the internal APIC class B(fv:Ap) at - More information about the internal APIC class B(fv:Ap) from
U(https://developer.cisco.com/docs/apic-mim-ref/). L(the APIC Management Information Model reference,https://developer.cisco.com/docs/apic-mim-ref/).
author: author:
- Swetha Chunduri (@schunduri) - Swetha Chunduri (@schunduri)
version_added: '2.4' version_added: '2.4'

View file

@ -19,8 +19,8 @@ description:
notes: notes:
- The C(tenant) used must exist before using this module in your playbook. - The C(tenant) used must exist before using this module in your playbook.
The M(aci_tenant) module can be used for this. The M(aci_tenant) module can be used for this.
- More information about the internal APIC class B(fv:BD) at - More information about the internal APIC class B(fv:BD) from
U(https://developer.cisco.com/docs/apic-mim-ref/). L(the APIC Management Information Model reference,https://developer.cisco.com/docs/apic-mim-ref/).
author: author:
- Jacob McGill (@jmcgill298) - Jacob McGill (@jmcgill298)
version_added: '2.4' version_added: '2.4'

View file

@ -21,8 +21,8 @@ notes:
is required when the state is C(absent) or C(present). is required when the state is C(absent) or C(present).
- The C(tenant) and C(bd) used must exist before using this module in your playbook. - The C(tenant) and C(bd) used must exist before using this module in your playbook.
The M(aci_tenant) module and M(aci_bd) can be used for these. The M(aci_tenant) module and M(aci_bd) can be used for these.
- More information about the internal APIC class B(fv:Subnet) at - More information about the internal APIC class B(fv:Subnet) from
U(https://developer.cisco.com/docs/apic-mim-ref/). L(the APIC Management Information Model reference,https://developer.cisco.com/docs/apic-mim-ref/).
author: author:
- Jacob McGill (@jmcgill298) - Jacob McGill (@jmcgill298)
version_added: '2.4' version_added: '2.4'

View file

@ -19,8 +19,8 @@ description:
notes: notes:
- The C(bd) and C(l3out) parameters should exist before using this module. - The C(bd) and C(l3out) parameters should exist before using this module.
The M(aci_bd) and M(aci_l3out) can be used for these. The M(aci_bd) and M(aci_l3out) can be used for these.
- More information about the internal APIC class B(fv:RsBDToOut) at - More information about the internal APIC class B(fv:RsBDToOut) from
U(https://developer.cisco.com/docs/apic-mim-ref/). L(the APIC Management Information Model reference,https://developer.cisco.com/docs/apic-mim-ref/).
author: author:
- Jacob McGill (@jmcgill298) - Jacob McGill (@jmcgill298)
version_added: '2.4' version_added: '2.4'

View file

@ -18,8 +18,8 @@ description:
- Provides rollback and rollback preview functionality for Cisco ACI fabrics. - Provides rollback and rollback preview functionality for Cisco ACI fabrics.
- Config Rollbacks are done using snapshots C(aci_snapshot) with the configImportP class. - Config Rollbacks are done using snapshots C(aci_snapshot) with the configImportP class.
notes: notes:
- More information about the internal APIC class B(config:ImportP) at - More information about the internal APIC class B(config:ImportP) from
U(https://developer.cisco.com/docs/apic-mim-ref/). L(the APIC Management Information Model reference,https://developer.cisco.com/docs/apic-mim-ref/).
author: author:
- Jacob McGill (@jmcgill298) - Jacob McGill (@jmcgill298)
version_added: '2.4' version_added: '2.4'

View file

@ -22,8 +22,8 @@ notes:
- The APIC does not provide a mechanism for naming the snapshots. - The APIC does not provide a mechanism for naming the snapshots.
- 'Snapshot files use the following naming structure: ce_<config export policy name>-<yyyy>-<mm>-<dd>T<hh>:<mm>:<ss>.<mss>+<hh>:<mm>.' - 'Snapshot files use the following naming structure: ce_<config export policy name>-<yyyy>-<mm>-<dd>T<hh>:<mm>:<ss>.<mss>+<hh>:<mm>.'
- 'Snapshot objects use the following naming structure: run-<yyyy>-<mm>-<dd>T<hh>-<mm>-<ss>.' - 'Snapshot objects use the following naming structure: run-<yyyy>-<mm>-<dd>T<hh>-<mm>-<ss>.'
- More information about the internal APIC classes B(config:Snapshot) and B(config:ExportP) at - More information about the internal APIC classes B(config:Snapshot) and B(config:ExportP) from
U(https://developer.cisco.com/docs/apic-mim-ref/). L(the APIC Management Information Model reference,https://developer.cisco.com/docs/apic-mim-ref/).
author: author:
- Jacob McGill (@jmcgill298) - Jacob McGill (@jmcgill298)
version_added: '2.4' version_added: '2.4'

View file

@ -21,8 +21,8 @@ notes:
Contract Subjects can still be removed using this module. Contract Subjects can still be removed using this module.
- The C(tenant) used must exist before using this module in your playbook. - The C(tenant) used must exist before using this module in your playbook.
The M(aci_tenant) module can be used for this. The M(aci_tenant) module can be used for this.
- More information about the internal APIC class B(vz:BrCP) at - More information about the internal APIC class B(vz:BrCP) from
U(https://developer.cisco.com/docs/apic-mim-ref/). L(the APIC Management Information Model reference,https://developer.cisco.com/docs/apic-mim-ref/).
author: author:
- Dag Wieers (@dagwieers) - Dag Wieers (@dagwieers)
version_added: '2.4' version_added: '2.4'

View file

@ -19,8 +19,8 @@ description:
notes: notes:
- The C(tenant) and C(contract) used must exist before using this module in your playbook. - The C(tenant) and C(contract) used must exist before using this module in your playbook.
- The M(aci_tenant) and M(aci_contract) modules can be used for this. - The M(aci_tenant) and M(aci_contract) modules can be used for this.
- More information about the internal APIC class B(vz:Subj) at - More information about the internal APIC class B(vz:Subj) from
U(https://developer.cisco.com/docs/apic-mim-ref/). L(the APIC Management Information Model reference,https://developer.cisco.com/docs/apic-mim-ref/).
author: author:
- Swetha Chunduri (@schunduri) - Swetha Chunduri (@schunduri)
version_added: '2.4' version_added: '2.4'

View file

@ -19,8 +19,8 @@ description:
notes: notes:
- The C(tenant), C(contract), C(subject), and C(filter_name) must exist before using this module in your playbook. - The C(tenant), C(contract), C(subject), and C(filter_name) must exist before using this module in your playbook.
- The M(aci_tenant), M(aci_contract), M(aci_contract_subject), and M(aci_filter) modules can be used for these. - The M(aci_tenant), M(aci_contract), M(aci_contract_subject), and M(aci_filter) modules can be used for these.
- More information about the internal APIC class B(vz:RsSubjFiltAtt) at - More information about the internal APIC class B(vz:RsSubjFiltAtt) from
U(https://developer.cisco.com/docs/apic-mim-ref/). L(the APIC Management Information Model reference,https://developer.cisco.com/docs/apic-mim-ref/).
author: author:
- Jacob McGill (@jmcgill298) - Jacob McGill (@jmcgill298)
version_added: '2.4' version_added: '2.4'

View file

@ -18,8 +18,8 @@ description:
- Manage physical, virtual, bridged, routed or FC domain profiles on Cisco ACI fabrics. - Manage physical, virtual, bridged, routed or FC domain profiles on Cisco ACI fabrics.
notes: notes:
- More information about the internal APIC classes B(phys:DomP), - More information about the internal APIC classes B(phys:DomP),
B(vmm:DomP), B(l2ext:DomP), B(l3ext:DomP) and B(fc:DomP) at B(vmm:DomP), B(l2ext:DomP), B(l3ext:DomP) and B(fc:DomP) from
U(https://developer.cisco.com/docs/apic-mim-ref/). L(the APIC Management Information Model reference,https://developer.cisco.com/docs/apic-mim-ref/).
author: author:
- Dag Wieers (@dagwieers) - Dag Wieers (@dagwieers)
version_added: '2.5' version_added: '2.5'

View file

@ -20,8 +20,8 @@ description:
notes: notes:
- The C(domain) and C(encap_pool) parameters should exist before using this module. - The C(domain) and C(encap_pool) parameters should exist before using this module.
The M(aci_domain) and M(aci_encap_pool) can be used for these. The M(aci_domain) and M(aci_encap_pool) can be used for these.
- More information about the internal APIC class B(infra:RsVlanNs) at - More information about the internal APIC class B(infra:RsVlanNs) from
U(https://developer.cisco.com/docs/apic-mim-ref/). L(the APIC Management Information Model reference,https://developer.cisco.com/docs/apic-mim-ref/).
author: author:
- Dag Wieers (@dagwieers) - Dag Wieers (@dagwieers)
version_added: '2.5' version_added: '2.5'

View file

@ -20,8 +20,8 @@ description:
notes: notes:
- The C(domain) and C(vlan_pool) parameters should exist before using this module. - The C(domain) and C(vlan_pool) parameters should exist before using this module.
The M(aci_domain) and M(aci_vlan_pool) can be used for these. The M(aci_domain) and M(aci_vlan_pool) can be used for these.
- More information about the internal APIC class B(infra:RsVlanNs) at - More information about the internal APIC class B(infra:RsVlanNs) from
U(https://developer.cisco.com/docs/apic-mim-ref/). L(the APIC Management Information Model reference,https://developer.cisco.com/docs/apic-mim-ref/).
author: author:
- Dag Wieers (@dagwieers) - Dag Wieers (@dagwieers)
version_added: '2.5' version_added: '2.5'

View file

@ -17,8 +17,8 @@ short_description: Manage encap pools (fvns:VlanInstP, fvns:VxlanInstP, fvns:Vsa
description: description:
- Manage vlan, vxlan, and vsan pools on Cisco ACI fabrics. - Manage vlan, vxlan, and vsan pools on Cisco ACI fabrics.
notes: notes:
- More information about the internal APIC classes B(fvns:VlanInstP), B(fvns:VxlanInstP) and B(fvns:VsanInstP) at - More information about the internal APIC classes B(fvns:VlanInstP), B(fvns:VxlanInstP) and B(fvns:VsanInstP) from
U(https://developer.cisco.com/docs/apic-mim-ref/). L(the APIC Management Information Model reference,https://developer.cisco.com/docs/apic-mim-ref/).
author: author:
- Jacob McGill (@jmcgill298) - Jacob McGill (@jmcgill298)
version_added: '2.5' version_added: '2.5'

View file

@ -18,8 +18,8 @@ description:
- Manage vlan, vxlan, and vsan ranges that are assigned to pools on Cisco ACI fabrics. - Manage vlan, vxlan, and vsan ranges that are assigned to pools on Cisco ACI fabrics.
notes: notes:
- The C(pool) must exist in order to add or delete a range. - The C(pool) must exist in order to add or delete a range.
- More information about the internal APIC classes B(fvns:EncapBlk) and B(fvns:VsanEncapBlk) at - More information about the internal APIC classes B(fvns:EncapBlk) and B(fvns:VsanEncapBlk) from
U(https://developer.cisco.com/docs/apic-mim-ref/). L(the APIC Management Information Model reference,https://developer.cisco.com/docs/apic-mim-ref/).
author: author:
- Jacob McGill (@jmcgill298) - Jacob McGill (@jmcgill298)
version_added: '2.5' version_added: '2.5'

View file

@ -19,8 +19,8 @@ description:
notes: notes:
- The C(tenant) and C(app_profile) used must exist before using this module in your playbook. - The C(tenant) and C(app_profile) used must exist before using this module in your playbook.
The M(aci_tenant) and M(aci_ap) modules can be used for this. The M(aci_tenant) and M(aci_ap) modules can be used for this.
- More information about the internal APIC class B(fv:AEPg) at - More information about the internal APIC class B(fv:AEPg) from
U(https://developer.cisco.com/docs/apic-mim-ref/). L(the APIC Management Information Model reference,https://developer.cisco.com/docs/apic-mim-ref/).
author: author:
- Swetha Chunduri (@schunduri) - Swetha Chunduri (@schunduri)
version_added: '2.4' version_added: '2.4'

View file

@ -19,8 +19,8 @@ description:
notes: notes:
- The C(tenant) used must exist before using this module in your playbook. - The C(tenant) used must exist before using this module in your playbook.
The M(aci_tenant) module can be used for this. The M(aci_tenant) module can be used for this.
- More information about the internal APIC class B(mon:EPGPol) at - More information about the internal APIC class B(mon:EPGPol) from
U(https://developer.cisco.com/docs/apic-mim-ref/). L(the APIC Management Information Model reference,https://developer.cisco.com/docs/apic-mim-ref/).
author: author:
- Dag Wieers (@dagwieers) - Dag Wieers (@dagwieers)
version_added: '2.4' version_added: '2.4'

View file

@ -19,8 +19,8 @@ description:
notes: notes:
- The C(tenant), C(app_profile), C(EPG), and C(Contract) used must exist before using this module in your playbook. - The C(tenant), C(app_profile), C(EPG), and C(Contract) used must exist before using this module in your playbook.
The M(aci_tenant), M(aci_ap), M(aci_epg), and M(aci_contract) modules can be used for this. The M(aci_tenant), M(aci_ap), M(aci_epg), and M(aci_contract) modules can be used for this.
- More information about the internal APIC classes B(fv:RsCons) and B(fv:RsProv) at - More information about the internal APIC classes B(fv:RsCons) and B(fv:RsProv) from
U(https://developer.cisco.com/docs/apic-mim-ref/). L(the APIC Management Information Model reference,https://developer.cisco.com/docs/apic-mim-ref/).
author: author:
- Jacob McGill (@jmcgill298) - Jacob McGill (@jmcgill298)
version_added: '2.4' version_added: '2.4'

View file

@ -22,8 +22,8 @@ notes:
- OpenStack VMM domains must not be created using this module. The OpenStack VMM domain is created directly - OpenStack VMM domains must not be created using this module. The OpenStack VMM domain is created directly
by the Cisco APIC Neutron plugin as part of the installation and configuration. by the Cisco APIC Neutron plugin as part of the installation and configuration.
This module can be used to query status of an OpenStack VMM domain. This module can be used to query status of an OpenStack VMM domain.
- More information about the internal APIC class B(fv:RsDomAtt) at - More information about the internal APIC class B(fv:RsDomAtt) from
U(https://developer.cisco.com/docs/apic-mim-ref/). L(the APIC Management Information Model reference,https://developer.cisco.com/docs/apic-mim-ref/).
author: author:
- Jacob McGill (@jmcgill298) - Jacob McGill (@jmcgill298)
version_added: '2.4' version_added: '2.4'

View file

@ -18,8 +18,8 @@ short_description: Manage Fabric Node Members (fabric:NodeIdentP)
description: description:
- Manage Fabric Node Members on Cisco ACI fabrics. - Manage Fabric Node Members on Cisco ACI fabrics.
notes: notes:
- More information about the internal APIC class B(fabric:NodeIdentP) at - More information about the internal APIC class B(fabric:NodeIdentP) from
U(https://developer.cisco.com/site/aci/docs/apis/apic-mim-ref/). L(the APIC Management Information Model reference,https://developer.cisco.com/docs/apic-mim-ref/).
author: author:
- Bruno Calogero (@brunocalogero) - Bruno Calogero (@brunocalogero)
version_added: '2.5' version_added: '2.5'

View file

@ -20,8 +20,8 @@ description:
notes: notes:
- The C(tenant) used must exist before using this module in your playbook. - The C(tenant) used must exist before using this module in your playbook.
The M(aci_tenant) module can be used for this. The M(aci_tenant) module can be used for this.
- More information about the internal APIC class B(vz:Filter) at - More information about the internal APIC class B(vz:Filter) from
U(https://developer.cisco.com/docs/apic-mim-ref/). L(the APIC Management Information Model reference,https://developer.cisco.com/docs/apic-mim-ref/).
author: author:
- Dag Wieers (@dagwieers) - Dag Wieers (@dagwieers)
version_added: '2.4' version_added: '2.4'

View file

@ -19,8 +19,8 @@ description:
notes: notes:
- The C(tenant) and C(filter) used must exist before using this module in your playbook. - The C(tenant) and C(filter) used must exist before using this module in your playbook.
The M(aci_tenant) and M(aci_filter) modules can be used for this. The M(aci_tenant) and M(aci_filter) modules can be used for this.
- More information about the internal APIC class B(vz:Entry) at - More information about the internal APIC class B(vz:Entry) from
U(https://developer.cisco.com/docs/apic-mim-ref/). L(the APIC Management Information Model reference,https://developer.cisco.com/docs/apic-mim-ref/).
author: author:
- Jacob McGill (@jmcgill298) - Jacob McGill (@jmcgill298)
version_added: '2.4' version_added: '2.4'

View file

@ -21,8 +21,8 @@ author:
- Dag Wieers (@dagwieers) - Dag Wieers (@dagwieers)
version_added: '2.5' version_added: '2.5'
notes: notes:
- More information about the internal APIC class B(firmware:OSource) at - More information about the internal APIC class B(firmware:OSource) from
U(https://developer.cisco.com/docs/apic-mim-ref/). L(the APIC Management Information Model reference,https://developer.cisco.com/docs/apic-mim-ref/).
options: options:
source: source:
description: description:

View file

@ -20,8 +20,8 @@ author:
- Dag Wieers (@dagwieers) - Dag Wieers (@dagwieers)
version_added: '2.4' version_added: '2.4'
notes: notes:
- More information about the internal APIC class B(fc:IfPol) at - More information about the internal APIC class B(fc:IfPol) from
U(https://developer.cisco.com/docs/apic-mim-ref/). L(the APIC Management Information Model reference,https://developer.cisco.com/docs/apic-mim-ref/).
options: options:
fc_policy: fc_policy:
description: description:

View file

@ -20,8 +20,8 @@ author:
- Dag Wieers (@dagwieers) - Dag Wieers (@dagwieers)
version_added: '2.4' version_added: '2.4'
notes: notes:
- More information about the internal APIC class B(l2:IfPol) at - More information about the internal APIC class B(l2:IfPol) from
U(https://developer.cisco.com/docs/apic-mim-ref/). L(the APIC Management Information Model reference,https://developer.cisco.com/docs/apic-mim-ref/).
options: options:
l2_policy: l2_policy:
description: description:

View file

@ -20,8 +20,8 @@ description:
notes: notes:
- When using the module please select the appropriate link_aggregation_type (lag_type). - When using the module please select the appropriate link_aggregation_type (lag_type).
C(link) for Port Channel(PC), C(node) for Virtual Port Channel(VPC) and C(leaf) for Leaf Access Port Policy Group. C(link) for Port Channel(PC), C(node) for Virtual Port Channel(VPC) and C(leaf) for Leaf Access Port Policy Group.
- More information about the internal APIC classes B(infra:AccBndlGrp) and B(infra:AccPortGrp) at - More information about the internal APIC classes B(infra:AccBndlGrp) and B(infra:AccPortGrp) from
U(https://developer.cisco.com/site/aci/docs/apis/apic-mim-ref/). L(the APIC Management Information Model reference,https://developer.cisco.com/docs/apic-mim-ref/).
author: author:
- Bruno Calogero (@brunocalogero) - Bruno Calogero (@brunocalogero)
version_added: '2.5' version_added: '2.5'

View file

@ -18,8 +18,8 @@ short_description: Manage fabric interface policy leaf profiles (infra:AccPortP)
description: description:
- Manage fabric interface policy leaf profiles on Cisco ACI fabrics. - Manage fabric interface policy leaf profiles on Cisco ACI fabrics.
notes: notes:
- More information about the internal APIC class B(infra:AccPortP) at - More information about the internal APIC class B(infra:AccPortP) from
U(https://developer.cisco.com/docs/apic-mim-ref/). L(the APIC Management Information Model reference,https://developer.cisco.com/docs/apic-mim-ref/).
author: author:
- Bruno Calogero (@brunocalogero) - Bruno Calogero (@brunocalogero)
version_added: '2.5' version_added: '2.5'

View file

@ -17,8 +17,8 @@ short_description: Manage LLDP interface policies (lldp:IfPol)
description: description:
- Manage LLDP interface policies on Cisco ACI fabrics. - Manage LLDP interface policies on Cisco ACI fabrics.
notes: notes:
- More information about the internal APIC class B(lldp:IfPol) at - More information about the internal APIC class B(lldp:IfPol) from
U(https://developer.cisco.com/docs/apic-mim-ref/). L(the APIC Management Information Model reference,https://developer.cisco.com/docs/apic-mim-ref/).
author: author:
- Dag Wieers (@dagwieers) - Dag Wieers (@dagwieers)
version_added: '2.4' version_added: '2.4'

View file

@ -17,8 +17,8 @@ short_description: Manage MCP interface policies (mcp:IfPol)
description: description:
- Manage MCP interface policies on Cisco ACI fabrics. - Manage MCP interface policies on Cisco ACI fabrics.
notes: notes:
- More information about the internal APIC class B(mcp:IfPol) at - More information about the internal APIC class B(mcp:IfPol) from
U(https://developer.cisco.com/docs/apic-mim-ref/). L(the APIC Management Information Model reference,https://developer.cisco.com/docs/apic-mim-ref/).
author: author:
- Dag Wieers (@dagwieers) - Dag Wieers (@dagwieers)
version_added: '2.4' version_added: '2.4'

View file

@ -17,8 +17,8 @@ short_description: Manage port channel interface policies (lacp:LagPol)
description: description:
- Manage port channel interface policies on Cisco ACI fabrics. - Manage port channel interface policies on Cisco ACI fabrics.
notes: notes:
- More information about the internal APIC class B(lacp:LagPol) at - More information about the internal APIC class B(lacp:LagPol) from
U(https://developer.cisco.com/docs/apic-mim-ref/). L(the APIC Management Information Model reference,https://developer.cisco.com/docs/apic-mim-ref/).
author: author:
- Dag Wieers (@dagwieers) - Dag Wieers (@dagwieers)
version_added: '2.4' version_added: '2.4'

View file

@ -17,8 +17,8 @@ short_description: Manage port security (l2:PortSecurityPol)
description: description:
- Manage port security on Cisco ACI fabrics. - Manage port security on Cisco ACI fabrics.
notes: notes:
- More information about the internal APIC class B(l2:PortSecurityPol) at - More information about the internal APIC class B(l2:PortSecurityPol) from
U(https://developer.cisco.com/docs/apic-mim-ref/). L(the APIC Management Information Model reference,https://developer.cisco.com/docs/apic-mim-ref/).
author: author:
- Dag Wieers (@dagwieers) - Dag Wieers (@dagwieers)
version_added: '2.4' version_added: '2.4'

View file

@ -19,8 +19,8 @@ description:
- Bind interface selector profiles to switch policy leaf profiles on Cisco ACI fabrics. - Bind interface selector profiles to switch policy leaf profiles on Cisco ACI fabrics.
notes: notes:
- This module requires an existing leaf profile, the module M(aci_switch_policy_leaf_profile) can be used for this. - This module requires an existing leaf profile, the module M(aci_switch_policy_leaf_profile) can be used for this.
- More information about the internal APIC class B(infra:RsAccPortP) at - More information about the internal APIC class B(infra:RsAccPortP) from
U(https://developer.cisco.com/docs/apic-mim-ref/). L(the APIC Management Information Model reference,https://developer.cisco.com/docs/apic-mim-ref/).
author: author:
- Bruno Calogero (@brunocalogero) - Bruno Calogero (@brunocalogero)
version_added: '2.5' version_added: '2.5'

View file

@ -19,8 +19,8 @@ description:
notes: notes:
- The C(tenant) used must exist before using this module in your playbook. - The C(tenant) used must exist before using this module in your playbook.
The M(aci_tenant) module can be used for this. The M(aci_tenant) module can be used for this.
- More information about the internal APIC class B(l3ext:RouteTagPol) at - More information about the internal APIC class B(l3ext:RouteTagPol) from
U(https://developer.cisco.com/docs/apic-mim-ref/). L(the APIC Management Information Model reference,https://developer.cisco.com/docs/apic-mim-ref/).
author: author:
- Dag Wieers (@dagwieers) - Dag Wieers (@dagwieers)
version_added: '2.4' version_added: '2.4'

View file

@ -26,8 +26,8 @@ notes:
This is a known APIC problem and has been reported to the vendor. A workaround for this issue exists. This is a known APIC problem and has been reported to the vendor. A workaround for this issue exists.
More information in :ref:`the ACI documentation <aci_guide_known_issues>`. More information in :ref:`the ACI documentation <aci_guide_known_issues>`.
- XML payloads require the C(lxml) and C(xmljson) python libraries. For JSON payloads nothing special is needed. - XML payloads require the C(lxml) and C(xmljson) python libraries. For JSON payloads nothing special is needed.
- More information regarding the Cisco APIC REST API is available from - More information regarding the APIC REST API is available from
U(http://www.cisco.com/c/en/us/td/docs/switches/datacenter/aci/apic/sw/2-x/rest_cfg/2_1_x/b_Cisco_APIC_REST_API_Configuration_Guide.html). L(the Cisco APIC REST API Configuration Guide,http://www.cisco.com/c/en/us/td/docs/switches/datacenter/aci/apic/sw/2-x/rest_cfg/2_1_x/b_Cisco_APIC_REST_API_Configuration_Guide.html). # NOQA
author: author:
- Dag Wieers (@dagwieers) - Dag Wieers (@dagwieers)
version_added: '2.4' version_added: '2.4'

View file

@ -20,8 +20,8 @@ description:
notes: notes:
- The C(tenant), C(ap), C(epg) used must exist before using this module in your playbook. - The C(tenant), C(ap), C(epg) used must exist before using this module in your playbook.
The M(aci_tenant), M(aci_ap), M(aci_epg) modules can be used for this. The M(aci_tenant), M(aci_ap), M(aci_epg) modules can be used for this.
- More information about the internal APIC classes B(fv:RsPathAtt) at - More information about the internal APIC classes B(fv:RsPathAtt) from
U(https://developer.cisco.com/docs/apic-mim-ref/). L(the APIC Management Information Model reference,https://developer.cisco.com/docs/apic-mim-ref/).
author: author:
- Bruno Calogero (@brunocalogero) - Bruno Calogero (@brunocalogero)
version_added: '2.5' version_added: '2.5'

View file

@ -20,8 +20,8 @@ description:
notes: notes:
- This module is to be used with M(aci_switch_policy_leaf_profile) - This module is to be used with M(aci_switch_policy_leaf_profile)
One first creates a leaf profile (infra:NodeP) and then creates an associated selector (infra:LeafS), One first creates a leaf profile (infra:NodeP) and then creates an associated selector (infra:LeafS),
- More information about the internal APIC classes B(infra:LeafS), B(infra:NodeBlk) and B(infra:RsAccNodePGrp) at - More information about the internal APIC classes B(infra:LeafS), B(infra:NodeBlk) and B(infra:RsAccNodePGrp) from
U(https://developer.cisco.com/docs/apic-mim-ref/). L(the APIC Management Information Model reference,https://developer.cisco.com/docs/apic-mim-ref/).
author: author:
- Bruno Calogero (@brunocalogero) - Bruno Calogero (@brunocalogero)
version_added: '2.5' version_added: '2.5'

View file

@ -18,8 +18,8 @@ short_description: Manage switch policy leaf profiles (infra:NodeP)
description: description:
- Manage switch policy leaf profiles on Cisco ACI fabrics. - Manage switch policy leaf profiles on Cisco ACI fabrics.
notes: notes:
- More information about the internal APIC class B(infra:NodeP) at - More information about the internal APIC class B(infra:NodeP) from
U(https://developer.cisco.com/docs/apic-mim-ref/). L(the APIC Management Information Model reference,https://developer.cisco.com/docs/apic-mim-ref/).
author: author:
- Bruno Calogero (@brunocalogero) - Bruno Calogero (@brunocalogero)
version_added: '2.5' version_added: '2.5'

View file

@ -18,8 +18,8 @@ short_description: Manage switch policy explicit vPC protection groups (fabric:E
description: description:
- Manage switch policy explicit vPC protection groups on Cisco ACI fabrics. - Manage switch policy explicit vPC protection groups on Cisco ACI fabrics.
notes: notes:
- More information about the internal APIC classes B(fabric:ExplicitGEp) and B(fabric:NodePEp) at - More information about the internal APIC classes B(fabric:ExplicitGEp) and B(fabric:NodePEp) from
U(https://developer.cisco.com/site/aci/docs/apis/apic-mim-ref/). L(the APIC Management Information Model reference,https://developer.cisco.com/docs/apic-mim-ref/).
author: author:
- Bruno Calogero (@brunocalogero) - Bruno Calogero (@brunocalogero)
version_added: '2.5' version_added: '2.5'

View file

@ -20,8 +20,8 @@ description:
notes: notes:
- The C(tenant) used must exist before using this module in your playbook. - The C(tenant) used must exist before using this module in your playbook.
The M(aci_tenant) module can be used for this. The M(aci_tenant) module can be used for this.
- More information about the internal APIC class B(vz:BrCP) at - More information about the internal APIC class B(vz:BrCP) from
U(https://developer.cisco.com/docs/apic-mim-ref/). L(the APIC Management Information Model reference,https://developer.cisco.com/docs/apic-mim-ref/).
author: author:
- Dag Wieers (@dagwieers) - Dag Wieers (@dagwieers)
version_added: '2.4' version_added: '2.4'

View file

@ -17,8 +17,8 @@ short_description: Manage tenants (fv:Tenant)
description: description:
- Manage tenants on Cisco ACI fabrics. - Manage tenants on Cisco ACI fabrics.
notes: notes:
- More information about the internal APIC class B(fv:Tenant) at - More information about the internal APIC class B(fv:Tenant) from
U(https://developer.cisco.com/docs/apic-mim-ref/). L(the APIC Management Information Model reference,https://developer.cisco.com/docs/apic-mim-ref/).
author: author:
- Jacob McGill (@jmcgill298) - Jacob McGill (@jmcgill298)
version_added: '2.4' version_added: '2.4'

View file

@ -19,8 +19,8 @@ description:
notes: notes:
- The C(tenant) used must exist before using this module in your playbook. - The C(tenant) used must exist before using this module in your playbook.
The M(aci_tenant) module can be used for this. The M(aci_tenant) module can be used for this.
- More information about the internal APIC class B(rtctrl:AttrP) at - More information about the internal APIC class B(rtctrl:AttrP) from
U(https://developer.cisco.com/docs/apic-mim-ref/). L(the APIC Management Information Model reference,https://developer.cisco.com/docs/apic-mim-ref/).
author: author:
- Dag Wieers (@dagwieers) - Dag Wieers (@dagwieers)
version_added: '2.4' version_added: '2.4'

View file

@ -19,8 +19,8 @@ description:
notes: notes:
- The C(tenant) used must exist before using this module in your playbook. - The C(tenant) used must exist before using this module in your playbook.
The M(aci_tenant) module can be used for this. The M(aci_tenant) module can be used for this.
- More information about the internal APIC class B(fv:EpRetPol) at - More information about the internal APIC class B(fv:EpRetPol) from
U(https://developer.cisco.com/docs/apic-mim-ref/). L(the APIC Management Information Model reference,https://developer.cisco.com/docs/apic-mim-ref/).
author: author:
- Swetha Chunduri (@schunduri) - Swetha Chunduri (@schunduri)
version_added: '2.4' version_added: '2.4'

View file

@ -19,8 +19,8 @@ description:
notes: notes:
- The C(tenant) used must exist before using this module in your playbook. - The C(tenant) used must exist before using this module in your playbook.
The M(aci_tenant) module can be used for this. The M(aci_tenant) module can be used for this.
- More information about the internal APIC class B(span:DestGrp) at - More information about the internal APIC class B(span:DestGrp) from
U(https://developer.cisco.com/docs/apic-mim-ref/). L(the APIC Management Information Model reference,https://developer.cisco.com/docs/apic-mim-ref/).
author: author:
- Dag Wieers (@dagwieers) - Dag Wieers (@dagwieers)
version_added: '2.4' version_added: '2.4'

View file

@ -19,8 +19,8 @@ description:
notes: notes:
- The C(tenant) used must exist before using this module in your playbook. - The C(tenant) used must exist before using this module in your playbook.
The M(aci_tenant) module can be used for this. The M(aci_tenant) module can be used for this.
- More information about the internal APIC class B(span:SrcGrp) at - More information about the internal APIC class B(span:SrcGrp) from
U(https://developer.cisco.com/docs/apic-mim-ref/). L(the APIC Management Information Model reference,https://developer.cisco.com/docs/apic-mim-ref/).
author: author:
- Jacob McGill (@jmcgill298) - Jacob McGill (@jmcgill298)
version_added: '2.4' version_added: '2.4'

View file

@ -19,8 +19,8 @@ description:
notes: notes:
- The C(tenant), C(src_group), and C(dst_group) must exist before using this module in your playbook. - The C(tenant), C(src_group), and C(dst_group) must exist before using this module in your playbook.
The M(aci_tenant), M(aci_tenant_span_src_group), and M(aci_tenant_span_dst_group) modules can be used for this. The M(aci_tenant), M(aci_tenant_span_src_group), and M(aci_tenant_span_dst_group) modules can be used for this.
- More information about the internal APIC class B(span:SrcGrp) at - More information about the internal APIC class B(span:SrcGrp) from
U(https://developer.cisco.com/docs/apic-mim-ref/). L(the APIC Management Information Model reference,https://developer.cisco.com/docs/apic-mim-ref/).
author: author:
- Jacob McGill (@jmcgill298) - Jacob McGill (@jmcgill298)
version_added: '2.4' version_added: '2.4'

View file

@ -19,8 +19,8 @@ short_description: Manage VLAN pools (fvns:VlanInstP)
description: description:
- Manage VLAN pools on Cisco ACI fabrics. - Manage VLAN pools on Cisco ACI fabrics.
notes: notes:
- More information about the internal APIC class B(fvns:VlanInstP) at - More information about the internal APIC class B(fvns:VlanInstP) from
U(https://developer.cisco.com/docs/apic-mim-ref/). L(the APIC Management Information Model reference,https://developer.cisco.com/docs/apic-mim-ref/).
author: author:
- Jacob McGill (@jmcgill298) - Jacob McGill (@jmcgill298)
- Dag Wieers (@dagwieers) - Dag Wieers (@dagwieers)

View file

@ -20,8 +20,8 @@ description:
- Manage VLAN encap blocks that are assigned to VLAN pools on Cisco ACI fabrics. - Manage VLAN encap blocks that are assigned to VLAN pools on Cisco ACI fabrics.
notes: notes:
- The C(pool) must exist in order to add or delete a encap block. - The C(pool) must exist in order to add or delete a encap block.
- More information about the internal APIC class B(fvns:EncapBlk) at - More information about the internal APIC class B(fvns:EncapBlk) from
U(https://developer.cisco.com/docs/apic-mim-ref/). L(the APIC Management Information Model reference,https://developer.cisco.com/docs/apic-mim-ref/).
author: author:
- Jacob McGill (@jmcgill298) - Jacob McGill (@jmcgill298)
- Dag Wieers (@dagwieers) - Dag Wieers (@dagwieers)

View file

@ -20,8 +20,8 @@ description:
notes: notes:
- The C(tenant) used must exist before using this module in your playbook. - The C(tenant) used must exist before using this module in your playbook.
The M(aci_tenant) module can be used for this. The M(aci_tenant) module can be used for this.
- More information about the internal APIC class B(fv:Ctx) at - More information about the internal APIC class B(fv:Ctx) from
U(https://developer.cisco.com/docs/apic-mim-ref/). L(the APIC Management Information Model reference,https://developer.cisco.com/docs/apic-mim-ref/).
author: author:
- Jacob McGill (@jmcgill298) - Jacob McGill (@jmcgill298)
version_added: '2.4' version_added: '2.4'

View file

@ -47,8 +47,8 @@ options:
description: description:
- Influence the output of this ACI module. - Influence the output of this ACI module.
- C(normal) means the standard output, incl. C(current) dict - C(normal) means the standard output, incl. C(current) dict
- C(info) means informational output, incl. C(previous), C(proposed) and C(sent) dicts - C(info) adds informational output, incl. C(previous), C(proposed) and C(sent) dicts
- C(debug) means debugging output, incl. C(filter_string), C(method), C(response), C(status) and C(url) information - C(debug) adds debugging output, incl. C(filter_string), C(method), C(response), C(status) and C(url) information
choices: [ debug, info, normal ] choices: [ debug, info, normal ]
default: normal default: normal
timeout: timeout: