zabbix: improve module doc
This commit is contained in:
parent
9d07fb9618
commit
1eb6c37594
3 changed files with 17 additions and 10 deletions
|
@ -63,24 +63,28 @@ options:
|
|||
default: None
|
||||
status:
|
||||
description:
|
||||
- 'Monitoring status of the host. Possible values are: "enabled" and "disabled".'
|
||||
- 'Monitoring status of the host.
|
||||
required: false
|
||||
choices: ['enabled', 'disabled']
|
||||
default: "enabled"
|
||||
state:
|
||||
description:
|
||||
- 'Possible values are: "present" and "absent". If the host already exists, and the state is "present", it will just to update the host is the associated data is different. "absent" will remove a host if it exists.'
|
||||
- State of the host.
|
||||
- On C(present), it will create if host does not exist or update the host if the associated data is different.
|
||||
- On C(absent) will remove a host if it exists.
|
||||
required: false
|
||||
choices: ['present', 'absent']
|
||||
default: "present"
|
||||
timeout:
|
||||
description:
|
||||
- The timeout of API request(seconds).
|
||||
- The timeout of API request (seconds).
|
||||
default: 10
|
||||
interfaces:
|
||||
description:
|
||||
- List of interfaces to be created for the host (see example below).
|
||||
- 'Available values are: dns, ip, main, port, type and useip.'
|
||||
- Please review the interface documentation for more information on the supported properties
|
||||
- https://www.zabbix.com/documentation/2.0/manual/appendix/api/hostinterface/definitions#host_interface
|
||||
- 'https://www.zabbix.com/documentation/2.0/manual/appendix/api/hostinterface/definitions#host_interface'
|
||||
required: false
|
||||
default: []
|
||||
'''
|
||||
|
|
|
@ -60,12 +60,15 @@ options:
|
|||
required: true
|
||||
state:
|
||||
description:
|
||||
- 'Possible values are: "present" and "absent". If the macro already exists, and the state is "present", it will just to update the macro if needed.'
|
||||
- State of the macro.
|
||||
- On C(present), it will create if macro does not exist or update the macro if the associated data is different.
|
||||
- On C(absent) will remove a macro if it exists.
|
||||
required: false
|
||||
choices: ['present', 'absent']
|
||||
default: "present"
|
||||
timeout:
|
||||
description:
|
||||
- The timeout of API request(seconds).
|
||||
- The timeout of API request (seconds).
|
||||
default: 10
|
||||
'''
|
||||
|
||||
|
|
|
@ -50,15 +50,15 @@ options:
|
|||
required: true
|
||||
timeout:
|
||||
description:
|
||||
- The timeout of API request(seconds).
|
||||
- The timeout of API request (seconds).
|
||||
default: 10
|
||||
zabbix_screens:
|
||||
description:
|
||||
- List of screens to be created/updated/deleted(see example).
|
||||
- If the screen(s) already been added, the screen(s) name won't be updated.
|
||||
- When creating or updating screen(s), the screen_name, host_group are required.
|
||||
- When deleting screen(s), the screen_name is required.
|
||||
- 'The available states are: present(default) and absent. If the screen(s) already exists, and the state is not "absent", the screen(s) will just be updated as needed.'
|
||||
- When creating or updating screen(s), C(screen_name), C(host_group) are required.
|
||||
- When deleting screen(s), the C(screen_name) is required.
|
||||
- 'The available states are: C(present) (default) and C(absent). If the screen(s) already exists, and the state is not C(absent), the screen(s) will just be updated as needed.'
|
||||
required: true
|
||||
notes:
|
||||
- Too many concurrent updates to the same screen may cause Zabbix to return errors, see examples for a workaround if needed.
|
||||
|
|
Loading…
Reference in a new issue