1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
|
# -*- coding: utf-8 -*-
# Copyright: (c) 2018, Dag Wieers (@dagwieers) <dag@wieers.com>
# GNU General Public License v3.0+ (see LICENSE or https://www.gnu.org/licenses/gpl-3.0.txt)
from __future__ import absolute_import, division, print_function
__metaclass__ = type
class ModuleDocFragment(object):
# Standard files documentation fragment
DOCUMENTATION = r"""
options:
host:
description:
- IP Address or hostname of the ACI Multi Site Orchestrator host.
- If the value is not specified in the task, the value of environment variable C(MSO_HOST) will be used instead.
type: str
aliases: [ hostname ]
port:
description:
- Port number to be used for the REST connection.
- The default value depends on parameter `use_ssl`.
- If the value is not specified in the task, the value of environment variable C(MSO_PORT) will be used instead.
type: int
username:
description:
- The username to use for authentication.
- If the value is not specified in the task, the value of environment variables C(MSO_USERNAME) or C(ANSIBLE_NET_USERNAME) will be used instead.
type: str
password:
description:
- The password to use for authentication.
- If the value is not specified in the task, the value of environment variables C(MSO_PASSWORD) or C(ANSIBLE_NET_PASSWORD) will be used instead.
type: str
output_level:
description:
- Influence the output of this MSO module.
- C(normal) means the standard output, incl. C(current) dict
- C(info) adds informational output, incl. C(previous), C(proposed) and C(sent) dicts
- C(debug) adds debugging output, incl. C(filter_string), C(method), C(response), C(status) and C(url) information
- If the value is not specified in the task, the value of environment variable C(MSO_OUTPUT_LEVEL) will be used instead.
type: str
choices: [ debug, info, normal ]
default: normal
timeout:
description:
- The socket level timeout in seconds.
- The default value is 30 seconds.
- If the value is not specified in the task, the value of environment variable C(MSO_TIMEOUT) will be used instead.
type: int
use_proxy:
description:
- If C(false), it will not use a proxy, even if one is defined in an environment variable on the target hosts.
- If the value is not specified in the task, the value of environment variable C(MSO_USE_PROXY) will be used instead.
- The default is C(true).
type: bool
use_ssl:
description:
- If C(false), an HTTP connection will be used instead of the default HTTPS connection.
- If the value is not specified in the task, the value of environment variable C(MSO_USE_SSL) will be used instead.
- When using a HTTPAPI connection plugin the inventory variable C(ansible_httpapi_use_ssl) will be used if this attribute is not specified.
- The default is C(false) when using a HTTPAPI connection plugin (mso or nd) and C(true) when using the legacy connection method (only for mso).
type: bool
validate_certs:
description:
- If C(false), SSL certificates will not be validated.
- This should only set to C(false) when used on personally controlled sites using self-signed certificates.
- If the value is not specified in the task, the value of environment variable C(MSO_VALIDATE_CERTS) will be used instead.
- The default is C(true).
type: bool
login_domain:
description:
- The login domain name to use for authentication.
- The default value is Local.
- If the value is not specified in the task, the value of environment variable C(MSO_LOGIN_DOMAIN) will be used instead.
- When using a HTTPAPI connection plugin the inventory variable C(ansible_httpapi_login_domain) will be used if this attribute is not specified.
type: str
requirements:
- Multi Site Orchestrator v2.1 or newer
notes:
- This module was written to support Multi Site Orchestrator v2.1 or newer. Some or all functionality may not work on earlier versions.
"""
|
