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
|
@ -50,7 +50,6 @@ options:
|
|||
NOTE Host and Hostgroup tasks should always be performed via delegate_to: localhost. There are no benefits to running these tasks on the
|
||||
remote host and doing so will typically cause problems.
|
||||
required: true
|
||||
default: null
|
||||
choices: ['collector', 'host', 'datsource', 'hostgroup']
|
||||
action:
|
||||
description:
|
||||
|
@ -60,94 +59,76 @@ options:
|
|||
- "Update: Update properties, description, or groups (target=host) for an object in your LogicMonitor account."
|
||||
- "SDT: Schedule downtime for an object in your LogicMonitor account."
|
||||
required: true
|
||||
default: null
|
||||
choices: ['add', 'remove', 'update', 'sdt']
|
||||
company:
|
||||
description:
|
||||
- The LogicMonitor account company name. If you would log in to your account at "superheroes.logicmonitor.com" you would use "superheroes."
|
||||
required: true
|
||||
default: null
|
||||
user:
|
||||
description:
|
||||
- A LogicMonitor user name. The module will authenticate and perform actions on behalf of this user.
|
||||
required: true
|
||||
default: null
|
||||
password:
|
||||
description:
|
||||
- The password of the specified LogicMonitor user
|
||||
required: true
|
||||
default: null
|
||||
collector:
|
||||
description:
|
||||
- The fully qualified domain name of a collector in your LogicMonitor account.
|
||||
- This is required for the creation of a LogicMonitor host (target=host action=add).
|
||||
- This is required for updating, removing or scheduling downtime for hosts if 'displayname' isn't
|
||||
specified (target=host action=update action=remove action=sdt).
|
||||
required: false
|
||||
default: null
|
||||
hostname:
|
||||
description:
|
||||
- The hostname of a host in your LogicMonitor account, or the desired hostname of a device to manage.
|
||||
- Optional for managing hosts (target=host).
|
||||
required: false
|
||||
default: 'hostname -f'
|
||||
displayname:
|
||||
description:
|
||||
- The display name of a host in your LogicMonitor account or the desired display name of a device to manage.
|
||||
- Optional for managing hosts (target=host).
|
||||
required: false
|
||||
default: 'hostname -f'
|
||||
description:
|
||||
description:
|
||||
- The long text description of the object in your LogicMonitor account.
|
||||
- Optional for managing hosts and host groups (target=host or target=hostgroup; action=add or action=update).
|
||||
required: false
|
||||
default: ""
|
||||
properties:
|
||||
description:
|
||||
- A dictionary of properties to set on the LogicMonitor host or host group.
|
||||
- Optional for managing hosts and host groups (target=host or target=hostgroup; action=add or action=update).
|
||||
- This parameter will add or update existing properties in your LogicMonitor account.
|
||||
required: false
|
||||
default: {}
|
||||
groups:
|
||||
description:
|
||||
- A list of groups that the host should be a member of.
|
||||
- Optional for managing hosts (target=host; action=add or action=update).
|
||||
required: false
|
||||
default: []
|
||||
id:
|
||||
description:
|
||||
- ID of the datasource to target.
|
||||
- Required for management of LogicMonitor datasources (target=datasource).
|
||||
required: false
|
||||
default: null
|
||||
fullpath:
|
||||
description:
|
||||
- The fullpath of the host group object you would like to manage.
|
||||
- Recommend running on a single Ansible host.
|
||||
- Required for management of LogicMonitor host groups (target=hostgroup).
|
||||
required: false
|
||||
default: null
|
||||
alertenable:
|
||||
description:
|
||||
- A boolean flag to turn alerting on or off for an object.
|
||||
- Optional for managing all hosts (action=add or action=update).
|
||||
required: false
|
||||
default: true
|
||||
choices: [true, false]
|
||||
type: bool
|
||||
default: 'yes'
|
||||
starttime:
|
||||
description:
|
||||
- The time that the Scheduled Down Time (SDT) should begin.
|
||||
- Optional for managing SDT (action=sdt).
|
||||
- Y-m-d H:M
|
||||
required: false
|
||||
default: Now
|
||||
duration:
|
||||
description:
|
||||
- The duration (minutes) of the Scheduled Down Time (SDT).
|
||||
- Optional for putting an object into SDT (action=sdt).
|
||||
required: false
|
||||
default: 30
|
||||
...
|
||||
'''
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue