mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-04-25 11:51:26 -07:00
Clean up module documentation (#36909)
* Clean up module documentation This PR includes: - Removal of `default: None` (and variations) - Removal of `required: false` - Fixing booleans and `type: bool` where required * Fix remaining (new) validation issues
This commit is contained in:
parent
58eb2e849d
commit
cdd21e2170
624 changed files with 1458 additions and 9114 deletions
|
@ -28,204 +28,150 @@ description:
|
|||
- "On Ubuntu and Debian like systems, install dependencies as 'apt-get install -y libnm-glib-dev'"
|
||||
options:
|
||||
state:
|
||||
required: True
|
||||
choices: [ present, absent ]
|
||||
description:
|
||||
- Whether the device should exist or not, taking action if the state is different from what is stated.
|
||||
required: True
|
||||
choices: [ present, absent ]
|
||||
autoconnect:
|
||||
required: False
|
||||
default: "yes"
|
||||
type: bool
|
||||
description:
|
||||
- Whether the connection should start on boot.
|
||||
- Whether the connection profile can be automatically activated
|
||||
type: bool
|
||||
default: 'yes'
|
||||
conn_name:
|
||||
required: True
|
||||
description:
|
||||
- 'Where conn_name will be the name used to call the connection. when not provided a default name is generated: <type>[-<ifname>][-<num>]'
|
||||
required: True
|
||||
ifname:
|
||||
required: False
|
||||
default: conn_name
|
||||
description:
|
||||
- Where IFNAME will be the what we call the interface name.
|
||||
- interface to bind the connection to. The connection will only be applicable to this interface name.
|
||||
- A special value of "*" can be used for interface-independent connections.
|
||||
- The ifname argument is mandatory for all connection types except bond, team, bridge and vlan.
|
||||
default: conn_name
|
||||
type:
|
||||
required: False
|
||||
choices: [ ethernet, team, team-slave, bond, bond-slave, bridge, bridge-slave, vlan, generic ]
|
||||
description:
|
||||
- This is the type of device or network connection that you wish to create or modify.
|
||||
- "type C(generic) is added in version 2.5."
|
||||
choices: [ ethernet, team, team-slave, bond, bond-slave, bridge, bridge-slave, vlan, generic ]
|
||||
mode:
|
||||
required: False
|
||||
choices: [ "balance-rr", "active-backup", "balance-xor", "broadcast", "802.3ad", "balance-tlb", "balance-alb" ]
|
||||
default: balence-rr
|
||||
description:
|
||||
- This is the type of device or network connection that you wish to create for a bond, team or bridge.
|
||||
choices: [ "balance-rr", "active-backup", "balance-xor", "broadcast", "802.3ad", "balance-tlb", "balance-alb" ]
|
||||
default: balence-rr
|
||||
master:
|
||||
required: False
|
||||
default: None
|
||||
description:
|
||||
- master <master (ifname, or connection UUID or conn_name) of bridge, team, bond master connection profile.
|
||||
ip4:
|
||||
required: False
|
||||
default: None
|
||||
description:
|
||||
- 'The IPv4 address to this interface using this format ie: "192.0.2.24/24"'
|
||||
gw4:
|
||||
required: False
|
||||
description:
|
||||
- 'The IPv4 gateway for this interface using this format ie: "192.0.2.1"'
|
||||
dns4:
|
||||
required: False
|
||||
default: None
|
||||
description:
|
||||
- 'A list of upto 3 dns servers, ipv4 format e.g. To add two IPv4 DNS server addresses: "192.0.2.53 198.51.100.53"'
|
||||
dns4_search:
|
||||
required: False
|
||||
default: None
|
||||
description:
|
||||
- 'A list of DNS search domains.'
|
||||
version_added: 2.5
|
||||
ip6:
|
||||
required: False
|
||||
default: None
|
||||
description:
|
||||
- 'The IPv6 address to this interface using this format ie: "abbe::cafe"'
|
||||
gw6:
|
||||
required: False
|
||||
default: None
|
||||
description:
|
||||
- 'The IPv6 gateway for this interface using this format ie: "2001:db8::1"'
|
||||
dns6:
|
||||
required: False
|
||||
description:
|
||||
- 'A list of upto 3 dns servers, ipv6 format e.g. To add two IPv6 DNS server addresses: "2001:4860:4860::8888 2001:4860:4860::8844"'
|
||||
dns6_search:
|
||||
required: False
|
||||
default: None
|
||||
description:
|
||||
- 'A list of DNS search domains.'
|
||||
version_added: 2.5
|
||||
mtu:
|
||||
required: False
|
||||
default: 1500
|
||||
description:
|
||||
- The connection MTU, e.g. 9000. This can't be applied when creating the interface and is done once the interface has been created.
|
||||
- Can be used when modifying Team, VLAN, Ethernet (Future plans to implement wifi, pppoe, infiniband)
|
||||
default: 1500
|
||||
dhcp_client_id:
|
||||
required: False
|
||||
default: None
|
||||
description:
|
||||
- DHCP Client Identifier sent to the DHCP server.
|
||||
version_added: "2.5"
|
||||
primary:
|
||||
required: False
|
||||
default: None
|
||||
description:
|
||||
- This is only used with bond and is the primary interface name (for "active-backup" mode), this is the usually the 'ifname'
|
||||
miimon:
|
||||
required: False
|
||||
default: 100
|
||||
description:
|
||||
- This is only used with bond - miimon
|
||||
default: 100
|
||||
downdelay:
|
||||
required: False
|
||||
default: None
|
||||
description:
|
||||
- This is only used with bond - downdelay
|
||||
updelay:
|
||||
required: False
|
||||
default: None
|
||||
description:
|
||||
- This is only used with bond - updelay
|
||||
arp_interval:
|
||||
required: False
|
||||
default: None
|
||||
description:
|
||||
- This is only used with bond - ARP interval
|
||||
arp_ip_target:
|
||||
required: False
|
||||
default: None
|
||||
description:
|
||||
- This is only used with bond - ARP IP target
|
||||
stp:
|
||||
type: bool
|
||||
default: None
|
||||
description:
|
||||
- This is only used with bridge and controls whether Spanning Tree Protocol (STP) is enabled for this bridge
|
||||
type: bool
|
||||
priority:
|
||||
required: False
|
||||
default: 128
|
||||
description:
|
||||
- This is only used with 'bridge' - sets STP priority
|
||||
default: 128
|
||||
forwarddelay:
|
||||
required: False
|
||||
default: 15
|
||||
description:
|
||||
- This is only used with bridge - [forward-delay <2-30>] STP forwarding delay, in seconds
|
||||
default: 15
|
||||
hellotime:
|
||||
required: False
|
||||
default: 2
|
||||
description:
|
||||
- This is only used with bridge - [hello-time <1-10>] STP hello time, in seconds
|
||||
default: 2
|
||||
maxage:
|
||||
required: False
|
||||
default: 20
|
||||
description:
|
||||
- This is only used with bridge - [max-age <6-42>] STP maximum message age, in seconds
|
||||
default: 20
|
||||
ageingtime:
|
||||
required: False
|
||||
default: 300
|
||||
description:
|
||||
- This is only used with bridge - [ageing-time <0-1000000>] the Ethernet MAC address aging time, in seconds
|
||||
default: 300
|
||||
mac:
|
||||
required: False
|
||||
default: None
|
||||
description:
|
||||
- >
|
||||
This is only used with bridge - MAC address of the bridge
|
||||
(note: this requires a recent kernel feature, originally introduced in 3.15 upstream kernel)
|
||||
slavepriority:
|
||||
required: False
|
||||
default: 32
|
||||
description:
|
||||
- This is only used with 'bridge-slave' - [<0-63>] - STP priority of this slave
|
||||
default: 32
|
||||
path_cost:
|
||||
required: False
|
||||
default: 100
|
||||
description:
|
||||
- This is only used with 'bridge-slave' - [<1-65535>] - STP port cost for destinations via this slave
|
||||
default: 100
|
||||
hairpin:
|
||||
required: False
|
||||
default: yes
|
||||
description:
|
||||
- This is only used with 'bridge-slave' - 'hairpin mode' for the slave, which allows frames to be sent back out through the slave the
|
||||
frame was received on.
|
||||
type: bool
|
||||
default: 'yes'
|
||||
vlanid:
|
||||
required: False
|
||||
default: None
|
||||
description:
|
||||
- This is only used with VLAN - VLAN ID in range <0-4095>
|
||||
vlandev:
|
||||
required: False
|
||||
default: None
|
||||
description:
|
||||
- This is only used with VLAN - parent device this VLAN is on, can use ifname
|
||||
flags:
|
||||
required: False
|
||||
default: None
|
||||
description:
|
||||
- This is only used with VLAN - flags
|
||||
ingress:
|
||||
required: False
|
||||
default: None
|
||||
description:
|
||||
- This is only used with VLAN - VLAN ingress priority mapping
|
||||
egress:
|
||||
required: False
|
||||
default: None
|
||||
description:
|
||||
- This is only used with VLAN - VLAN egress priority mapping
|
||||
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue