cmueller/ansible
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Update zabbix_action.py (#50490)

Browse source 
* Add trailing dots for consistency.
* Document how the current host can be specified for "run_on_hosts".

+label: docsite_pr
This commit is contained in:
Richlv 2019-01-03 17:15:21 +02:00 committed by Sandra McCann
parent ae404d1476
commit ff4af614e1
1 changed files with 20 additions and 19 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

39
lib/ansible/modules/monitoring/zabbix/zabbix_action.py
View file

@ -66,7 +66,7 @@ options:
check out Zabbix API documentation U(https://www.zabbix.com/documentation/3.4/manual/api/reference/action/object#action_filter_condition) check out Zabbix API documentation U(https://www.zabbix.com/documentation/3.4/manual/api/reference/action/object#action_filter_condition)
suboptions: suboptions:
type: type:
description: Type (label) of the condition description: Type (label) of the condition.
choices: choices:
# trigger # trigger
- host_group - host_group
@ -105,13 +105,13 @@ options:
description: description:
- Value to compare with. - Value to compare with.
- When I(type) is set to C(discovery_status), the choices - When I(type) is set to C(discovery_status), the choices
are C(up), C(down), C(discovered), C(lost) are C(up), C(down), C(discovered), C(lost).
- When I(type) is set to C(discovery_object), the choices - When I(type) is set to C(discovery_object), the choices
are C(host), C(service) are C(host), C(service).
- When I(type) is set to C(event_type), the choices - When I(type) is set to C(event_type), the choices
are C(item in not supported state), C(item in normal state), are C(item in not supported state), C(item in normal state),
C(LLD rule in not supported state), C(LLD rule in not supported state),
C(LLD rule in normal state), C(trigger in unknown state), C(trigger in normal state) C(LLD rule in normal state), C(trigger in unknown state), C(trigger in normal state).
- Besides the above options, this is usualy either the name - Besides the above options, this is usualy either the name
of the object or a string to compare with. of the object or a string to compare with.
operator: operator:
@ -228,7 +228,7 @@ options:
execute_on: execute_on:
description: description:
- Target on which the custom script operation command will be executed. - Target on which the custom script operation command will be executed.
- Required when I(type=remote_command) and I(command_type=custom_script) - Required when I(type=remote_command) and I(command_type=custom_script).
choices: choices:
- agent - agent
- server - server
@ -236,53 +236,54 @@ options:
run_on_groups: run_on_groups:
description: description:
- Host groups to run remote commands on. - Host groups to run remote commands on.
- Required when I(type=remote_command) if I(run_on_hosts) is not set - Required when I(type=remote_command) if I(run_on_hosts) is not set.
run_on_hosts: run_on_hosts:
description: description:
- Hosts to run remote commands on - Hosts to run remote commands on.
- Required when I(type=remote_command) if I(run_on_groups) is not set - Required when I(type=remote_command) if I(run_on_groups) is not set.
- If set to 0 the command will be run on the current host.
ssh_auth_type: ssh_auth_type:
description: description:
- Authentication method used for SSH commands. - Authentication method used for SSH commands.
- Required when I(type=remote_command) and I(command_type=ssh) - Required when I(type=remote_command) and I(command_type=ssh).
choices: choices:
- password - password
- public_key - public_key
ssh_privatekey_file: ssh_privatekey_file:
description: description:
- Name of the private key file used for SSH commands with public key authentication. - Name of the private key file used for SSH commands with public key authentication.
- Required when I(type=remote_command) and I(command_type=ssh) - Required when I(type=remote_command) and I(command_type=ssh).
ssh_publickey_file: ssh_publickey_file:
description: description:
- Name of the public key file used for SSH commands with public key authentication. - Name of the public key file used for SSH commands with public key authentication.
- Required when I(type=remote_command) and I(command_type=ssh) - Required when I(type=remote_command) and I(command_type=ssh).
username: username:
description: description:
- User name used for authentication. - User name used for authentication.
- Required when I(type=remote_command) and I(command_type in [ssh, telnet]) - Required when I(type=remote_command) and I(command_type in [ssh, telnet]).
password: password:
description: description:
- Password used for authentication. - Password used for authentication.
- Required when I(type=remote_command) and I(command_type in [ssh, telnet]) - Required when I(type=remote_command) and I(command_type in [ssh, telnet]).
port: port:
description: description:
- Port number used for authentication. - Port number used for authentication.
- Required when I(type=remote_command) and I(command_type in [ssh, telnet]) - Required when I(type=remote_command) and I(command_type in [ssh, telnet]).
script_name: script_name:
description: description:
- The name of script used for global script commands. - The name of script used for global script commands.
- Required when I(type=remote_command) and I(command_type=global_script) - Required when I(type=remote_command) and I(command_type=global_script).
recovery_operations: recovery_operations:
type: list type: list
description: description:
- List of recovery operations - List of recovery operations.
- C(Suboptions) are the same as for I(operations) - C(Suboptions) are the same as for I(operations).
- Works only with >= Zabbix 3.2 - Works only with >= Zabbix 3.2
acknowledge_operations: acknowledge_operations:
type: list type: list
description: description:
- List of acknowledge operations - List of acknowledge operations.
- C(Suboptions) are the same as for I(operations) - C(Suboptions) are the same as for I(operations).
- Works only with >= Zabbix 3.4 - Works only with >= Zabbix 3.4
notes: notes: