[ignore] Add class information in short description (#599)

CiscoDevNet · Feb 27, 2024 · 15995b8 · 15995b8
1 parent 86aa9cb
commit 15995b8
Show file tree

Hide file tree

Showing 82 changed files with 161 additions and 141 deletions.
diff --git a/plugins/modules/aci_aaa_ssh_auth.py b/plugins/modules/aci_aaa_ssh_auth.py
@@ -13,7 +13,7 @@
 DOCUMENTATION = r"""
 ---
 module: aci_aaa_ssh_auth
-short_description: Manage AAA SSH auth (aaaSshAuth) objects.
+short_description: Manage AAA SSH auth objects (aaa:SshAuth)
 description:
 - Manage AAA SSH Auth key configuration on Cisco ACI fabrics.
 options:
@@ -47,7 +47,7 @@
   The M(cisco.aci.aci_aaa_user) modules can be used for this.
 seealso:
 - name: APIC Management Information Model reference
-  description: More information about the internal APIC class B(aaaSshAuth).
+  description: More information about the internal APIC class B(aaa:SshAuth).
   link: https://developer.cisco.com/docs/apic-mim-ref/
 author:
 - Tim Cragg (@timcragg)

diff --git a/plugins/modules/aci_access_port_block_to_access_port.py b/plugins/modules/aci_access_port_block_to_access_port.py
@@ -15,7 +15,7 @@
 DOCUMENTATION = r"""
 ---
 module: aci_access_port_block_to_access_port
-short_description: Manage port blocks of Fabric interface policy leaf profile interface selectors (infra:HPortS, infra:PortBlk)
+short_description: Manage port blocks of Fabric interface policy leaf profile interface selectors (infra:HPortS and infra:PortBlk)
 description:
 - Manage port blocks of Fabric interface policy leaf profile interface selectors on Cisco ACI fabrics.
 options:

diff --git a/plugins/modules/aci_access_port_to_interface_policy_leaf_profile.py b/plugins/modules/aci_access_port_to_interface_policy_leaf_profile.py
@@ -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 (infra:HPortS, infra:RsAccBaseGrp, infra:PortBlk)
+short_description: Manage Fabric interface policy leaf profile interface selectors (infra:HPortS, infra:RsAccBaseGrp, and infra:PortBlk)
 description:
 - Manage Fabric interface policy leaf profile interface selectors on Cisco ACI fabrics.
 options:

diff --git a/plugins/modules/aci_access_sub_port_block_to_access_port.py b/plugins/modules/aci_access_sub_port_block_to_access_port.py
@@ -13,7 +13,7 @@
 DOCUMENTATION = r"""
 ---
 module: aci_access_sub_port_block_to_access_port
-short_description: Manage sub port blocks of Fabric interface policy leaf profile interface selectors (infra:HPortS, infra:SubPortBlk)
+short_description: Manage sub port blocks of Fabric interface policy leaf profile interface selectors (infra:HPortS and infra:SubPortBlk)
 description:
 - Manage sub port blocks of Fabric interface policy leaf profile interface selectors on Cisco ACI fabrics.
 seealso:

diff --git a/plugins/modules/aci_aep.py b/plugins/modules/aci_aep.py
@@ -13,7 +13,7 @@
 DOCUMENTATION = r"""
 ---
 module: aci_aep
-short_description: Manage attachable Access Entity Profile (AEP) objects (infra:AttEntityP, infra:ProvAcc)
+short_description: Manage attachable Access Entity Profile (AEP) objects (infra:AttEntityP and infra:ProvAcc)
 description:
 - Connect to external virtual and physical domains by using
   attachable Access Entity Profiles (AEP) on Cisco ACI fabrics.

diff --git a/plugins/modules/aci_aep_to_epg.py b/plugins/modules/aci_aep_to_epg.py
@@ -12,7 +12,7 @@
 DOCUMENTATION = r"""
 ---
 module: aci_aep_to_epg
-short_description: Bind EPG to AEP (infra:RsFuncToEpg).
+short_description: Bind EPG to AEP (infra:RsFuncToEpg)
 description:
 - Bind EPG to AEP.
 options:

diff --git a/plugins/modules/aci_bfd_multihop_node_policy.py b/plugins/modules/aci_bfd_multihop_node_policy.py
@@ -13,10 +13,10 @@
 DOCUMENTATION = r"""
 ---
 module: aci_bfd_multihop_node_policy
-short_description: Manage BFD Multihop Node policies
+short_description: Manage BFD Multihop Node policies (bfd:MhNodePol)
 description:
-- Manage BFD Multihop Node policy (bfd:MhNodePol) configuration on Cisco ACI fabrics
-- Only available in APIC version 5.2 or later
+- Manage BFD Multihop Node policy configuration on Cisco ACI fabrics.
+- Only available in APIC version 5.2 or later.
 options:
   tenant:
     description:

diff --git a/plugins/modules/aci_bgp_rr_asn.py b/plugins/modules/aci_bgp_rr_asn.py
@@ -13,9 +13,9 @@
 DOCUMENTATION = r"""
 ---
 module: aci_bgp_rr_asn
-short_description: Manage BGP Route Reflector ASN.
+short_description: Manage BGP Route Reflector ASN (bgp:AsP)
 description:
-- Manage the BGP Autonomous System Number of the fabric (bgpAsP).
+- Manage the BGP Autonomous System Number of the fabric.
 - This module is specifically for fabric BGP, for L3Out BGP use the aci_l3out_bgp_peer module
 options:
   asn:
@@ -35,7 +35,7 @@
 
 seealso:
 - name: APIC Management Information Model reference
-  description: More information about the internal APIC class B(bgpAsP).
+  description: More information about the internal APIC class B(bgp:AsP).
   link: https://developer.cisco.com/docs/apic-mim-ref/
 author:
 - Tim Cragg (@timcragg)

diff --git a/plugins/modules/aci_bgp_rr_node.py b/plugins/modules/aci_bgp_rr_node.py
@@ -13,9 +13,9 @@
 DOCUMENTATION = r"""
 ---
 module: aci_bgp_rr_node
-short_description: Manage BGP Route Reflector objects.
+short_description: Manage BGP Route Reflector objects (bgp:RRNodePEp)
 description:
-- Manage ACI BGP Route Reflector Nodes (bgpRRNodePEp).
+- Manage ACI BGP Route Reflector Nodes.
 options:
   node_id:
     description:
@@ -42,7 +42,7 @@
 
 seealso:
 - name: APIC Management Information Model reference
-  description: More information about the internal APIC class B(bgpRRNodePEp).
+  description: More information about the internal APIC class B(bgp:RRNodePEp).
   link: https://developer.cisco.com/docs/apic-mim-ref/
 author:
 - Tim Cragg (@timcragg)

diff --git a/plugins/modules/aci_config_snapshot.py b/plugins/modules/aci_config_snapshot.py
@@ -12,7 +12,7 @@
 DOCUMENTATION = r"""
 ---
 module: aci_config_snapshot
-short_description: Manage Config Snapshots (config:Snapshot, config:ExportP)
+short_description: Manage Config Snapshots (config:Snapshot and config:ExportP)
 description:
 - Manage Config Snapshots on Cisco ACI fabrics.
 - Creating new Snapshots is done using the configExportP class.

diff --git a/plugins/modules/aci_contract_subject_to_service_graph.py b/plugins/modules/aci_contract_subject_to_service_graph.py
@@ -12,7 +12,7 @@
 DOCUMENTATION = r"""
 ---
 module: aci_contract_subject_to_service_graph
-short_description: Bind contract subject to service graph (vz:RsSubjGraphAtt).
+short_description: Bind contract subject to service graph (vz:RsSubjGraphAtt)
 description:
 - Bind contract subject to service graph.
 options:

diff --git a/plugins/modules/aci_dhcp_relay.py b/plugins/modules/aci_dhcp_relay.py
@@ -14,9 +14,9 @@
 DOCUMENTATION = r"""
 ---
 module: aci_dhcp_relay
-short_description: Manage DHCP relay policies.
+short_description: Manage DHCP relay policies (dhcp:RelayP)
 description:
-- Manage DHCP relay policy (dhcpRelayP) configuration on Cisco ACI fabrics.
+- Manage DHCP relay policy configuration on Cisco ACI fabrics.
 options:
   tenant:
     description:
@@ -48,7 +48,7 @@
   The M(cisco.aci.aci_tenant) modules can be used for this.
 seealso:
 - name: APIC Management Information Model reference
-  description: More information about the internal APIC class B(dhcpRelayP).
+  description: More information about the internal APIC class B(dhcp:RelayP).
   link: https://developer.cisco.com/docs/apic-mim-ref/
 author:
 - Tim Cragg (@timcragg)

diff --git a/plugins/modules/aci_dhcp_relay_provider.py b/plugins/modules/aci_dhcp_relay_provider.py
@@ -14,9 +14,9 @@
 DOCUMENTATION = r"""
 ---
 module: aci_dhcp_relay_provider
-short_description: Manage DHCP relay policy providers.
+short_description: Manage DHCP relay policy providers (dhcp:RsProv)
 description:
-- Manage DHCP relay policy providers (dhcpRsProv) configuration on Cisco ACI fabrics.
+- Manage DHCP relay policy providers configuration on Cisco ACI fabrics.
 options:
   tenant:
     description:
@@ -91,7 +91,7 @@
   The M(cisco.aci.aci_tenant) and C(cisco.aci.aci_dhcp_relay) modules can be used for this.
 seealso:
 - name: APIC Management Information Model reference
-  description: More information about the internal APIC class B(dhcpRsProv).
+  description: More information about the internal APIC class B(dhcp:RsProv).
   link: https://developer.cisco.com/docs/apic-mim-ref/
 author:
 - Tim Cragg (@timcragg)

diff --git a/plugins/modules/aci_dns_domain.py b/plugins/modules/aci_dns_domain.py
@@ -13,7 +13,7 @@
 DOCUMENTATION = r"""
 ---
 module: aci_dns_domain
-short_description: Manage DNS Provider (dnsDomain) objects.
+short_description: Manage DNS Provider objects (dns:Domain)
 description:
 - Manage DNS Domain configuration on Cisco ACI fabrics.
 options:
@@ -49,7 +49,7 @@
 
 seealso:
 - name: APIC Management Information Model reference
-  description: More information about the internal APIC class B(dnsDomain).
+  description: More information about the internal APIC class B(dns:Domain).
   link: https://developer.cisco.com/docs/apic-mim-ref/
 author:
 - Tim Cragg (@timcragg)

diff --git a/plugins/modules/aci_dns_profile.py b/plugins/modules/aci_dns_profile.py
@@ -13,7 +13,7 @@
 DOCUMENTATION = r"""
 ---
 module: aci_dns_profile
-short_description: Manage DNS Profile (dnsProfile) objects.
+short_description: Manage DNS Profile objects (dns:Profile)
 description:
 - Manage DNS Profile configuration on Cisco ACI fabrics.
 options:
@@ -35,7 +35,7 @@
 
 seealso:
 - name: APIC Management Information Model reference
-  description: More information about the internal APIC class B(dnsProfile).
+  description: More information about the internal APIC class B(dns:Profile).
   link: https://developer.cisco.com/docs/apic-mim-ref/
 author:
 - Tim Cragg (@timcragg)

diff --git a/plugins/modules/aci_dns_provider.py b/plugins/modules/aci_dns_provider.py
@@ -13,7 +13,7 @@
 DOCUMENTATION = r"""
 ---
 module: aci_dns_provider
-short_description: Manage DNS Provider (dnsProv) objects.
+short_description: Manage DNS Provider objects (dns:Prov)
 description:
 - Manage DNS Provider configuration on Cisco ACI fabrics.
 options:

diff --git a/plugins/modules/aci_domain.py b/plugins/modules/aci_domain.py
@@ -12,7 +12,7 @@
 DOCUMENTATION = r"""
 ---
 module: aci_domain
-short_description: Manage physical, virtual, bridged, routed or FC domain profiles (phys:DomP, vmm:DomP, l2ext:DomP, l3ext:DomP, fc:DomP)
+short_description: Manage physical, virtual, bridged, routed or FC domain profiles (phys:DomP, vmm:DomP, l2ext:DomP, l3ext:DomP, and fc:DomP)
 description:
 - Manage physical, virtual, bridged, routed or FC domain profiles on Cisco ACI fabrics.
 options:

diff --git a/plugins/modules/aci_encap_pool.py b/plugins/modules/aci_encap_pool.py
@@ -12,7 +12,7 @@
 DOCUMENTATION = r"""
 ---
 module: aci_encap_pool
-short_description: Manage encap pools (fvns:VlanInstP, fvns:VxlanInstP, fvns:VsanInstP)
+short_description: Manage encap pools (fvns:VlanInstP, fvns:VxlanInstP, and fvns:VsanInstP)
 description:
 - Manage vlan, vxlan, and vsan pools on Cisco ACI fabrics.
 options:

diff --git a/plugins/modules/aci_encap_pool_range.py b/plugins/modules/aci_encap_pool_range.py
@@ -12,7 +12,7 @@
 DOCUMENTATION = r"""
 ---
 module: aci_encap_pool_range
-short_description: Manage encap ranges assigned to pools (fvns:EncapBlk, fvns:VsanEncapBlk)
+short_description: Manage encap ranges assigned to pools (fvns:EncapBlk and fvns:VsanEncapBlk)
 description:
 - Manage vlan, vxlan, and vsan ranges that are assigned to pools on Cisco ACI fabrics.
 options:

diff --git a/plugins/modules/aci_epg_to_contract.py b/plugins/modules/aci_epg_to_contract.py
@@ -14,7 +14,7 @@
 DOCUMENTATION = r"""
 ---
 module: aci_epg_to_contract
-short_description: Bind EPGs to Contracts (fv:RsCons, fv:RsProv, fv:RsProtBy, fv:RsConsIf, fv:RsIntraEpg)
+short_description: Bind EPGs to Contracts (fv:RsCons, fv:RsProv, fv:RsProtBy, fv:RsConsIf, and fv:RsIntraEpg)
 description:
 - Bind EPGs to Contracts on Cisco ACI fabrics.
 notes:

diff --git a/plugins/modules/aci_epg_to_contract_interface.py b/plugins/modules/aci_epg_to_contract_interface.py
@@ -13,7 +13,7 @@
 DOCUMENTATION = r"""
 ---
 module: aci_epg_to_contract_interface
-short_description: Bind EPGs to Consumed Contracts Interface (fv:RsConsIf).
+short_description: Bind EPGs to Consumed Contracts Interface (fv:RsConsIf)
 
 description:
 - Bind EPGs to Consumed Contracts Interface on Cisco ACI fabrics.

diff --git a/plugins/modules/aci_esg_ip_subnet_selector.py b/plugins/modules/aci_esg_ip_subnet_selector.py
@@ -14,7 +14,7 @@
 DOCUMENTATION = r"""
 ---
 module: aci_esg_ip_subnet_selector
-short_description: Manage ESG IP Subnet selector(fv:EPSelector)
+short_description: Manage ESG IP Subnet selector (fv:EPSelector)
 description:
 - Manage Endpoint Security Groups (ESG) IP Subnet selector on Cisco ACI fabrics.
 

diff --git a/plugins/modules/aci_fabric_interface_policy_group.py b/plugins/modules/aci_fabric_interface_policy_group.py
@@ -13,7 +13,7 @@
 DOCUMENTATION = r"""
 ---
 module: aci_fabric_interface_policy_group
-short_description: Manage Fabric Interface Policy Groups (fabric:LePortPGrp, fabric:SpPortPGrp)
+short_description: Manage Fabric Interface Policy Groups (fabric:LePortPGrp and fabric:SpPortPGrp)
 description:
 - Manage Fabric Interface Policy Groups on Cisco ACI fabrics.
 options:

diff --git a/plugins/modules/aci_fabric_leaf_profile.py b/plugins/modules/aci_fabric_leaf_profile.py
@@ -12,7 +12,7 @@
 DOCUMENTATION = r"""
 ---
 module: aci_fabric_leaf_profile
-short_description: Manage fabric leaf profiles (fabric:LeafP).
+short_description: Manage fabric leaf profiles (fabric:LeafP)
 description:
 - Manage fabric leaf switch profiles in an ACI fabric.
 options:

diff --git a/plugins/modules/aci_fabric_spine_profile.py b/plugins/modules/aci_fabric_spine_profile.py
@@ -12,7 +12,7 @@
 DOCUMENTATION = r"""
 ---
 module: aci_fabric_spine_profile
-short_description: Manage fabric spine profiles (fabric:SpineP).
+short_description: Manage fabric spine profiles (fabric:SpineP)
 description:
 - Manage fabric spine switch profiles in an ACI fabric.
 options:

diff --git a/plugins/modules/aci_fabric_spine_switch_assoc.py b/plugins/modules/aci_fabric_spine_switch_assoc.py
@@ -12,7 +12,7 @@
 DOCUMENTATION = r"""
 ---
 module: aci_fabric_spine_switch_assoc
-short_description: Manage spine switch bindings to profiles and policy groups (fabric:SpineS and fabric:RsSpNodePGrp).
+short_description: Manage spine switch bindings to profiles and policy groups (fabric:SpineS and fabric:RsSpNodePGrp)
 description:
 - Manage fabric spine switch associations (fabric:SpineS) to an existing fabric
   spine profile (fabric:SpineP) in an ACI fabric, and bind them to a

diff --git a/plugins/modules/aci_fabric_switch_block.py b/plugins/modules/aci_fabric_switch_block.py
@@ -12,7 +12,7 @@
 DOCUMENTATION = r"""
 ---
 module: aci_fabric_switch_block
-short_description: Manage switch blocks (fabric:NodeBlk).
+short_description: Manage switch blocks (fabric:NodeBlk)
 description:
 - Manage fabric node blocks within switch associations (fabric:SpineS and
   fabric:LeafS) contained within fabric switch profiles (fabric:SpineP and fabric:LeafP)