mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-04-26 20:31:27 -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
|
@ -34,45 +34,31 @@ options:
|
|||
agent_ip:
|
||||
description:
|
||||
- Specifies the IPv4/IPv6 address of an sFlow agent.
|
||||
required: false
|
||||
default: null
|
||||
source_ip:
|
||||
description:
|
||||
- Specifies the source IPv4/IPv6 address of sFlow packets.
|
||||
required: false
|
||||
default: null
|
||||
collector_id:
|
||||
description:
|
||||
- Specifies the ID of an sFlow collector. This ID is used when you specify
|
||||
the collector in subsequent sFlow configuration.
|
||||
required: false
|
||||
default: null
|
||||
choices: ['1', '2']
|
||||
collector_ip:
|
||||
description:
|
||||
- Specifies the IPv4/IPv6 address of the sFlow collector.
|
||||
required: false
|
||||
default: null
|
||||
collector_ip_vpn:
|
||||
description:
|
||||
- Specifies the name of a VPN instance.
|
||||
The value is a string of 1 to 31 case-sensitive characters, spaces not supported.
|
||||
When double quotation marks are used around the string, spaces are allowed in the string.
|
||||
The value C(_public_) is reserved and cannot be used as the VPN instance name.
|
||||
required: false
|
||||
default: null
|
||||
collector_datagram_size:
|
||||
description:
|
||||
- Specifies the maximum length of sFlow packets sent from an sFlow agent to an sFlow collector.
|
||||
The value is an integer, in bytes. It ranges from 1024 to 8100. The default value is 1400.
|
||||
required: false
|
||||
default: null
|
||||
collector_udp_port:
|
||||
description:
|
||||
- Specifies the UDP destination port number of sFlow packets.
|
||||
The value is an integer that ranges from 1 to 65535. The default value is 6343.
|
||||
required: false
|
||||
default: null
|
||||
collector_meth:
|
||||
description:
|
||||
- Configures the device to send sFlow packets through service interfaces,
|
||||
|
@ -83,75 +69,51 @@ options:
|
|||
When the value is meth, the device forwards sFlow packets at the control plane.
|
||||
When the value is enhanced, the device forwards sFlow packets at the forwarding plane to
|
||||
enhance the sFlow packet forwarding capacity.
|
||||
required: false
|
||||
default: null
|
||||
choices: ['meth', 'enhanced']
|
||||
collector_description:
|
||||
description:
|
||||
- Specifies the description of an sFlow collector.
|
||||
The value is a string of 1 to 255 case-sensitive characters without spaces.
|
||||
required: false
|
||||
default: null
|
||||
sflow_interface:
|
||||
description:
|
||||
- Full name of interface for Flow Sampling or Counter.
|
||||
It must be a physical interface, Eth-Trunk, or Layer 2 subinterface.
|
||||
required: false
|
||||
default: null
|
||||
sample_collector:
|
||||
description:
|
||||
- Indicates the ID list of the collector.
|
||||
required: false
|
||||
default: null
|
||||
sample_rate:
|
||||
description:
|
||||
- Specifies the flow sampling rate in the format 1/rate.
|
||||
The value is an integer and ranges from 1 to 4294967295. The default value is 8192.
|
||||
required: false
|
||||
default: null
|
||||
sample_length:
|
||||
description:
|
||||
- Specifies the maximum length of sampled packets.
|
||||
The value is an integer and ranges from 18 to 512, in bytes. The default value is 128.
|
||||
required: false
|
||||
default: null
|
||||
sample_direction:
|
||||
description:
|
||||
- Enables flow sampling in the inbound or outbound direction.
|
||||
required: false
|
||||
default: null
|
||||
choices: ['inbound', 'outbound', 'both']
|
||||
counter_collector:
|
||||
description:
|
||||
- Indicates the ID list of the counter collector.
|
||||
required: false
|
||||
default: null
|
||||
counter_interval:
|
||||
description:
|
||||
- Indicates the counter sampling interval.
|
||||
The value is an integer that ranges from 10 to 4294967295, in seconds. The default value is 20.
|
||||
required: false
|
||||
default: null
|
||||
export_route:
|
||||
description:
|
||||
- Configures the sFlow packets sent by the switch not to carry routing information.
|
||||
required: false
|
||||
default: null
|
||||
choices: ['enable', 'disable']
|
||||
rate_limit:
|
||||
description:
|
||||
- Specifies the rate of sFlow packets sent from a card to the control plane.
|
||||
The value is an integer that ranges from 100 to 1500, in pps.
|
||||
required: false
|
||||
default: null
|
||||
rate_limit_slot:
|
||||
description:
|
||||
- Specifies the slot where the rate of output sFlow packets is limited.
|
||||
If this parameter is not specified, the rate of sFlow packets sent from
|
||||
all cards to the control plane is limited.
|
||||
The value is an integer or a string of characters.
|
||||
required: false
|
||||
default: null
|
||||
forward_enp_slot:
|
||||
description:
|
||||
- Enable the Embedded Network Processor (ENP) chip function.
|
||||
|
@ -160,13 +122,10 @@ options:
|
|||
If you set the sampling interval to be larger than 65535,
|
||||
the switch automatically restores it to 65535.
|
||||
The value is an integer or 'all'.
|
||||
required: false
|
||||
default: null
|
||||
state:
|
||||
description:
|
||||
- Determines whether the config should be present or not
|
||||
on the device.
|
||||
required: false
|
||||
default: present
|
||||
choices: ['present', 'absent']
|
||||
"""
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue