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

Specify default delay (DOCUMENTATION only change) (#30344)

* Specify default delay

Also clarify that tx_rate is in bps

* aggregates -> aggregate
This commit is contained in:
John R Barker 2017-09-14 11:42:20 +01:00 committed by GitHub
parent 4980ebf064
commit 4c9ad00c50
15 changed files with 29 additions and 13 deletions

View file

@ -48,13 +48,13 @@ options:
- List of interfaces that should be associated to the VLAN. - List of interfaces that should be associated to the VLAN.
delay: delay:
description: description:
- Delay the play should wait to check for declaratie intent params values. - Delay the play should wait to check for declarative intent params values.
default: 10 default: 10
aggregate: aggregate:
description: List of VLANs definitions description: List of VLANs definitions.
purge: purge:
description: description:
- Purge VLANs not defined in the aggregates parameter. - Purge VLANs not defined in the I(aggregate) parameter.
default: no default: no
state: state:
description: description:

View file

@ -51,8 +51,13 @@ options:
description: List of VRFs definitions description: List of VRFs definitions
purge: purge:
description: description:
- Purge VRFs not defined in the aggregates parameter. - Purge VRFs not defined in the I(aggregate) parameter.
default: no default: no
delay:
description:
- Time in seconds to wait before checking for the operational state on remote
device. This wait is applicable for operational state arguments.
default: 10
state: state:
description: description:
- State of the VRF configuration. - State of the VRF configuration.

View file

@ -46,15 +46,16 @@ options:
choices: ['full', 'half', 'auto'] choices: ['full', 'half', 'auto']
tx_rate: tx_rate:
description: description:
- Transmit rate. - Transmit rate in bits per second (bps).
rx_rate: rx_rate:
description: description:
- Receiver rate. - Receiver rate in bits per second (bps).
delay: delay:
description: description:
- Time in seconds to wait before checking for the operational state on remote - Time in seconds to wait before checking for the operational state on remote
device. This wait is applicable for operational state argument which are device. This wait is applicable for operational state argument which are
I(state) with values C(up)/C(down), I(tx_rate) and I(rx_rate). I(state) with values C(up)/C(down), I(tx_rate) and I(rx_rate).
default: 10
aggregate: aggregate:
description: List of Interfaces definitions. description: List of Interfaces definitions.
purge: purge:

View file

@ -48,7 +48,7 @@ options:
description: List of link aggregation definitions. description: List of link aggregation definitions.
purge: purge:
description: description:
- Purge link aggregation groups not defined in the aggregates parameter. - Purge link aggregation groups not defined in the I(aggregate) parameter.
default: no default: no
state: state:
description: description:

View file

@ -70,6 +70,7 @@ options:
- Time in seconds to wait before checking for the operational state on remote - Time in seconds to wait before checking for the operational state on remote
device. This wait is applicable for operational state argument which are device. This wait is applicable for operational state argument which are
I(state) with values C(up)/C(down), I(tx_rate) and I(rx_rate). I(state) with values C(up)/C(down), I(tx_rate) and I(rx_rate).
default: 10
state: state:
description: description:
- State of the Interface configuration, C(up) means present and - State of the Interface configuration, C(up) means present and

View file

@ -50,7 +50,7 @@ options:
- Admin distance of the static route. - Admin distance of the static route.
default: 1 default: 1
aggregate: aggregate:
description: List of static route definitions description: List of static route definitions.
state: state:
description: description:
- State of the static route configuration. - State of the static route configuration.

View file

@ -69,6 +69,7 @@ options:
- Time in seconds to wait before checking for the operational state on remote - Time in seconds to wait before checking for the operational state on remote
device. device.
version_added: "2.4" version_added: "2.4"
default: 10
purge: purge:
description: description:
- Instructs the module to consider the - Instructs the module to consider the

View file

@ -58,6 +58,7 @@ options:
- Time in seconds to wait before checking for the operational state on remote - Time in seconds to wait before checking for the operational state on remote
device. This wait is applicable for operational state argument which are device. This wait is applicable for operational state argument which are
I(state) with values C(up)/C(down), I(tx_rate) and I(rx_rate). I(state) with values C(up)/C(down), I(tx_rate) and I(rx_rate).
default: 10
state: state:
description: description:
- State of the Interface configuration, C(up) means present and - State of the Interface configuration, C(up) means present and

View file

@ -66,6 +66,7 @@ options:
- Time in seconds to wait before checking for the operational state on remote - Time in seconds to wait before checking for the operational state on remote
device. This wait is applicable for operational state argument which are device. This wait is applicable for operational state argument which are
I(state) with values C(up)/C(down), I(tx_rate) and I(rx_rate). I(state) with values C(up)/C(down), I(tx_rate) and I(rx_rate).
default: 10
aggregate: aggregate:
description: List of Interfaces definitions. description: List of Interfaces definitions.
state: state:

View file

@ -36,7 +36,7 @@ options:
description: List of VLANs definitions. description: List of VLANs definitions.
purge: purge:
description: description:
- Purge VLANs not defined in the aggregates parameter. - Purge VLANs not defined in the I(aggregate) parameter.
default: no default: no
state: state:
description: description:

View file

@ -36,7 +36,7 @@ options:
description: List of L3 interfaces definitions description: List of L3 interfaces definitions
purge: purge:
description: description:
- Purge L3 interfaces not defined in the aggregates parameter. - Purge L3 interfaces not defined in the I(aggregate) parameter.
default: no default: no
state: state:
description: description:

View file

@ -33,7 +33,7 @@ options:
description: List of VRFs definitions description: List of VRFs definitions
purge: purge:
description: description:
- Purge VRFs not defined in the aggregates parameter. - Purge VRFs not defined in the I(aggregate) parameter.
default: no default: no
state: state:
description: description:

View file

@ -42,7 +42,7 @@ options:
description: List of static route definitions description: List of static route definitions
purge: purge:
description: description:
- Purge static routes not defined in the aggregates parameter. - Purge static routes not defined in the I(aggregate) parameter.
default: no default: no
state: state:
description: description:

View file

@ -41,7 +41,7 @@ options:
description: List of logging definitions. description: List of logging definitions.
purge: purge:
description: description:
- Purge logging not defined in the aggregates parameter. - Purge logging not defined in the I(aggregate) parameter.
default: no default: no
state: state:
description: description:

View file

@ -57,6 +57,12 @@ options:
- Interface link status. - Interface link status.
default: auto default: auto
choices: ['full', 'half', 'auto'] choices: ['full', 'half', 'auto']
delay:
description:
- Time in seconds to wait before checking for the operational state on remote
device. This wait is applicable for operational state argument which are
I(state) with values C(up)/C(down) and I(neighbors).
default: 10
neighbors: neighbors:
description: description:
- Check the operational state of given interface C(name) for LLDP neighbor. - Check the operational state of given interface C(name) for LLDP neighbor.