mirror of
https://github.com/ansible-collections/community.general.git
synced 2026-05-07 22:02:50 +00: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:
@@ -30,35 +30,24 @@ options:
|
||||
name:
|
||||
description:
|
||||
- Name that has to be given to the port.
|
||||
required: false
|
||||
default: None
|
||||
fixed_ips:
|
||||
description:
|
||||
- Desired IP and/or subnet for this port. Subnet is referenced by
|
||||
subnet_id and IP is referenced by ip_address.
|
||||
required: false
|
||||
default: None
|
||||
admin_state_up:
|
||||
description:
|
||||
- Sets admin state.
|
||||
required: false
|
||||
default: None
|
||||
mac_address:
|
||||
description:
|
||||
- MAC address of this port.
|
||||
required: false
|
||||
default: None
|
||||
security_groups:
|
||||
description:
|
||||
- Security group(s) ID(s) or name(s) associated with the port (comma
|
||||
separated string or YAML list)
|
||||
required: false
|
||||
default: None
|
||||
no_security_groups:
|
||||
description:
|
||||
- Do not associate a security group with this port.
|
||||
required: false
|
||||
default: False
|
||||
default: 'no'
|
||||
allowed_address_pairs:
|
||||
description:
|
||||
- "Allowed address pairs list. Allowed address pairs are supported with
|
||||
@@ -67,8 +56,6 @@ options:
|
||||
- ip_address: 10.1.0.12
|
||||
mac_address: ab:cd:ef:12:34:56
|
||||
- ip_address: ..."
|
||||
required: false
|
||||
default: None
|
||||
extra_dhcp_opts:
|
||||
description:
|
||||
- "Extra dhcp options to be assigned to this port. Extra options are
|
||||
@@ -77,18 +64,12 @@ options:
|
||||
- opt_name: opt name1
|
||||
opt_value: value1
|
||||
- opt_name: ..."
|
||||
required: false
|
||||
default: None
|
||||
device_owner:
|
||||
description:
|
||||
- The ID of the entity that uses this port.
|
||||
required: false
|
||||
default: None
|
||||
device_id:
|
||||
description:
|
||||
- Device ID of device using this port.
|
||||
required: false
|
||||
default: None
|
||||
state:
|
||||
description:
|
||||
- Should the resource be present or absent.
|
||||
@@ -97,7 +78,6 @@ options:
|
||||
availability_zone:
|
||||
description:
|
||||
- Ignored. Present for backwards compatibility
|
||||
required: false
|
||||
'''
|
||||
|
||||
EXAMPLES = '''
|
||||
|
||||
Reference in New Issue
Block a user