wbrawner/ansible
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

zabbix: improve module doc

Browse source
This commit is contained in:
Rene Moser 2015-05-26 15:34:35 +02:00 committed by Matt Clay
parent 47eab56280
commit b985c4d6a4
3 changed files with 19 additions and 12 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
lib/ansible/modules/extras/monitoring/zabbix_host.py
View file

@ -60,24 +60,28 @@ options:
default: None default: None
status: status:
description: description:
- 'Monitoring status of the host. Possible values are: "enabled" and "disabled".' - 'Monitoring status of the host.
required: false required: false
choices: ['enabled', 'disabled']
default: "enabled" default: "enabled"
state: state:
description: 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 required: false
choices: ['present', 'absent']
default: "present" default: "present"
timeout: timeout:
description: description:
- The timeout of API request(seconds). - The timeout of API request (seconds).
default: 10 default: 10
interfaces: interfaces:
description: description:
- List of interfaces to be created for the host (see example below). - List of interfaces to be created for the host (see example below).
- Available values are: dns, ip, main, port, type and useip. - 'Available values are: dns, ip, main, port, type and useip.'
- Please review the interface documentation for more information on the supported properties: - 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 required: false
default: [] default: []
''' '''

7
lib/ansible/modules/extras/monitoring/zabbix_hostmacro.py
View file

@ -58,12 +58,15 @@ options:
required: true required: true
state: state:
description: 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 required: false
choices: ['present', 'absent']
default: "present" default: "present"
timeout: timeout:
description: description:
- The timeout of API request(seconds). - The timeout of API request (seconds).
default: 10 default: 10
''' '''

8
lib/ansible/modules/extras/monitoring/zabbix_screen.py
View file

@ -47,15 +47,15 @@ options:
required: true required: true
timeout: timeout:
description: description:
- The timeout of API request(seconds). - The timeout of API request (seconds).
default: 10 default: 10
zabbix_screens: zabbix_screens:
description: description:
- List of screens to be created/updated/deleted(see example). - 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. - 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 creating or updating screen(s), C(screen_name), C(host_group) are required.
- When deleting screen(s), the screen_name is required. - When deleting screen(s), the C(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.' - '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 required: true
notes: notes:
- Too many concurrent updates to the same screen may cause Zabbix to return errors, see examples for a workaround if needed. - Too many concurrent updates to the same screen may cause Zabbix to return errors, see examples for a workaround if needed.