mirror of
https://github.com/ansible-collections/community.general.git
synced 2024-09-14 20:13:21 +02:00
ACI: Fix parameters and aliases in documentation (#34959)
This commit is contained in:
parent
3b7136c5ab
commit
ac4b031cc0
14 changed files with 44 additions and 20 deletions
|
@ -109,7 +109,7 @@ ACI_MAPPING = dict(
|
||||||
def main():
|
def main():
|
||||||
argument_spec = aci_argument_spec
|
argument_spec = aci_argument_spec
|
||||||
argument_spec.update(
|
argument_spec.update(
|
||||||
certificate=dict(type='str', aliases=['certificate_data', 'data']),
|
certificate=dict(type='str', aliases=['cert_data', 'certificate_data']),
|
||||||
certificate_name=dict(type='str', aliases=['cert_name']),
|
certificate_name=dict(type='str', aliases=['cert_name']),
|
||||||
state=dict(type='str', default='present', choices=['absent', 'present', 'query']),
|
state=dict(type='str', default='present', choices=['absent', 'present', 'query']),
|
||||||
user=dict(type='str', required=True),
|
user=dict(type='str', required=True),
|
||||||
|
|
|
@ -33,6 +33,7 @@ options:
|
||||||
description:
|
description:
|
||||||
description:
|
description:
|
||||||
- Description for the AEP.
|
- Description for the AEP.
|
||||||
|
aliases: [ descr ]
|
||||||
infra_vlan:
|
infra_vlan:
|
||||||
description:
|
description:
|
||||||
- Enable infrastructure VLAN.
|
- Enable infrastructure VLAN.
|
||||||
|
|
|
@ -36,9 +36,10 @@ options:
|
||||||
- The name of the application network profile.
|
- The name of the application network profile.
|
||||||
required: yes
|
required: yes
|
||||||
aliases: [ app_profile, app_profile_name, name ]
|
aliases: [ app_profile, app_profile_name, name ]
|
||||||
descr:
|
description:
|
||||||
description:
|
description:
|
||||||
- Description for the AP.
|
- Description for the AP.
|
||||||
|
aliases: [ descr ]
|
||||||
state:
|
state:
|
||||||
description:
|
description:
|
||||||
- Use C(present) or C(absent) for adding or removing.
|
- Use C(present) or C(absent) for adding or removing.
|
||||||
|
|
|
@ -113,8 +113,8 @@ options:
|
||||||
mac_address:
|
mac_address:
|
||||||
description:
|
description:
|
||||||
- The MAC Address to assign to the C(bd) instead of using the default.
|
- The MAC Address to assign to the C(bd) instead of using the default.
|
||||||
choices: [ mac ]
|
|
||||||
default: 00:22:BD:F8:19:FF
|
default: 00:22:BD:F8:19:FF
|
||||||
|
aliases: [ mac ]
|
||||||
version_added: '2.5'
|
version_added: '2.5'
|
||||||
multi_dest:
|
multi_dest:
|
||||||
description:
|
description:
|
||||||
|
|
|
@ -30,9 +30,11 @@ options:
|
||||||
bd:
|
bd:
|
||||||
description:
|
description:
|
||||||
- The name of the Bridge Domain.
|
- The name of the Bridge Domain.
|
||||||
|
aliases: [ bd_name ]
|
||||||
description:
|
description:
|
||||||
description:
|
description:
|
||||||
- The description for the Subnet.
|
- The description for the Subnet.
|
||||||
|
aliases: [ descr ]
|
||||||
enable_vip:
|
enable_vip:
|
||||||
description:
|
description:
|
||||||
- Determines if the Subnet should be treated as a VIP; used when the BD is extended to multiple sites.
|
- Determines if the Subnet should be treated as a VIP; used when the BD is extended to multiple sites.
|
||||||
|
@ -98,6 +100,12 @@ options:
|
||||||
description:
|
description:
|
||||||
- The name of the Tenant.
|
- The name of the Tenant.
|
||||||
aliases: [ tenant_name ]
|
aliases: [ tenant_name ]
|
||||||
|
state:
|
||||||
|
description:
|
||||||
|
- Use C(present) or C(absent) for adding or removing.
|
||||||
|
- Use C(query) for listing an object or multiple objects.
|
||||||
|
choices: [ absent, present, query ]
|
||||||
|
default: present
|
||||||
extends_documentation_fragment: aci
|
extends_documentation_fragment: aci
|
||||||
'''
|
'''
|
||||||
|
|
||||||
|
|
|
@ -61,6 +61,7 @@ options:
|
||||||
description:
|
description:
|
||||||
description:
|
description:
|
||||||
- Description for the contract subject.
|
- Description for the contract subject.
|
||||||
|
aliases: [ descr ]
|
||||||
consumer_match:
|
consumer_match:
|
||||||
description:
|
description:
|
||||||
- The match criteria across consumers.
|
- The match criteria across consumers.
|
||||||
|
|
|
@ -34,6 +34,7 @@ options:
|
||||||
filter:
|
filter:
|
||||||
description:
|
description:
|
||||||
- The name of the Filter to bind to the Subject.
|
- The name of the Filter to bind to the Subject.
|
||||||
|
aliases: [ filter_name ]
|
||||||
log:
|
log:
|
||||||
description:
|
description:
|
||||||
- Determines if the binding should be set to log.
|
- Determines if the binding should be set to log.
|
||||||
|
|
|
@ -26,6 +26,12 @@ 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.
|
||||||
options:
|
options:
|
||||||
|
allocation_mode:
|
||||||
|
description:
|
||||||
|
- The method used for allocating encaps to resources.
|
||||||
|
- Only vlan and vsan support allocation modes.
|
||||||
|
choices: [ dynamic, static]
|
||||||
|
aliases: [ mode ]
|
||||||
domain:
|
domain:
|
||||||
description:
|
description:
|
||||||
- Name of the domain being associated with the Encap Pool.
|
- Name of the domain being associated with the Encap Pool.
|
||||||
|
@ -38,12 +44,6 @@ options:
|
||||||
description:
|
description:
|
||||||
- The name of the pool.
|
- The name of the pool.
|
||||||
aliases: [ pool_name ]
|
aliases: [ pool_name ]
|
||||||
pool_allocation_mode:
|
|
||||||
description:
|
|
||||||
- The method used for allocating encaps to resources.
|
|
||||||
- Only vlan and vsan support allocation modes.
|
|
||||||
aliases: [ mode ]
|
|
||||||
choices: [ dynamic, static]
|
|
||||||
pool_type:
|
pool_type:
|
||||||
description:
|
description:
|
||||||
- The encap type of C(pool).
|
- The encap type of C(pool).
|
||||||
|
|
|
@ -26,6 +26,12 @@ 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.
|
||||||
options:
|
options:
|
||||||
|
allocation_mode:
|
||||||
|
description:
|
||||||
|
- The method used for allocating VLANs to resources.
|
||||||
|
choices: [ dynamic, static]
|
||||||
|
required: yes
|
||||||
|
aliases: [ mode ]
|
||||||
domain:
|
domain:
|
||||||
description:
|
description:
|
||||||
- Name of the domain being associated with the VLAN Pool.
|
- Name of the domain being associated with the VLAN Pool.
|
||||||
|
@ -38,12 +44,6 @@ options:
|
||||||
description:
|
description:
|
||||||
- The name of the pool.
|
- The name of the pool.
|
||||||
aliases: [ pool_name, vlan_pool ]
|
aliases: [ pool_name, vlan_pool ]
|
||||||
pool_allocation_mode:
|
|
||||||
description:
|
|
||||||
- The method used for allocating VLANs to resources.
|
|
||||||
aliases: [ mode ]
|
|
||||||
choices: [ dynamic, static]
|
|
||||||
required: yes
|
|
||||||
state:
|
state:
|
||||||
description:
|
description:
|
||||||
- Use C(present) or C(absent) for adding or removing.
|
- Use C(present) or C(absent) for adding or removing.
|
||||||
|
@ -141,7 +141,7 @@ def main():
|
||||||
argument_spec.update(
|
argument_spec.update(
|
||||||
domain=dict(type='str', aliases=['domain_name', 'domain_profile']),
|
domain=dict(type='str', aliases=['domain_name', 'domain_profile']),
|
||||||
domain_type=dict(type='str', choices=['fc', 'l2dom', 'l3dom', 'phys', 'vmm']),
|
domain_type=dict(type='str', choices=['fc', 'l2dom', 'l3dom', 'phys', 'vmm']),
|
||||||
pool=dict(type='str', aliases=['pool_name']),
|
pool=dict(type='str', aliases=['pool_name', 'vlan_pool']),
|
||||||
pool_allocation_mode=dict(type='str', required=True, aliases=['allocation_mode', 'mode'], choices=['dynamic', 'static']),
|
pool_allocation_mode=dict(type='str', required=True, aliases=['allocation_mode', 'mode'], choices=['dynamic', 'static']),
|
||||||
state=dict(type='str', default='present', choices=['absent', 'present', 'query']),
|
state=dict(type='str', default='present', choices=['absent', 'present', 'query']),
|
||||||
vm_provider=dict(type='str', choices=['microsoft', 'openstack', 'redhat', 'vmware']),
|
vm_provider=dict(type='str', choices=['microsoft', 'openstack', 'redhat', 'vmware']),
|
||||||
|
|
|
@ -28,8 +28,8 @@ options:
|
||||||
description:
|
description:
|
||||||
- The method used for allocating encaps to resources.
|
- The method used for allocating encaps to resources.
|
||||||
- Only vlan and vsan support allocation modes.
|
- Only vlan and vsan support allocation modes.
|
||||||
aliases: [ mode ]
|
|
||||||
choices: [ dynamic, inherit, static]
|
choices: [ dynamic, inherit, static]
|
||||||
|
aliases: [ mode ]
|
||||||
description:
|
description:
|
||||||
description:
|
description:
|
||||||
- Description for the pool range.
|
- Description for the pool range.
|
||||||
|
@ -38,6 +38,12 @@ options:
|
||||||
description:
|
description:
|
||||||
- The name of the pool that the range should be assigned to.
|
- The name of the pool that the range should be assigned to.
|
||||||
aliases: [ pool_name ]
|
aliases: [ pool_name ]
|
||||||
|
pool_allocation_mode:
|
||||||
|
description:
|
||||||
|
- The method used for allocating encaps to resources.
|
||||||
|
- Only vlan and vsan support allocation modes.
|
||||||
|
choices: [ dynamic, static]
|
||||||
|
aliases: [ pool_mode ]
|
||||||
pool_type:
|
pool_type:
|
||||||
description:
|
description:
|
||||||
- The encap type of C(pool).
|
- The encap type of C(pool).
|
||||||
|
|
|
@ -33,7 +33,7 @@ options:
|
||||||
description:
|
description:
|
||||||
- Name of an existing application network profile, that will contain the EPGs.
|
- Name of an existing application network profile, that will contain the EPGs.
|
||||||
required: yes
|
required: yes
|
||||||
aliases: [ app_proifle, app_profile_name ]
|
aliases: [ app_profile, app_profile_name ]
|
||||||
epg:
|
epg:
|
||||||
description:
|
description:
|
||||||
- Name of the end point group.
|
- Name of the end point group.
|
||||||
|
|
|
@ -64,7 +64,7 @@ options:
|
||||||
epg:
|
epg:
|
||||||
description:
|
description:
|
||||||
- Name of the end point group.
|
- Name of the end point group.
|
||||||
aliases: [ epg_name ]
|
aliases: [ epg_name, name ]
|
||||||
netflow:
|
netflow:
|
||||||
description:
|
description:
|
||||||
- Determines if netflow should be enabled.
|
- Determines if netflow should be enabled.
|
||||||
|
|
|
@ -40,6 +40,11 @@ options:
|
||||||
description:
|
description:
|
||||||
- The name of the pool that the encap block should be assigned to.
|
- The name of the pool that the encap block should be assigned to.
|
||||||
aliases: [ pool_name ]
|
aliases: [ pool_name ]
|
||||||
|
pool_allocation_mode:
|
||||||
|
description:
|
||||||
|
- The method used for allocating encaps to resources.
|
||||||
|
choices: [ dynamic, static]
|
||||||
|
aliases: [ pool_mode ]
|
||||||
block_end:
|
block_end:
|
||||||
description:
|
description:
|
||||||
- The end of encap block.
|
- The end of encap block.
|
||||||
|
@ -47,7 +52,7 @@ options:
|
||||||
block_name:
|
block_name:
|
||||||
description:
|
description:
|
||||||
- The name to give to the encap block.
|
- The name to give to the encap block.
|
||||||
aliases: [ name, range ]
|
aliases: [ name ]
|
||||||
block_start:
|
block_start:
|
||||||
description:
|
description:
|
||||||
- The start of the encap block.
|
- The start of the encap block.
|
||||||
|
|
|
@ -45,6 +45,7 @@ options:
|
||||||
description:
|
description:
|
||||||
description:
|
description:
|
||||||
- The description for the VRF.
|
- The description for the VRF.
|
||||||
|
aliases: [ descr ]
|
||||||
state:
|
state:
|
||||||
description:
|
description:
|
||||||
- Use C(present) or C(absent) for adding or removing.
|
- Use C(present) or C(absent) for adding or removing.
|
||||||
|
|
Loading…
Reference in a new issue