Improve style and fix typos in the Zabbix module titles and descriptions (#50575)
This commit is contained in:
parent
fc6d85e4cf
commit
9093ca1f3b
8 changed files with 28 additions and 28 deletions
|
@ -16,7 +16,7 @@ ANSIBLE_METADATA = {'metadata_version': '1.1',
|
|||
DOCUMENTATION = '''
|
||||
---
|
||||
module: zabbix_group
|
||||
short_description: Zabbix host groups creates/deletes
|
||||
short_description: Create/delete Zabbix host groups
|
||||
description:
|
||||
- Create host groups if they do not exist.
|
||||
- Delete existing host groups if they exist.
|
||||
|
|
|
@ -16,7 +16,7 @@ ANSIBLE_METADATA = {'metadata_version': '1.1',
|
|||
DOCUMENTATION = '''
|
||||
---
|
||||
module: zabbix_host
|
||||
short_description: Zabbix host creates/updates/deletes
|
||||
short_description: Create/update/delete Zabbix hosts
|
||||
description:
|
||||
- This module allows you to create, modify and delete Zabbix host entries and associated group and template data.
|
||||
version_added: "2.0"
|
||||
|
|
|
@ -16,7 +16,7 @@ ANSIBLE_METADATA = {'metadata_version': '1.1',
|
|||
RETURN = '''
|
||||
---
|
||||
hosts:
|
||||
description: List of Zabbix host. See https://www.zabbix.com/documentation/3.4/manual/api/reference/host/get for list of host values.
|
||||
description: List of Zabbix hosts. See https://www.zabbix.com/documentation/3.4/manual/api/reference/host/get for list of host values.
|
||||
returned: success
|
||||
type: dict
|
||||
sample: [ { "available": "1", "description": "", "disable_until": "0", "error": "", "flags": "0", "groups": ["1"], "host": "Host A", ... } ]
|
||||
|
|
|
@ -16,7 +16,7 @@ ANSIBLE_METADATA = {'metadata_version': '1.1',
|
|||
DOCUMENTATION = '''
|
||||
---
|
||||
module: zabbix_hostmacro
|
||||
short_description: Zabbix host macro creates/updates/deletes
|
||||
short_description: Create/update/delete Zabbix host macros
|
||||
description:
|
||||
- manages Zabbix host macros, it can create, update or delete them.
|
||||
version_added: "2.0"
|
||||
|
|
|
@ -12,7 +12,7 @@ DOCUMENTATION = '''
|
|||
module: zabbix_map
|
||||
author:
|
||||
- "Antony Alekseyev (@Akint)"
|
||||
short_description: Zabbix map creates/updates/deletes
|
||||
short_description: Create/update/delete Zabbix maps
|
||||
description:
|
||||
- "This module allows you to create, modify and delete Zabbix map entries,
|
||||
using Graphviz binaries and text description written in DOT language.
|
||||
|
|
|
@ -28,7 +28,7 @@ ANSIBLE_METADATA = {'metadata_version': '1.1',
|
|||
DOCUMENTATION = '''
|
||||
---
|
||||
module: zabbix_proxy
|
||||
short_description: Zabbix proxy creates/deletes/gets/updates
|
||||
short_description: Create/delete/get/update Zabbix proxies
|
||||
description:
|
||||
- This module allows you to create, modify, get and delete Zabbix proxy entries.
|
||||
version_added: "2.5"
|
||||
|
@ -44,7 +44,7 @@ options:
|
|||
required: true
|
||||
description:
|
||||
description:
|
||||
- Description of the proxy..
|
||||
- Description of the proxy.
|
||||
required: false
|
||||
status:
|
||||
description:
|
||||
|
@ -102,7 +102,7 @@ extends_documentation_fragment:
|
|||
'''
|
||||
|
||||
EXAMPLES = '''
|
||||
- name: Create a new proxy or update an existing proxies info
|
||||
- name: Create a new proxy or update an existing proxy
|
||||
local_action:
|
||||
module: zabbix_proxy
|
||||
server_url: http://monitor.example.com
|
||||
|
|
|
@ -16,7 +16,7 @@ ANSIBLE_METADATA = {'metadata_version': '1.1',
|
|||
DOCUMENTATION = '''
|
||||
---
|
||||
module: zabbix_screen
|
||||
short_description: Zabbix screen creates/updates/deletes
|
||||
short_description: Create/update/delete Zabbix screens
|
||||
description:
|
||||
- This module allows you to create, modify and delete Zabbix screens and associated graph data.
|
||||
version_added: "2.0"
|
||||
|
@ -30,14 +30,14 @@ requirements:
|
|||
options:
|
||||
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), C(screen_name), C(host_group) are required.
|
||||
- When deleting screen(s), the C(screen_name) is required.
|
||||
- Option C(graphs_in_row) will limit columns of screen and make multiple rows (default 3)
|
||||
- List of screens to be created/updated/deleted (see example).
|
||||
- If a screen has already been added, the screen name won't be updated.
|
||||
- When creating or updating a screen, C(screen_name) and C(host_group) are required.
|
||||
- When deleting a screen, the C(screen_name) is required.
|
||||
- Option C(graphs_in_row) will limit columns of a screen and make multiple rows (default 3).
|
||||
- >
|
||||
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.
|
||||
The available states are: C(present) (default) and C(absent). If the screen already exists, and the state is not C(absent), the screen
|
||||
will be updated as needed.
|
||||
required: true
|
||||
|
||||
extends_documentation_fragment:
|
||||
|
|
|
@ -16,9 +16,9 @@ ANSIBLE_METADATA = {'metadata_version': '1.1',
|
|||
DOCUMENTATION = '''
|
||||
---
|
||||
module: zabbix_template
|
||||
short_description: create/delete/dump zabbix template
|
||||
short_description: Create/delete/dump Zabbix template
|
||||
description:
|
||||
- create/delete/dump zabbix template
|
||||
- Create/delete/dump Zabbix template.
|
||||
version_added: "2.5"
|
||||
author:
|
||||
- "sookido (@sookido)"
|
||||
|
@ -29,11 +29,11 @@ requirements:
|
|||
options:
|
||||
template_name:
|
||||
description:
|
||||
- Name of zabbix template
|
||||
- Name of Zabbix template.
|
||||
required: true
|
||||
template_json:
|
||||
description:
|
||||
- JSON dump of template to import
|
||||
- JSON dump of template to import.
|
||||
required: false
|
||||
template_groups:
|
||||
description:
|
||||
|
@ -46,15 +46,15 @@ options:
|
|||
clear_templates:
|
||||
description:
|
||||
- List of templates cleared from the template.
|
||||
- see templates_clear in https://www.zabbix.com/documentation/3.0/manual/api/reference/template/update
|
||||
- See templates_clear in https://www.zabbix.com/documentation/3.0/manual/api/reference/template/update
|
||||
required: false
|
||||
macros:
|
||||
description:
|
||||
- List of templates macro
|
||||
- List of template macros.
|
||||
required: false
|
||||
state:
|
||||
description:
|
||||
- state present create/update template, absent delete template
|
||||
- 'State: present - create/update template; absent - delete template'
|
||||
required: false
|
||||
choices: [present, absent, dump]
|
||||
default: "present"
|
||||
|
@ -65,7 +65,7 @@ extends_documentation_fragment:
|
|||
|
||||
EXAMPLES = '''
|
||||
---
|
||||
# Creates a new zabbix template from linked template
|
||||
# Creates a new Zabbix template from linked template
|
||||
- name: Create Zabbix template using linked template
|
||||
local_action:
|
||||
module: zabbix_template
|
||||
|
@ -92,8 +92,8 @@ EXAMPLES = '''
|
|||
value: 'Example'
|
||||
state: present
|
||||
|
||||
# Create a new template from a json config definition
|
||||
- name: Import Zabbix json template configuration
|
||||
# Create a new template from a JSON config definition
|
||||
- name: Import Zabbix JSON template configuration
|
||||
local_action:
|
||||
module: zabbix_template
|
||||
server_url: http://127.0.0.1
|
||||
|
@ -106,7 +106,7 @@ EXAMPLES = '''
|
|||
state: present
|
||||
|
||||
# Import a template from Ansible variable dict
|
||||
- name: Import Zabbix Template
|
||||
- name: Import Zabbix template
|
||||
zabbix_template:
|
||||
login_user: username
|
||||
login_password: password
|
||||
|
@ -149,7 +149,7 @@ EXAMPLES = '''
|
|||
template_name: Template
|
||||
state: absent
|
||||
|
||||
# Export template json definition
|
||||
# Export template JSON definition
|
||||
- name: Dump Zabbix template
|
||||
local_action:
|
||||
module: zabbix_template
|
||||
|
|
Loading…
Reference in a new issue