Skip to content

Commit 652ae14

Browse files
author
Telekom MMS GmbH
committed
update documentation
1 parent 2d3f168 commit 652ae14

41 files changed

Lines changed: 562 additions & 562 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎docs/icinga_command.rst‎

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ Parameters
2727

2828

2929
command (optional, str, None)
30-
The command Icinga should run. Required when state is ``present``.
30+
The command Icinga should run. Required when state is \ :literal:`present`\ .
3131

3232
Absolute paths are accepted as provided, relative paths are prefixed with "PluginDir + ", similar Constant prefixes are allowed.
3333

@@ -77,9 +77,9 @@ Parameters
7777

7878
Each argument can take either a string, a json or a dict
7979

80-
When using a dict as argument value, the following properties are supported. ``skip_key``, ``repeat_key``, ``required``, ``order``, ``description``), ``set_if``, ``value``.
80+
When using a dict as argument value, the following properties are supported. \ :literal:`skip\_key`\ , \ :literal:`repeat\_key`\ , \ :literal:`required`\ , \ :literal:`order`\ , \ :literal:`description`\ ), \ :literal:`set\_if`\ , \ :literal:`value`\ .
8181

82-
The ``value`` property can be either a string, a json or a dict. When used as a dict, you can define its ``type`` as ``Function`` and set its ``body`` property as an Icinga DSL piece of config.
82+
The \ :literal:`value`\ property can be either a string, a json or a dict. When used as a dict, you can define its \ :literal:`type`\ as \ :literal:`Function`\ and set its \ :literal:`body`\ property as an Icinga DSL piece of config.
8383

8484

8585
append (optional, bool, None)
@@ -95,59 +95,59 @@ Parameters
9595

9696

9797
force (optional, bool, False)
98-
If ``yes`` do not get a cached copy.
98+
If \ :literal:`yes`\ do not get a cached copy.
9999

100100

101101
http_agent (optional, str, ansible-httpget)
102102
Header to identify as, generally appears in web server logs.
103103

104104

105105
use_proxy (optional, bool, True)
106-
If ``no``, it will not use a proxy, even if one is defined in an environment variable on the target hosts.
106+
If \ :literal:`no`\ , it will not use a proxy, even if one is defined in an environment variable on the target hosts.
107107

108108

109109
validate_certs (optional, bool, True)
110-
If ``no``, SSL certificates will not be validated.
110+
If \ :literal:`no`\ , SSL certificates will not be validated.
111111

112112
This should only be used on personally controlled sites using self-signed certificates.
113113

114114

115115
url_username (optional, str, None)
116116
The username for use in HTTP basic authentication.
117117

118-
This parameter can be used without *url_password* for sites that allow empty passwords
118+
This parameter can be used without \ :emphasis:`url\_password`\ for sites that allow empty passwords
119119

120120

121121
url_password (optional, str, None)
122122
The password for use in HTTP basic authentication.
123123

124-
If the *url_username* parameter is not specified, the *url_password* parameter will not be used.
124+
If the \ :emphasis:`url\_username`\ parameter is not specified, the \ :emphasis:`url\_password`\ parameter will not be used.
125125

126126

127127
force_basic_auth (optional, bool, False)
128-
Credentials specified with *url_username* and *url_password* should be passed in HTTP Header.
128+
Credentials specified with \ :emphasis:`url\_username`\ and \ :emphasis:`url\_password`\ should be passed in HTTP Header.
129129

130130

131131
client_cert (optional, path, None)
132132
PEM formatted certificate chain file to be used for SSL client authentication.
133133

134-
This file can also include the key as well, and if the key is included, ``client_key`` is not required.
134+
This file can also include the key as well, and if the key is included, \ :literal:`client\_key`\ is not required.
135135

136136

137137
client_key (optional, path, None)
138138
PEM formatted file that contains your private key to be used for SSL client authentication.
139139

140-
If ``client_cert`` contains both the certificate and key, this option is not required.
140+
If \ :literal:`client\_cert`\ contains both the certificate and key, this option is not required.
141141

142142

143143
use_gssapi (optional, bool, False)
144144
Use GSSAPI to perform the authentication, typically this is for Kerberos or Kerberos through Negotiate authentication.
145145

146-
Requires the Python library `gssapi <https://github.com/pythongssapi/python-gssapi>`_ to be installed.
146+
Requires the Python library \ `gssapi <https://github.com/pythongssapi/python-gssapi>`__\ to be installed.
147147

148-
Credentials for GSSAPI can be specified with *url_username*/*url_password* or with the GSSAPI env var ``KRB5CCNAME`` that specified a custom Kerberos credential cache.
148+
Credentials for GSSAPI can be specified with \ :emphasis:`url\_username`\ /\ :emphasis:`url\_password`\ or with the GSSAPI env var \ :literal:`KRB5CCNAME`\ that specified a custom Kerberos credential cache.
149149

150-
NTLM authentication is ``not`` supported even if the GSSAPI mech for NTLM has been installed.
150+
NTLM authentication is \ :literal:`not`\ supported even if the GSSAPI mech for NTLM has been installed.
151151

152152

153153

@@ -169,7 +169,7 @@ Examples
169169

170170

171171
- name: Create command
172-
t_systems_mms.icinga_director.icinga_command:
172+
telekom_mms.icinga_director.icinga_command:
173173
state: present
174174
url: "{{ icinga_url }}"
175175
url_username: "{{ icinga_user }}"
@@ -232,7 +232,7 @@ Examples
232232
snmpv3_user: user
233233

234234
- name: Update command
235-
t_systems_mms.icinga_director.icinga_command:
235+
telekom_mms.icinga_director.icinga_command:
236236
state: present
237237
url: "{{ icinga_url }}"
238238
url_username: "{{ icinga_user }}"
@@ -242,7 +242,7 @@ Examples
242242
append: true
243243

244244
- name: Create event command
245-
t_systems_mms.icinga_director.icinga_command:
245+
telekom_mms.icinga_director.icinga_command:
246246
state: present
247247
url: "{{ icinga_url }}"
248248
url_username: "{{ icinga_user }}"

‎docs/icinga_command_info.rst‎

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ Parameters
2525
query (False, str, )
2626
Text to filter search results.
2727

28-
The text is matched on object_name.
28+
The text is matched on object\_name.
2929

3030
Only objects containing this text will be returned in the resultset.
3131

@@ -45,59 +45,59 @@ Parameters
4545

4646

4747
force (optional, bool, False)
48-
If ``yes`` do not get a cached copy.
48+
If \ :literal:`yes`\ do not get a cached copy.
4949

5050

5151
http_agent (optional, str, ansible-httpget)
5252
Header to identify as, generally appears in web server logs.
5353

5454

5555
use_proxy (optional, bool, True)
56-
If ``no``, it will not use a proxy, even if one is defined in an environment variable on the target hosts.
56+
If \ :literal:`no`\ , it will not use a proxy, even if one is defined in an environment variable on the target hosts.
5757

5858

5959
validate_certs (optional, bool, True)
60-
If ``no``, SSL certificates will not be validated.
60+
If \ :literal:`no`\ , SSL certificates will not be validated.
6161

6262
This should only be used on personally controlled sites using self-signed certificates.
6363

6464

6565
url_username (optional, str, None)
6666
The username for use in HTTP basic authentication.
6767

68-
This parameter can be used without *url_password* for sites that allow empty passwords
68+
This parameter can be used without \ :emphasis:`url\_password`\ for sites that allow empty passwords
6969

7070

7171
url_password (optional, str, None)
7272
The password for use in HTTP basic authentication.
7373

74-
If the *url_username* parameter is not specified, the *url_password* parameter will not be used.
74+
If the \ :emphasis:`url\_username`\ parameter is not specified, the \ :emphasis:`url\_password`\ parameter will not be used.
7575

7676

7777
force_basic_auth (optional, bool, False)
78-
Credentials specified with *url_username* and *url_password* should be passed in HTTP Header.
78+
Credentials specified with \ :emphasis:`url\_username`\ and \ :emphasis:`url\_password`\ should be passed in HTTP Header.
7979

8080

8181
client_cert (optional, path, None)
8282
PEM formatted certificate chain file to be used for SSL client authentication.
8383

84-
This file can also include the key as well, and if the key is included, ``client_key`` is not required.
84+
This file can also include the key as well, and if the key is included, \ :literal:`client\_key`\ is not required.
8585

8686

8787
client_key (optional, path, None)
8888
PEM formatted file that contains your private key to be used for SSL client authentication.
8989

90-
If ``client_cert`` contains both the certificate and key, this option is not required.
90+
If \ :literal:`client\_cert`\ contains both the certificate and key, this option is not required.
9191

9292

9393
use_gssapi (optional, bool, False)
9494
Use GSSAPI to perform the authentication, typically this is for Kerberos or Kerberos through Negotiate authentication.
9595

96-
Requires the Python library `gssapi <https://github.com/pythongssapi/python-gssapi>`_ to be installed.
96+
Requires the Python library \ `gssapi <https://github.com/pythongssapi/python-gssapi>`__\ to be installed.
9797

98-
Credentials for GSSAPI can be specified with *url_username*/*url_password* or with the GSSAPI env var ``KRB5CCNAME`` that specified a custom Kerberos credential cache.
98+
Credentials for GSSAPI can be specified with \ :emphasis:`url\_username`\ /\ :emphasis:`url\_password`\ or with the GSSAPI env var \ :literal:`KRB5CCNAME`\ that specified a custom Kerberos credential cache.
9999

100-
NTLM authentication is ``not`` supported even if the GSSAPI mech for NTLM has been installed.
100+
NTLM authentication is \ :literal:`not`\ supported even if the GSSAPI mech for NTLM has been installed.
101101

102102

103103

@@ -119,7 +119,7 @@ Examples
119119

120120

121121
- name: Query a command in icinga
122-
t_systems_mms.icinga_director.icinga_command_info:
122+
telekom_mms.icinga_director.icinga_command_info:
123123
url: "{{ icinga_url }}"
124124
url_username: "{{ icinga_user }}"
125125
url_password: "{{ icinga_pass }}"

‎docs/icinga_command_template.rst‎

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -77,9 +77,9 @@ Parameters
7777

7878
Each argument can take either a string, a json or a dict
7979

80-
When using a dict as argument value, the following properties are supported. ``skip_key``, ``repeat_key``, ``required``, ``order``, ``description``), ``set_if``, ``value``.
80+
When using a dict as argument value, the following properties are supported. \ :literal:`skip\_key`\ , \ :literal:`repeat\_key`\ , \ :literal:`required`\ , \ :literal:`order`\ , \ :literal:`description`\ ), \ :literal:`set\_if`\ , \ :literal:`value`\ .
8181

82-
The ``value`` property can be either a string, a json or a dict. When used as a dict, you can define its ``type`` as ``Function`` and set its ``body`` property as an Icinga DSL piece of config.
82+
The \ :literal:`value`\ property can be either a string, a json or a dict. When used as a dict, you can define its \ :literal:`type`\ as \ :literal:`Function`\ and set its \ :literal:`body`\ property as an Icinga DSL piece of config.
8383

8484

8585
append (optional, bool, None)
@@ -95,59 +95,59 @@ Parameters
9595

9696

9797
force (optional, bool, False)
98-
If ``yes`` do not get a cached copy.
98+
If \ :literal:`yes`\ do not get a cached copy.
9999

100100

101101
http_agent (optional, str, ansible-httpget)
102102
Header to identify as, generally appears in web server logs.
103103

104104

105105
use_proxy (optional, bool, True)
106-
If ``no``, it will not use a proxy, even if one is defined in an environment variable on the target hosts.
106+
If \ :literal:`no`\ , it will not use a proxy, even if one is defined in an environment variable on the target hosts.
107107

108108

109109
validate_certs (optional, bool, True)
110-
If ``no``, SSL certificates will not be validated.
110+
If \ :literal:`no`\ , SSL certificates will not be validated.
111111

112112
This should only be used on personally controlled sites using self-signed certificates.
113113

114114

115115
url_username (optional, str, None)
116116
The username for use in HTTP basic authentication.
117117

118-
This parameter can be used without *url_password* for sites that allow empty passwords
118+
This parameter can be used without \ :emphasis:`url\_password`\ for sites that allow empty passwords
119119

120120

121121
url_password (optional, str, None)
122122
The password for use in HTTP basic authentication.
123123

124-
If the *url_username* parameter is not specified, the *url_password* parameter will not be used.
124+
If the \ :emphasis:`url\_username`\ parameter is not specified, the \ :emphasis:`url\_password`\ parameter will not be used.
125125

126126

127127
force_basic_auth (optional, bool, False)
128-
Credentials specified with *url_username* and *url_password* should be passed in HTTP Header.
128+
Credentials specified with \ :emphasis:`url\_username`\ and \ :emphasis:`url\_password`\ should be passed in HTTP Header.
129129

130130

131131
client_cert (optional, path, None)
132132
PEM formatted certificate chain file to be used for SSL client authentication.
133133

134-
This file can also include the key as well, and if the key is included, ``client_key`` is not required.
134+
This file can also include the key as well, and if the key is included, \ :literal:`client\_key`\ is not required.
135135

136136

137137
client_key (optional, path, None)
138138
PEM formatted file that contains your private key to be used for SSL client authentication.
139139

140-
If ``client_cert`` contains both the certificate and key, this option is not required.
140+
If \ :literal:`client\_cert`\ contains both the certificate and key, this option is not required.
141141

142142

143143
use_gssapi (optional, bool, False)
144144
Use GSSAPI to perform the authentication, typically this is for Kerberos or Kerberos through Negotiate authentication.
145145

146-
Requires the Python library `gssapi <https://github.com/pythongssapi/python-gssapi>`_ to be installed.
146+
Requires the Python library \ `gssapi <https://github.com/pythongssapi/python-gssapi>`__\ to be installed.
147147

148-
Credentials for GSSAPI can be specified with *url_username*/*url_password* or with the GSSAPI env var ``KRB5CCNAME`` that specified a custom Kerberos credential cache.
148+
Credentials for GSSAPI can be specified with \ :emphasis:`url\_username`\ /\ :emphasis:`url\_password`\ or with the GSSAPI env var \ :literal:`KRB5CCNAME`\ that specified a custom Kerberos credential cache.
149149

150-
NTLM authentication is ``not`` supported even if the GSSAPI mech for NTLM has been installed.
150+
NTLM authentication is \ :literal:`not`\ supported even if the GSSAPI mech for NTLM has been installed.
151151

152152

153153

@@ -169,7 +169,7 @@ Examples
169169

170170

171171
- name: Create command template
172-
t_systems_mms.icinga_director.icinga_command_template:
172+
telekom_mms.icinga_director.icinga_command_template:
173173
state: present
174174
url: "{{ icinga_url }}"
175175
url_username: "{{ icinga_user }}"
@@ -230,7 +230,7 @@ Examples
230230
snmpv3_user: user
231231

232232
- name: Update command template
233-
t_systems_mms.icinga_director.icinga_command_template:
233+
telekom_mms.icinga_director.icinga_command_template:
234234
state: present
235235
url: "{{ icinga_url }}"
236236
url_username: "{{ icinga_user }}"

‎docs/icinga_command_template_info.rst‎

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ Parameters
2525
query (False, str, )
2626
Text to filter search results.
2727

28-
The text is matched on object_name.
28+
The text is matched on object\_name.
2929

3030
Only objects containing this text will be returned in the resultset.
3131

@@ -41,59 +41,59 @@ Parameters
4141

4242

4343
force (optional, bool, False)
44-
If ``yes`` do not get a cached copy.
44+
If \ :literal:`yes`\ do not get a cached copy.
4545

4646

4747
http_agent (optional, str, ansible-httpget)
4848
Header to identify as, generally appears in web server logs.
4949

5050

5151
use_proxy (optional, bool, True)
52-
If ``no``, it will not use a proxy, even if one is defined in an environment variable on the target hosts.
52+
If \ :literal:`no`\ , it will not use a proxy, even if one is defined in an environment variable on the target hosts.
5353

5454

5555
validate_certs (optional, bool, True)
56-
If ``no``, SSL certificates will not be validated.
56+
If \ :literal:`no`\ , SSL certificates will not be validated.
5757

5858
This should only be used on personally controlled sites using self-signed certificates.
5959

6060

6161
url_username (optional, str, None)
6262
The username for use in HTTP basic authentication.
6363

64-
This parameter can be used without *url_password* for sites that allow empty passwords
64+
This parameter can be used without \ :emphasis:`url\_password`\ for sites that allow empty passwords
6565

6666

6767
url_password (optional, str, None)
6868
The password for use in HTTP basic authentication.
6969

70-
If the *url_username* parameter is not specified, the *url_password* parameter will not be used.
70+
If the \ :emphasis:`url\_username`\ parameter is not specified, the \ :emphasis:`url\_password`\ parameter will not be used.
7171

7272

7373
force_basic_auth (optional, bool, False)
74-
Credentials specified with *url_username* and *url_password* should be passed in HTTP Header.
74+
Credentials specified with \ :emphasis:`url\_username`\ and \ :emphasis:`url\_password`\ should be passed in HTTP Header.
7575

7676

7777
client_cert (optional, path, None)
7878
PEM formatted certificate chain file to be used for SSL client authentication.
7979

80-
This file can also include the key as well, and if the key is included, ``client_key`` is not required.
80+
This file can also include the key as well, and if the key is included, \ :literal:`client\_key`\ is not required.
8181

8282

8383
client_key (optional, path, None)
8484
PEM formatted file that contains your private key to be used for SSL client authentication.
8585

86-
If ``client_cert`` contains both the certificate and key, this option is not required.
86+
If \ :literal:`client\_cert`\ contains both the certificate and key, this option is not required.
8787

8888

8989
use_gssapi (optional, bool, False)
9090
Use GSSAPI to perform the authentication, typically this is for Kerberos or Kerberos through Negotiate authentication.
9191

92-
Requires the Python library `gssapi <https://github.com/pythongssapi/python-gssapi>`_ to be installed.
92+
Requires the Python library \ `gssapi <https://github.com/pythongssapi/python-gssapi>`__\ to be installed.
9393

94-
Credentials for GSSAPI can be specified with *url_username*/*url_password* or with the GSSAPI env var ``KRB5CCNAME`` that specified a custom Kerberos credential cache.
94+
Credentials for GSSAPI can be specified with \ :emphasis:`url\_username`\ /\ :emphasis:`url\_password`\ or with the GSSAPI env var \ :literal:`KRB5CCNAME`\ that specified a custom Kerberos credential cache.
9595

96-
NTLM authentication is ``not`` supported even if the GSSAPI mech for NTLM has been installed.
96+
NTLM authentication is \ :literal:`not`\ supported even if the GSSAPI mech for NTLM has been installed.
9797

9898

9999

@@ -115,7 +115,7 @@ Examples
115115

116116

117117
- name: Query a command template in icinga
118-
t_systems_mms.icinga_director.icinga_command_template_info:
118+
telekom_mms.icinga_director.icinga_command_template_info:
119119
url: "{{ icinga_url }}"
120120
url_username: "{{ icinga_user }}"
121121
url_password: "{{ icinga_pass }}"

0 commit comments

Comments
 (0)