mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-07-23 13:20:23 -07:00
ACI: Asorted fixes to documentation (#36681)
This commit is contained in:
parent
f283edcb19
commit
97fde8c760
9 changed files with 35 additions and 35 deletions
|
@ -16,7 +16,7 @@ DOCUMENTATION = r'''
|
|||
module: aci_aaa_user
|
||||
short_description: Manage AAA users (aaa:User)
|
||||
description:
|
||||
- Manage AAA users.
|
||||
- Manage AAA users on Cisco ACI fabrics.
|
||||
notes:
|
||||
- This module is not idempotent when C(aaa_password) is being used
|
||||
(even if that password was already set identically). This
|
||||
|
|
|
@ -16,7 +16,7 @@ DOCUMENTATION = r'''
|
|||
module: aci_aaa_user_certificate
|
||||
short_description: Manage AAA user certificates (aaa:UserCert)
|
||||
description:
|
||||
- Manage AAA user certificates.
|
||||
- Manage AAA user certificates on Cisco ACI fabrics.
|
||||
notes:
|
||||
- The C(aaa_user) must exist before using this module in your playbook.
|
||||
The M(aci_aaa_user) module can be used for this.
|
||||
|
|
|
@ -15,7 +15,7 @@ DOCUMENTATION = r'''
|
|||
module: aci_bd
|
||||
short_description: Manage Bridge Domains (BD) objects (fv:BD)
|
||||
description:
|
||||
- Manages Bridge Domains (BD) on Cisco ACI Fabrics.
|
||||
- Manages Bridge Domains (BD) on Cisco ACI fabrics.
|
||||
notes:
|
||||
- The C(tenant) used must exist before using this module in your playbook.
|
||||
The M(aci_tenant) module can be used for this.
|
||||
|
|
|
@ -15,7 +15,7 @@ DOCUMENTATION = r'''
|
|||
module: aci_config_rollback
|
||||
short_description: Provides rollback and rollback preview functionality (config:ImportP)
|
||||
description:
|
||||
- Provides rollback and rollback preview functionality for Cisco ACI fabric.
|
||||
- Provides rollback and rollback preview functionality for Cisco ACI fabrics.
|
||||
- Config Rollbacks are done using snapshots C(aci_snapshot) with the configImportP class.
|
||||
notes:
|
||||
- More information from the internal APIC class I(config:ImportP) at
|
||||
|
|
|
@ -15,7 +15,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)
|
||||
description:
|
||||
- Manage physical, virtual, bridged, routed or FC domain profiles.
|
||||
- Manage physical, virtual, bridged, routed or FC domain profiles on Cisco ACI fabrics.
|
||||
notes:
|
||||
- More information from the internal APIC classes I(phys:DomP),
|
||||
I(vmm:DomP), I(l2ext:DomP), I(l3ext:DomP), I(fc:DomP) at
|
||||
|
|
|
@ -38,7 +38,7 @@ options:
|
|||
description:
|
||||
- Name of the end point group.
|
||||
required: yes
|
||||
aliases: [ name, epg_name ]
|
||||
aliases: [ epg_name, name ]
|
||||
bd:
|
||||
description:
|
||||
- Name of the bridge domain being associated with the EPG.
|
||||
|
@ -116,7 +116,7 @@ EXAMPLES = r'''
|
|||
host: apic
|
||||
username: admin
|
||||
password: SomeSecretPassword
|
||||
validate_certs: false
|
||||
validate_certs: no
|
||||
tenant: production
|
||||
app_profile: intranet
|
||||
epg: web_epg
|
||||
|
@ -144,7 +144,7 @@ EXAMPLES = r'''
|
|||
host: apic
|
||||
username: admin
|
||||
password: SomeSecretPassword
|
||||
validate_certs: false
|
||||
validate_certs: no
|
||||
epg: web_epg
|
||||
state: query
|
||||
|
||||
|
@ -153,7 +153,7 @@ EXAMPLES = r'''
|
|||
host: apic
|
||||
username: admin
|
||||
password: SomeSecretPassword
|
||||
validate_certs: false
|
||||
validate_certs: no
|
||||
ap: ticketing
|
||||
state: query
|
||||
'''
|
||||
|
@ -270,7 +270,7 @@ from ansible.module_utils.basic import AnsibleModule
|
|||
def main():
|
||||
argument_spec = aci_argument_spec()
|
||||
argument_spec.update(
|
||||
epg=dict(type='str', aliases=['name', 'epg_name']), # Not required for querying all objects
|
||||
epg=dict(type='str', aliases=['epg_name', 'name']), # Not required for querying all objects
|
||||
bd=dict(type='str', aliases=['bd_name', 'bridge_domain']),
|
||||
ap=dict(type='str', aliases=['app_profile', 'app_profile_name']), # Not required for querying all objects
|
||||
tenant=dict(type='str', aliases=['tenant_name']), # Not required for querying all objects
|
||||
|
|
|
@ -41,7 +41,6 @@ options:
|
|||
transmit_state:
|
||||
description:
|
||||
- Enable or Disable Transmit state.
|
||||
required: false
|
||||
choices: [ disabled, enabled ]
|
||||
default: enabled
|
||||
state:
|
||||
|
|
|
@ -26,7 +26,7 @@ options:
|
|||
port_channel:
|
||||
description:
|
||||
- Name of the port channel.
|
||||
required: true
|
||||
required: yes
|
||||
aliases: [ name ]
|
||||
description:
|
||||
description:
|
||||
|
@ -49,48 +49,48 @@ options:
|
|||
- Port channel interface policy mode.
|
||||
- Determines the LACP method to use for forming port-channels.
|
||||
- The APIC defaults new Port Channel Polices to C(off).
|
||||
choices: [ active, mac-pin, mac-pin-nicload, off, passive ]
|
||||
default: off
|
||||
choices: [ active, mac-pin, mac-pin-nicload, 'off', passive ]
|
||||
default: 'off'
|
||||
fast_select:
|
||||
description:
|
||||
- Determines if Fast Select is enabled for Hot Standby Ports.
|
||||
- This makes up the LACP Policy Control Policy; if one setting is defined, then all other Control Properties
|
||||
left undefined or set to false will not exist after the task is ran.
|
||||
- The APIC defaults new LACP Policies to C(true).
|
||||
- The APIC defaults new LACP Policies to C(yes).
|
||||
type: bool
|
||||
default: true
|
||||
default: 'yes'
|
||||
graceful_convergence:
|
||||
description:
|
||||
- Determines if Graceful Convergence is enabled.
|
||||
- This makes up the LACP Policy Control Policy; if one setting is defined, then all other Control Properties
|
||||
left undefined or set to false will not exist after the task is ran.
|
||||
- The APIC defaults new LACP Policies to C(true).
|
||||
- The APIC defaults new LACP Policies to C(yes).
|
||||
type: bool
|
||||
default: true
|
||||
default: 'yes'
|
||||
load_defer:
|
||||
description:
|
||||
- Determines if Load Defer is enabled.
|
||||
- This makes up the LACP Policy Control Policy; if one setting is defined, then all other Control Properties
|
||||
left undefined or set to false will not exist after the task is ran.
|
||||
- The APIC defaults new LACP Policies to C(false).
|
||||
- The APIC defaults new LACP Policies to C(no).
|
||||
type: bool
|
||||
default: false
|
||||
default: 'no'
|
||||
suspend_individual:
|
||||
description:
|
||||
- Determines if Suspend Individual is enabled.
|
||||
- This makes up the LACP Policy Control Policy; if one setting is defined, then all other Control Properties
|
||||
left undefined or set to false will not exist after the task is ran.
|
||||
- The APIC defaults new LACP Policies to C(true).
|
||||
- The APIC defaults new LACP Policies to C(yes).
|
||||
type: bool
|
||||
default: true
|
||||
default: 'yes'
|
||||
symmetric_hash:
|
||||
description:
|
||||
- Determines if Symmetric Hashing is enabled.
|
||||
- This makes up the LACP Policy Control Policy; if one setting is defined, then all other Control Properties
|
||||
left undefined or set to false will not exist after the task is ran.
|
||||
- The APIC defaults new LACP Policies to C(false).
|
||||
- The APIC defaults new LACP Policies to C(no).
|
||||
type: bool
|
||||
default: false
|
||||
default: 'no'
|
||||
state:
|
||||
description:
|
||||
- Use C(present) or C(absent) for adding or removing.
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue