Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ACI: Improve module index short_description #36665

Merged
merged 1 commit into from
Feb 24, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
DOCUMENTATION = r'''
---
module: aci_access_port_to_interface_policy_leaf_profile
short_description: Manage Fabric interface policy leaf profile interface selectors on Cisco ACI fabrics (infra:HPortS, infra:RsAccBaseGrp, infra:PortBlk)
short_description: Manage Fabric interface policy leaf profile interface selectors (infra:HPortS, infra:RsAccBaseGrp, infra:PortBlk)
description:
- Manage Fabric interface policy leaf profile interface selectors on Cisco ACI fabrics.
notes:
Expand Down
2 changes: 1 addition & 1 deletion lib/ansible/modules/network/aci/aci_aep.py
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
DOCUMENTATION = r'''
---
module: aci_aep
short_description: Manage attachable Access Entity Profile (AEP) on Cisco ACI fabrics (infra:AttEntityP|infra:ProvAcc)
short_description: Manage attachable Access Entity Profile (AEP) objects (infra:AttEntityP|infra:ProvAcc)
description:
- Connect to external virtual and physical domains by using
attachable Access Entity Profiles (AEP) on Cisco ACI fabrics.
Expand Down
2 changes: 1 addition & 1 deletion lib/ansible/modules/network/aci/aci_aep_to_domain.py
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
DOCUMENTATION = r'''
---
module: aci_aep_to_domain
short_description: Bind AEPs to Physical or Virtual Domains on Cisco ACI fabrics (infra:RsDomP)
short_description: Bind AEPs to Physical or Virtual Domains (infra:RsDomP)
description:
- Bind AEPs to Physical or Virtual Domains on Cisco ACI fabrics.
notes:
Expand Down
2 changes: 1 addition & 1 deletion lib/ansible/modules/network/aci/aci_ap.py
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
DOCUMENTATION = r'''
---
module: aci_ap
short_description: Manage top level Application Profile (AP) objects on Cisco ACI fabrics (fv:Ap)
short_description: Manage top level Application Profile (AP) objects (fv:Ap)
description:
- Manage top level Application Profile (AP) objects on Cisco ACI fabrics
notes:
Expand Down
2 changes: 1 addition & 1 deletion lib/ansible/modules/network/aci/aci_bd.py
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
DOCUMENTATION = r'''
---
module: aci_bd
short_description: Manage Bridge Domains (BD) on Cisco ACI Fabrics (fv:BD)
short_description: Manage Bridge Domains (BD) objects (fv:BD)
description:
- Manages Bridge Domains (BD) on Cisco ACI Fabrics.
notes:
Expand Down
2 changes: 1 addition & 1 deletion lib/ansible/modules/network/aci/aci_bd_subnet.py
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
DOCUMENTATION = r'''
---
module: aci_bd_subnet
short_description: Manage Subnets on Cisco ACI fabrics (fv:Subnet)
short_description: Manage Subnets (fv:Subnet)
description:
- Manage Subnets on Cisco ACI fabrics.
notes:
Expand Down
2 changes: 1 addition & 1 deletion lib/ansible/modules/network/aci/aci_bd_to_l3out.py
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
DOCUMENTATION = r'''
---
module: aci_bd_to_l3out
short_description: Bind Bridge Domain to L3 Out on Cisco ACI fabrics (fv:RsBDToOut)
short_description: Bind Bridge Domain to L3 Out (fv:RsBDToOut)
description:
- Bind Bridge Domain to L3 Out on Cisco ACI fabrics.
notes:
Expand Down
2 changes: 1 addition & 1 deletion lib/ansible/modules/network/aci/aci_config_rollback.py
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
DOCUMENTATION = r'''
---
module: aci_config_rollback
short_description: Provides rollback and rollback preview functionality for Cisco ACI fabrics (config:ImportP)
short_description: Provides rollback and rollback preview functionality (config:ImportP)
description:
- Provides rollback and rollback preview functionality for Cisco ACI fabric.
- Config Rollbacks are done using snapshots C(aci_snapshot) with the configImportP class.
Expand Down
2 changes: 1 addition & 1 deletion lib/ansible/modules/network/aci/aci_config_snapshot.py
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
DOCUMENTATION = r'''
---
module: aci_config_snapshot
short_description: Manage Config Snapshots on Cisco ACI fabrics (config:Snapshot, config:ExportP)
short_description: Manage Config Snapshots (config:Snapshot, config:ExportP)
description:
- Manage Config Snapshots on Cisco ACI fabrics.
- Creating new Snapshots is done using the configExportP class.
Expand Down
2 changes: 1 addition & 1 deletion lib/ansible/modules/network/aci/aci_contract.py
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
DOCUMENTATION = r'''
---
module: aci_contract
short_description: Manage contract resources on Cisco ACI fabrics (vz:BrCP)
short_description: Manage contract resources (vz:BrCP)
description:
- Manage Contract resources on Cisco ACI fabrics.
notes:
Expand Down
2 changes: 1 addition & 1 deletion lib/ansible/modules/network/aci/aci_contract_subject.py
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
DOCUMENTATION = r'''
---
module: aci_contract_subject
short_description: Manage initial Contract Subjects on Cisco ACI fabrics (vz:Subj)
short_description: Manage initial Contract Subjects (vz:Subj)
description:
- Manage initial Contract Subjects on Cisco ACI fabrics.
notes:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
DOCUMENTATION = r'''
---
module: aci_contract_subject_to_filter
short_description: Bind Contract Subjects to Filters on Cisco ACI fabrics (vz:RsSubjFiltAtt)
short_description: Bind Contract Subjects to Filters (vz:RsSubjFiltAtt)
description:
- Bind Contract Subjects to Filters on Cisco ACI fabrics.
notes:
Expand Down
2 changes: 1 addition & 1 deletion lib/ansible/modules/network/aci/aci_domain.py
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
DOCUMENTATION = r'''
---
module: aci_domain
short_description: Manage physical, virtual, bridged, routed or FC domain profiles (*:DomP)
short_description: Manage physical, virtual, bridged, routed or FC domain profiles (phys:DomP, vmm:DomP, l2ext:DomP, l3ext:DomP, fc:DomP)
description:
- Manage physical, virtual, bridged, routed or FC domain profiles.
notes:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
DOCUMENTATION = r'''
---
module: aci_domain_to_encap_pool
short_description: Bind Domain to Encap Pools on Cisco ACI fabrics (infra:RsVlanNs)
short_description: Bind Domain to Encap Pools (infra:RsVlanNs)
description:
- Bind Domain to Encap Pools on Cisco ACI fabrics.
notes:
Expand Down
2 changes: 1 addition & 1 deletion lib/ansible/modules/network/aci/aci_domain_to_vlan_pool.py
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
DOCUMENTATION = r'''
---
module: aci_domain_to_vlan_pool
short_description: Bind Domain to VLAN Pools on Cisco ACI fabrics (infra:RsVlanNs)
short_description: Bind Domain to VLAN Pools (infra:RsVlanNs)
description:
- Bind Domain to VLAN Pools on Cisco ACI fabrics.
notes:
Expand Down
2 changes: 1 addition & 1 deletion lib/ansible/modules/network/aci/aci_encap_pool.py
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
DOCUMENTATION = r'''
---
module: aci_encap_pool
short_description: Manage encap pools on Cisco ACI fabrics (fvns:VlanInstP, fvns:VxlanInstP, fvns:VsanInstP)
short_description: Manage encap pools (fvns:VlanInstP, fvns:VxlanInstP, fvns:VsanInstP)
description:
- Manage vlan, vxlan, and vsan pools on Cisco ACI fabrics.
notes:
Expand Down
2 changes: 1 addition & 1 deletion lib/ansible/modules/network/aci/aci_encap_pool_range.py
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
DOCUMENTATION = r'''
---
module: aci_encap_pool_range
short_description: Manage encap ranges assigned to pools on Cisco ACI fabrics (fvns:EncapBlk, fvns:VsanEncapBlk)
short_description: Manage encap ranges assigned to pools (fvns:EncapBlk, fvns:VsanEncapBlk)
description:
- Manage vlan, vxlan, and vsan ranges that are assigned to pools on Cisco ACI fabrics.
notes:
Expand Down
2 changes: 1 addition & 1 deletion lib/ansible/modules/network/aci/aci_epg.py
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
DOCUMENTATION = r'''
---
module: aci_epg
short_description: Manage End Point Groups (EPG) on Cisco ACI fabrics (fv:AEPg)
short_description: Manage End Point Groups (EPG) objects (fv:AEPg)
description:
- Manage End Point Groups (EPG) on Cisco ACI fabrics.
notes:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
DOCUMENTATION = r'''
---
module: aci_epg_monitoring_policy
short_description: Manage monitoring policies on Cisco ACI fabrics (mon:EPGPol)
short_description: Manage monitoring policies (mon:EPGPol)
description:
- Manage monitoring policies on Cisco ACI fabrics.
notes:
Expand Down
2 changes: 1 addition & 1 deletion lib/ansible/modules/network/aci/aci_epg_to_contract.py
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
DOCUMENTATION = r'''
---
module: aci_epg_to_contract
short_description: Bind EPGs to Contracts on Cisco ACI fabrics (fv:RsCons and fv:RsProv)
short_description: Bind EPGs to Contracts (fv:RsCons, fv:RsProv)
description:
- Bind EPGs to Contracts on Cisco ACI fabrics.
notes:
Expand Down
2 changes: 1 addition & 1 deletion lib/ansible/modules/network/aci/aci_epg_to_domain.py
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
DOCUMENTATION = r'''
---
module: aci_epg_to_domain
short_description: Bind EPGs to Domains on Cisco ACI fabrics (fv:RsDomAtt)
short_description: Bind EPGs to Domains (fv:RsDomAtt)
description:
- Bind EPGs to Physical and Virtual Domains on Cisco ACI fabrics.
notes:
Expand Down
4 changes: 2 additions & 2 deletions lib/ansible/modules/network/aci/aci_fabric_node.py
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,9 @@
DOCUMENTATION = r'''
---
module: aci_fabric_node
short_description: Add a new Fabric Node Member on Cisco ACI fabrics (fabric:NodeIdentP)
short_description: Manage Fabric Node Members (fabric:NodeIdentP)
description:
- Add a new Fabric Node Member on Cisco ACI fabrics.
- Manage Fabric Node Members on Cisco ACI fabrics.
notes:
- More information from the internal APIC class
I(fabric:NodeIdentP) at U(https://developer.cisco.com/site/aci/docs/apis/apic-mim-ref/).
Expand Down
2 changes: 1 addition & 1 deletion lib/ansible/modules/network/aci/aci_filter.py
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
DOCUMENTATION = r'''
---
module: aci_filter
short_description: Manages top level filter objects on Cisco ACI fabrics (vz:Filter)
short_description: Manages top level filter objects (vz:Filter)
description:
- Manages top level filter objects on Cisco ACI fabrics.
- This modules does not manage filter entries, see M(aci_filter_entry) for this functionality.
Expand Down
2 changes: 1 addition & 1 deletion lib/ansible/modules/network/aci/aci_filter_entry.py
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
DOCUMENTATION = r'''
---
module: aci_filter_entry
short_description: Manage filter entries on Cisco ACI fabrics (vz:Entry)
short_description: Manage filter entries (vz:Entry)
description:
- Manage filter entries for a filter on Cisco ACI fabrics.
notes:
Expand Down
2 changes: 1 addition & 1 deletion lib/ansible/modules/network/aci/aci_firmware_source.py
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
DOCUMENTATION = r'''
---
module: aci_firmware_source
short_description: Manage firmware image sources on Cisco ACI fabrics (firmware:OSource)
short_description: Manage firmware image sources (firmware:OSource)
description:
- Manage firmware image sources on Cisco ACI fabrics.
author:
Expand Down
2 changes: 1 addition & 1 deletion lib/ansible/modules/network/aci/aci_interface_policy_fc.py
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
DOCUMENTATION = r'''
---
module: aci_interface_policy_fc
short_description: Manage Fibre Channel interface policies on Cisco ACI fabrics (fc:IfPol)
short_description: Manage Fibre Channel interface policies (fc:IfPol)
description:
- Manage ACI Fiber Channel interface policies on Cisco ACI fabrics.
author:
Expand Down
2 changes: 1 addition & 1 deletion lib/ansible/modules/network/aci/aci_interface_policy_l2.py
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
DOCUMENTATION = r'''
---
module: aci_interface_policy_l2
short_description: Manage Layer 2 interface policies on Cisco ACI fabrics (l2:IfPol)
short_description: Manage Layer 2 interface policies (l2:IfPol)
description:
- Manage Layer 2 interface policies on Cisco ACI fabrics.
author:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,9 @@
DOCUMENTATION = r'''
---
module: aci_interface_policy_leaf_policy_group
short_description: Add Fabric Interface Policy Leaf Policy Groups on Cisco ACI fabrics.
short_description: Manage fabric interface policy leaf policy groups (infra:AccBndlGrp, infra:AccPortGrp)
description:
- Add Fabric Interface Policy Leaf Policy Groups on Cisco ACI fabrics.
- Manage fabric interface policy leaf policy groups on Cisco ACI fabrics.
notes:
- 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.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,9 @@
DOCUMENTATION = r'''
---
module: aci_interface_policy_leaf_profile
short_description: Manage Fabric interface policy leaf profiles on Cisco ACI fabrics (infra:AccPortP)
short_description: Manage fabric interface policy leaf profiles (infra:AccPortP)
description:
- Manage Fabric interface policy leaf profiles on Cisco ACI fabrics.
- Manage fabric interface policy leaf profiles on Cisco ACI fabrics.
notes:
- More information from the internal APIC class I(infra:AccPortP) at
U(https://developer.cisco.com/docs/apic-mim-ref/).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
DOCUMENTATION = r'''
---
module: aci_interface_policy_lldp
short_description: Manage LLDP interface policies on Cisco ACI fabrics (lldp:IfPol)
short_description: Manage LLDP interface policies (lldp:IfPol)
description:
- Manage LLDP interface policies on Cisco ACI fabrics.
notes:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
DOCUMENTATION = r'''
---
module: aci_interface_policy_mcp
short_description: Manage MCP interface policies on Cisco ACI fabrics (mcp:IfPol)
short_description: Manage MCP interface policies (mcp:IfPol)
description:
- Manage MCP interface policies on Cisco ACI fabrics.
notes:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
DOCUMENTATION = r'''
---
module: aci_interface_policy_port_channel
short_description: Manage port channel interface policies on Cisco ACI fabrics (lacp:LagPol)
short_description: Manage port channel interface policies (lacp:LagPol)
description:
- Manage port channel interface policies on Cisco ACI fabrics.
notes:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
DOCUMENTATION = r'''
---
module: aci_interface_policy_port_security
short_description: Manage port security on Cisco ACI fabrics (l2:PortSecurityPol)
short_description: Manage port security (l2:PortSecurityPol)
description:
- Manage port security on Cisco ACI fabrics.
notes:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,9 @@
DOCUMENTATION = r'''
---
module: aci_interface_selector_to_switch_policy_leaf_profile
short_description: Associates an Interface Selector Profile to a Switch Policy Leaf Profile (infra:RsAccPortP)
short_description: Bind interface selector profiles to switch policy leaf profiles (infra:RsAccPortP)
description:
- Associates an Interface Profile (Selector) to a Switch Policy Leaf Profile on Cisco ACI fabrics.
- Bind interface selector profiles to switch policy leaf profiles on Cisco ACI fabrics.
notes:
- This module requires an existing leaf profile, the module M(aci_switch_policy_leaf_profile) can be used for this.
- More information from the internal APIC class I(infra:RsAccPortP) at
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
DOCUMENTATION = r'''
---
module: aci_l3out_route_tag_policy
short_description: Manage route tag policies on Cisco ACI fabrics (l3ext:RouteTagPol)
short_description: Manage route tag policies (l3ext:RouteTagPol)
description:
- Manage route tag policies on Cisco ACI fabrics.
notes:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
DOCUMENTATION = r'''
---
module: aci_static_binding_to_epg
short_description: Bind static paths to EPGs on Cisco ACI fabrics (fv:RsPathAtt)
short_description: Bind static paths to EPGs (fv:RsPathAtt)
description:
- Bind static paths to EPGs on Cisco ACI fabrics.
notes:
Expand Down
4 changes: 2 additions & 2 deletions lib/ansible/modules/network/aci/aci_switch_leaf_selector.py
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,9 @@
DOCUMENTATION = r'''
---
module: aci_switch_leaf_selector
short_description: Add a leaf Selector with Node Block Range and Policy Group to a Switch Policy Leaf Profile on Cisco ACI fabrics
short_description: Bind leaf selectors to switch policy leaf profiles (infra:LeafS, infra:NodeBlk, infra:RsAccNodePGrep)
description:
- Add a leaf Selector with Node Block range and Policy Group to a Switch Policy Leaf Profile on Cisco ACI fabrics.
- Bind leaf selectors (with node block range and policy group) to switch policy leaf profiles on Cisco ACI fabrics.
notes:
- 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),
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,9 @@
DOCUMENTATION = r'''
---
module: aci_switch_policy_leaf_profile
short_description: Create switch policy leaf profiles on Cisco ACI fabrics (infra:NodeP)
short_description: Manage switch policy leaf profiles (infra:NodeP)
description:
- Create switch policy leaf profiles on Cisco ACI fabrics.
- Manage switch policy leaf profiles on Cisco ACI fabrics.
notes:
- More information from the internal APIC class I(infra:NodeP) at
U(https://developer.cisco.com/docs/apic-mim-ref/).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,9 @@
DOCUMENTATION = r'''
---
module: aci_switch_policy_vpc_protection_group
short_description: Create switch policy Explicit vPC Protection Group on Cisco ACI fabrics (fabric:ExplicitGEp, fabric:NodePEp).
short_description: Manage switch policy explicit vPC protection groups (fabric:ExplicitGEp, fabric:NodePEp).
description:
- Create switch policy Explicit vPC Protection Group on Cisco ACI fabrics.
- Manage switch policy explicit vPC protection groups on Cisco ACI fabrics.
notes:
- More information from the internal APIC class
I(fabric:ExplicitGEp) and I(fabric:NodePEp) at U(https://developer.cisco.com/site/aci/docs/apis/apic-mim-ref/).
Expand Down
2 changes: 1 addition & 1 deletion lib/ansible/modules/network/aci/aci_taboo_contract.py
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
DOCUMENTATION = r'''
---
module: aci_taboo_contract
short_description: Manage taboo contracts on Cisco ACI fabrics (vz:BrCP)
short_description: Manage taboo contracts (vz:BrCP)
description:
- Manage taboo contracts on Cisco ACI fabrics.
notes:
Expand Down
2 changes: 1 addition & 1 deletion lib/ansible/modules/network/aci/aci_tenant.py
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
DOCUMENTATION = r'''
---
module: aci_tenant
short_description: Manage tenants on Cisco ACI fabrics (fv:Tenant)
short_description: Manage tenants (fv:Tenant)
description:
- Manage tenants on Cisco ACI fabrics.
notes:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
DOCUMENTATION = r'''
---
module: aci_tenant_action_rule_profile
short_description: Manage action rule profiles on Cisco ACI fabrics (rtctrl:AttrP)
short_description: Manage action rule profiles (rtctrl:AttrP)
description:
- Manage action rule profiles on Cisco ACI fabrics.
notes:
Expand Down