zabbix: Move commonly used docs to doc fragments (#31833)
* Move commonly used configuration parameter documentation for zabbix_*-modules to cental doc fragment * fix indentation
This commit is contained in:
parent
ee4e1be7cd
commit
0a89873df9
6 changed files with 30 additions and 150 deletions
|
@ -29,42 +29,12 @@ requirements:
|
|||
- "python >= 2.6"
|
||||
- zabbix-api
|
||||
options:
|
||||
server_url:
|
||||
description:
|
||||
- Url of Zabbix server, with protocol (http or https).
|
||||
C(url) is an alias for C(server_url).
|
||||
required: true
|
||||
aliases: [ "url" ]
|
||||
login_user:
|
||||
description:
|
||||
- Zabbix user name.
|
||||
required: true
|
||||
login_password:
|
||||
description:
|
||||
- Zabbix user password.
|
||||
required: true
|
||||
http_login_user:
|
||||
description:
|
||||
- Basic Auth login
|
||||
required: false
|
||||
default: None
|
||||
version_added: "2.1"
|
||||
http_login_password:
|
||||
description:
|
||||
- Basic Auth password
|
||||
required: false
|
||||
default: None
|
||||
version_added: "2.1"
|
||||
state:
|
||||
description:
|
||||
- Create or delete host group.
|
||||
required: false
|
||||
default: "present"
|
||||
choices: [ "present", "absent" ]
|
||||
timeout:
|
||||
description:
|
||||
- The timeout of API request(seconds).
|
||||
default: 10
|
||||
host_groups:
|
||||
description:
|
||||
- List of host groups to create or delete.
|
||||
|
|
|
@ -29,31 +29,6 @@ requirements:
|
|||
- "python >= 2.6"
|
||||
- "zabbix-api >= 0.5.3"
|
||||
options:
|
||||
server_url:
|
||||
description:
|
||||
- Url of Zabbix server, with protocol (http or https).
|
||||
required: true
|
||||
aliases: [ "url" ]
|
||||
login_user:
|
||||
description:
|
||||
- Zabbix user name, used to authenticate against the server.
|
||||
required: true
|
||||
login_password:
|
||||
description:
|
||||
- Zabbix user password.
|
||||
required: true
|
||||
http_login_user:
|
||||
description:
|
||||
- Basic Auth login
|
||||
required: false
|
||||
default: None
|
||||
version_added: "2.1"
|
||||
http_login_password:
|
||||
description:
|
||||
- Basic Auth password
|
||||
required: false
|
||||
default: None
|
||||
version_added: "2.1"
|
||||
host_name:
|
||||
description:
|
||||
- Name of the host in Zabbix.
|
||||
|
@ -99,10 +74,6 @@ options:
|
|||
required: false
|
||||
choices: ['present', 'absent']
|
||||
default: "present"
|
||||
timeout:
|
||||
description:
|
||||
- The timeout of API request (seconds).
|
||||
default: 10
|
||||
proxy:
|
||||
description:
|
||||
- The name of the Zabbix Proxy to be used
|
||||
|
|
|
@ -27,31 +27,6 @@ requirements:
|
|||
- "python >= 2.6"
|
||||
- zabbix-api
|
||||
options:
|
||||
server_url:
|
||||
description:
|
||||
- Url of Zabbix server, with protocol (http or https).
|
||||
required: true
|
||||
aliases: [ "url" ]
|
||||
login_user:
|
||||
description:
|
||||
- Zabbix user name.
|
||||
required: true
|
||||
login_password:
|
||||
description:
|
||||
- Zabbix user password.
|
||||
required: true
|
||||
http_login_user:
|
||||
description:
|
||||
- Basic Auth login
|
||||
required: false
|
||||
default: None
|
||||
version_added: "2.1"
|
||||
http_login_password:
|
||||
description:
|
||||
- Basic Auth password
|
||||
required: false
|
||||
default: None
|
||||
version_added: "2.1"
|
||||
host_name:
|
||||
description:
|
||||
- Name of the host.
|
||||
|
@ -72,10 +47,6 @@ options:
|
|||
required: false
|
||||
choices: ['present', 'absent']
|
||||
default: "present"
|
||||
timeout:
|
||||
description:
|
||||
- The timeout of API request (seconds).
|
||||
default: 10
|
||||
|
||||
extends_documentation_fragment:
|
||||
- zabbix
|
||||
|
|
|
@ -31,33 +31,6 @@ options:
|
|||
required: false
|
||||
default: present
|
||||
choices: [ "present", "absent" ]
|
||||
server_url:
|
||||
description:
|
||||
- Url of Zabbix server, with protocol (http or https).
|
||||
C(url) is an alias for C(server_url).
|
||||
required: true
|
||||
default: null
|
||||
aliases: [ "url" ]
|
||||
login_user:
|
||||
description:
|
||||
- Zabbix user name.
|
||||
required: true
|
||||
login_password:
|
||||
description:
|
||||
- Zabbix user password.
|
||||
required: true
|
||||
http_login_user:
|
||||
description:
|
||||
- Basic Auth login
|
||||
required: false
|
||||
default: None
|
||||
version_added: "2.1"
|
||||
http_login_password:
|
||||
description:
|
||||
- Basic Auth password
|
||||
required: false
|
||||
default: None
|
||||
version_added: "2.1"
|
||||
host_names:
|
||||
description:
|
||||
- Hosts to manage maintenance window for.
|
||||
|
@ -97,12 +70,6 @@ options:
|
|||
- Type of maintenance. With data collection, or without.
|
||||
required: false
|
||||
default: "true"
|
||||
timeout:
|
||||
description:
|
||||
- The timeout of API request (seconds).
|
||||
default: 10
|
||||
version_added: "2.1"
|
||||
required: false
|
||||
|
||||
extends_documentation_fragment:
|
||||
- zabbix
|
||||
|
|
|
@ -28,35 +28,6 @@ requirements:
|
|||
- "python >= 2.6"
|
||||
- zabbix-api
|
||||
options:
|
||||
server_url:
|
||||
description:
|
||||
- Url of Zabbix server, with protocol (http or https).
|
||||
required: true
|
||||
aliases: [ "url" ]
|
||||
login_user:
|
||||
description:
|
||||
- Zabbix user name.
|
||||
required: true
|
||||
login_password:
|
||||
description:
|
||||
- Zabbix user password.
|
||||
required: true
|
||||
http_login_user:
|
||||
description:
|
||||
- Basic Auth login
|
||||
required: false
|
||||
default: None
|
||||
version_added: "2.1"
|
||||
http_login_password:
|
||||
description:
|
||||
- Basic Auth password
|
||||
required: false
|
||||
default: None
|
||||
version_added: "2.1"
|
||||
timeout:
|
||||
description:
|
||||
- The timeout of API request (seconds).
|
||||
default: 10
|
||||
screens:
|
||||
description:
|
||||
- List of screens to be created/updated/deleted(see example).
|
||||
|
|
|
@ -21,6 +21,36 @@ class ModuleDocFragment(object):
|
|||
# Standard documentation fragment
|
||||
DOCUMENTATION = '''
|
||||
options:
|
||||
server_url:
|
||||
description:
|
||||
- Url of Zabbix server, with protocol (http or https).
|
||||
C(url) is an alias for C(server_url).
|
||||
required: true
|
||||
aliases: [ "url" ]
|
||||
login_user:
|
||||
description:
|
||||
- Zabbix user name.
|
||||
required: true
|
||||
login_password:
|
||||
description:
|
||||
- Zabbix user password.
|
||||
required: true
|
||||
http_login_user:
|
||||
description:
|
||||
- Basic Auth login
|
||||
required: false
|
||||
default: None
|
||||
version_added: "2.1"
|
||||
http_login_password:
|
||||
description:
|
||||
- Basic Auth password
|
||||
required: false
|
||||
default: None
|
||||
version_added: "2.1"
|
||||
timeout:
|
||||
description:
|
||||
- The timeout of API request(seconds).
|
||||
default: 10
|
||||
validate_certs:
|
||||
required: false
|
||||
description:
|
||||
|
|
Loading…
Reference in a new issue