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

ACI: Add parameter types to module docs (#42893)

* ACI: Add parameter types to module docs

* Update validate-modules ignore list
This commit is contained in:
Dag Wieers 2018-07-17 18:03:55 +02:00 committed by GitHub
parent 58d6044251
commit e899824c49
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
16 changed files with 45 additions and 35 deletions

View file

@ -37,6 +37,7 @@ options:
aaa_password_lifetime: aaa_password_lifetime:
description: description:
- The lifetime of the locally-authenticated user password. - The lifetime of the locally-authenticated user password.
type: int
aaa_password_update_required: aaa_password_update_required:
description: description:
- Whether this account needs password update. - Whether this account needs password update.

View file

@ -47,22 +47,22 @@ options:
- The description to assign to the C(leaf_port_blk) - The description to assign to the C(leaf_port_blk)
from_port: from_port:
description: description:
- The beggining (from range) of the port range block for the leaf access port block. - The beginning (from-range) of the port range block for the leaf access port block.
aliases: [ from, fromPort, from_port_range ] aliases: [ from, fromPort, from_port_range ]
required: yes required: yes
to_port: to_port:
description: description:
- The end (to range) of the port range block for the leaf access port block. - The end (to-range) of the port range block for the leaf access port block.
aliases: [ to, toPort, to_port_range ] aliases: [ to, toPort, to_port_range ]
required: yes required: yes
from_card: from_card:
description: description:
- The beggining (from range) of the card range block for the leaf access port block. - The beginning (from-range) of the card range block for the leaf access port block.
aliases: [ from_card_range ] aliases: [ from_card_range ]
version_added: '2.6' version_added: '2.6'
to_card: to_card:
description: description:
- The end (to range) of the card range block for the leaf access port block. - The end (to-range) of the card range block for the leaf access port block.
aliases: [ to_card_range ] aliases: [ to_card_range ]
version_added: '2.6' version_added: '2.6'
policy_group: policy_group:

View file

@ -247,7 +247,7 @@ def main():
ip_protocol=dict(choices=VALID_IP_PROTOCOLS, type='str'), ip_protocol=dict(choices=VALID_IP_PROTOCOLS, type='str'),
state=dict(type='str', default='present', choices=['absent', 'present', 'query']), state=dict(type='str', default='present', choices=['absent', 'present', 'query']),
stateful=dict(type='bool'), stateful=dict(type='bool'),
tenant=dict(type="str", aliases=['tenant_name']), # Not required for querying all objects tenant=dict(type='str', aliases=['tenant_name']), # Not required for querying all objects
) )
module = AnsibleModule( module = AnsibleModule(

View file

@ -32,6 +32,7 @@ options:
polling_interval: polling_interval:
description: description:
- Polling interval in minutes. - Polling interval in minutes.
type: int
url_protocol: url_protocol:
description: description:
- The Firmware download protocol. - The Firmware download protocol.

View file

@ -40,8 +40,8 @@ options:
vepa: vepa:
description: description:
- Determines if Virtual Ethernet Port Aggregator is disabled or enabled. - Determines if Virtual Ethernet Port Aggregator is disabled or enabled.
- The APIC defaults to C(disabled) when unset during creation. - The APIC defaults to C(no) when unset during creation.
choices: [ disabled, enabled ] type: bool
vlan_scope: vlan_scope:
description: description:
- The scope of the VLAN. - The scope of the VLAN.

View file

@ -35,13 +35,13 @@ options:
receive_state: receive_state:
description: description:
- Enable or disable Receive state. - Enable or disable Receive state.
- The APIC defaults to C(enabled) when unset during creation. - The APIC defaults to C(yes) when unset during creation.
choices: [ disabled, enabled ] type: bool
transmit_state: transmit_state:
description: description:
- Enable or Disable Transmit state. - Enable or Disable Transmit state.
- The APIC defaults to C(enabled) when unset during creation. - The APIC defaults to C(yes) when unset during creation.
choices: [ disabled, enabled ] type: bool
state: state:
description: description:
- Use C(present) or C(absent) for adding or removing. - Use C(present) or C(absent) for adding or removing.

View file

@ -35,8 +35,8 @@ options:
admin_state: admin_state:
description: description:
- Enable or disable admin state. - Enable or disable admin state.
- The APIC defaults to C(enable) when unset during creation. - The APIC defaults to C(yes) when unset during creation.
choices: [ disable, enable ] type: bool
state: state:
description: description:
- Use C(present) or C(absent) for adding or removing. - Use C(present) or C(absent) for adding or removing.

View file

@ -73,6 +73,7 @@ options:
- C(passive) -- The interface does not participate in the OSPF protocol and - C(passive) -- The interface does not participate in the OSPF protocol and
will not establish adjacencies or send routing updates. However the will not establish adjacencies or send routing updates. However the
interface is announced as part of the routing network. interface is announced as part of the routing network.
type: list
choices: [ advert-subnet, bfd, mtu-ignore, passive ] choices: [ advert-subnet, bfd, mtu-ignore, passive ]
dead_interval: dead_interval:
description: description:
@ -84,6 +85,7 @@ options:
routing instability. routing instability.
- Accepted values range between C(1) and C(65535). - Accepted values range between C(1) and C(65535).
- The APIC defaults to C(40) when unset during creation. - The APIC defaults to C(40) when unset during creation.
type: int
hello_interval: hello_interval:
description: description:
- The interval between hello packets that OSPF sends on the interface. - The interval between hello packets that OSPF sends on the interface.
@ -91,6 +93,7 @@ options:
- This value must be the same for all routers and access servers on a specific network. - This value must be the same for all routers and access servers on a specific network.
- Accepted values range between C(1) and C(65535). - Accepted values range between C(1) and C(65535).
- The APIC defaults to C(10) when unset during creation. - The APIC defaults to C(10) when unset during creation.
type: int
prefix_suppression: prefix_suppression:
description: description:
- Whether prefix suppressions is enabled or disabled. - Whether prefix suppressions is enabled or disabled.
@ -101,6 +104,7 @@ options:
- The priority for the OSPF interface profile. - The priority for the OSPF interface profile.
- Accepted values ranges between C(0) and C(255). - Accepted values ranges between C(0) and C(255).
- The APIC defaults to C(1) when unset during creation. - The APIC defaults to C(1) when unset during creation.
type: int
retransmit_interval: retransmit_interval:
description: description:
- The interval between LSA retransmissions. - The interval between LSA retransmissions.
@ -108,6 +112,7 @@ options:
- If no acknowlegment is received at the end of the interval, then the LSA is resent. - If no acknowlegment is received at the end of the interval, then the LSA is resent.
- Accepted values range between C(1) and C(65535). - Accepted values range between C(1) and C(65535).
- The APIC defaults to C(5) when unset during creation. - The APIC defaults to C(5) when unset during creation.
type: int
transmit_delay: transmit_delay:
description: description:
- The delay time needed to send an LSA update packet. - The delay time needed to send an LSA update packet.
@ -115,6 +120,7 @@ options:
- You should take into account the transmission and propagation delays for the interface when you set this value. - You should take into account the transmission and propagation delays for the interface when you set this value.
- Accepted values range between C(1) and C(450). - Accepted values range between C(1) and C(450).
- The APIC defaults to C(1) when unset during creation. - The APIC defaults to C(1) when unset during creation.
type: int
state: state:
description: description:
- Use C(present) or C(absent) for adding or removing. - Use C(present) or C(absent) for adding or removing.

View file

@ -34,13 +34,13 @@ options:
aliases: [ descr ] aliases: [ descr ]
max_links: max_links:
description: description:
- Maximum links (range 1-16). - Maximum links.
- Accepted values range between 1 and 16. - Accepted values range between 1 and 16.
- The APIC defaults to C(16) when unset during creation. - The APIC defaults to C(16) when unset during creation.
type: int type: int
min_links: min_links:
description: description:
- Minimum links (range 1-16). - Minimum links.
- Accepted values range between 1 and 16. - Accepted values range between 1 and 16.
- The APIC defaults to C(1) when unset during creation. - The APIC defaults to C(1) when unset during creation.
type: int type: int

View file

@ -34,8 +34,10 @@ options:
aliases: [ descr ] aliases: [ descr ]
max_end_points: max_end_points:
description: description:
- Maximum number of end points (range 0-12000). - Maximum number of end points.
- Accepted values range between C(0) and C(12000).
- The APIC defaults to C(0) when unset during creation. - The APIC defaults to C(0) when unset during creation.
type: int
state: state:
description: description:
- Use C(present) or C(absent) for adding or removing. - Use C(present) or C(absent) for adding or removing.

View file

@ -41,8 +41,10 @@ options:
aliases: [ tenant_name ] aliases: [ tenant_name ]
tag: tag:
description: description:
- The value of the route tag (range 0-4294967295). - The value of the route tag.
- Accepted values range between C(0) and C(4294967295).
- The APIC defaults to C(4294967295) when unset during creation. - The APIC defaults to C(4294967295) when unset during creation.
type: int
state: state:
description: description:
- Use C(present) or C(absent) for adding or removing. - Use C(present) or C(absent) for adding or removing.

View file

@ -63,6 +63,7 @@ options:
of the HTTP request being sent to the ACI fabric. of the HTTP request being sent to the ACI fabric.
- If you require a templated payload, use the C(content) parameter - If you require a templated payload, use the C(content) parameter
together with the C(template) lookup plugin, or use M(template). together with the C(template) lookup plugin, or use M(template).
type: path
aliases: [ config_file ] aliases: [ config_file ]
extends_documentation_fragment: aci extends_documentation_fragment: aci
''' '''

View file

@ -32,9 +32,9 @@ options:
protection_group_id: protection_group_id:
description: description:
- The Explicit vPC Protection Group ID. - The Explicit vPC Protection Group ID.
required: yes
type: int type: int
aliases: [ id ] aliases: [ id ]
required: yes
vpc_domain_policy: vpc_domain_policy:
description: description:
- The vPC domain policy to be associated with the Explicit vPC Protection Group. - The vPC domain policy to be associated with the Explicit vPC Protection Group.
@ -42,13 +42,13 @@ options:
switch_1_id: switch_1_id:
description: description:
- The ID of the first Leaf Switch for the Explicit vPC Protection Group. - The ID of the first Leaf Switch for the Explicit vPC Protection Group.
type: int
required: yes required: yes
type: int
switch_2_id: switch_2_id:
description: description:
- The ID of the Second Leaf Switch for the Explicit vPC Protection Group. - The ID of the Second Leaf Switch for the Explicit vPC Protection Group.
type: int
required: yes required: yes
type: int
state: state:
description: description:
- Use C(present) or C(absent) for adding or removing. - Use C(present) or C(absent) for adding or removing.

View file

@ -35,8 +35,8 @@ options:
aliases: [ epr_name, name ] aliases: [ epr_name, name ]
bounce_age: bounce_age:
description: description:
- Bounce Entry Aging Interval (range 150secs - 65535secs) - Bounce entry aging interval in seconds.
- 0 is used for infinite. - Accepted values range between C(150) and C(65535); 0 is used for infinite.
- The APIC defaults to C(630) when unset during creation. - The APIC defaults to C(630) when unset during creation.
type: int type: int
bounce_trigger: bounce_trigger:
@ -46,25 +46,26 @@ options:
choices: [ coop, flood ] choices: [ coop, flood ]
hold_interval: hold_interval:
description: description:
- Hold Interval (range 5secs - 65535secs). - Hold interval in seconds.
- Accepted values range between C(5) and C(65535).
- The APIC defaults to C(300) when unset during creation. - The APIC defaults to C(300) when unset during creation.
type: int type: int
local_ep_interval: local_ep_interval:
description: description:
- Local end point Aging Interval (range 120secs - 65535secs). - Local end point aging interval in seconds.
- 0 is used for infinite. - Accepted values range between C(120) and C(65535); 0 is used for infinite.
- The APIC defaults to C(900) when unset during creation. - The APIC defaults to C(900) when unset during creation.
type: int type: int
remote_ep_interval: remote_ep_interval:
description: description:
- Remote end point Aging Interval (range 120secs - 65535secs). - Remote end point aging interval in seconds.
- O is used for infinite. - Accepted values range between C(120) and C(65535); 0 is used for infinite.
- The APIC defaults to C(300) when unset during creation. - The APIC defaults to C(300) when unset during creation.
type: int type: int
move_frequency: move_frequency:
description: description:
- Move frequency per second (range 0secs - 65535secs). - Move frequency per second.
- 0 is used for none. - Accepted values range between C(0) and C(65535); 0 is used for none.
- The APIC defaults to C(256) when unset during creation. - The APIC defaults to C(256) when unset during creation.
type: int type: int
description: description:

View file

@ -28,8 +28,8 @@ options:
admin_state: admin_state:
description: description:
- Enable or disable the span sources. - Enable or disable the span sources.
- The APIC defaults to C(enabled) when unset during creation. - The APIC defaults to C(yes) when unset during creation.
choices: [ enabled, disabled ] type: bool
description: description:
description: description:
- The description for Span source group. - The description for Span source group.

View file

@ -675,10 +675,6 @@ lib/ansible/modules/net_tools/snmp_facts.py E322
lib/ansible/modules/net_tools/snmp_facts.py E324 lib/ansible/modules/net_tools/snmp_facts.py E324
lib/ansible/modules/network/a10/a10_server_axapi3.py E326 lib/ansible/modules/network/a10/a10_server_axapi3.py E326
lib/ansible/modules/network/a10/a10_virtual_server.py E324 lib/ansible/modules/network/a10/a10_virtual_server.py E324
lib/ansible/modules/network/aci/aci_interface_policy_l2.py E326
lib/ansible/modules/network/aci/aci_interface_policy_lldp.py E326
lib/ansible/modules/network/aci/aci_interface_policy_mcp.py E326
lib/ansible/modules/network/aci/aci_tenant_span_src_group.py E326
lib/ansible/modules/network/aos/_aos_blueprint_param.py E325 lib/ansible/modules/network/aos/_aos_blueprint_param.py E325
lib/ansible/modules/network/asa/asa_config.py E324 lib/ansible/modules/network/asa/asa_config.py E324
lib/ansible/modules/network/bigswitch/bigmon_policy.py E324 lib/ansible/modules/network/bigswitch/bigmon_policy.py E324