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
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
|
# -*- coding: utf-8 -*-
# Copyright: (c) 2017, Dag Wieers (@dagwieers) <dag@wieers.com>
# Copyright: (c) 2017, Swetha Chunduri (@schunduri)
# Copyright: (c) 2024, Samita Bhattacharjee (@samiib) <samitab@cisco.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 APIC resolvable by Ansible control host.
- If the value is not specified in the task, the value of environment variable C(ACI_HOST) will be used instead.
type: str
aliases: [ hostname ]
port:
description:
- Port number to be used for REST connection.
- The default value depends on parameter C(use_ssl).
- If the value is not specified in the task, the value of environment variable C(ACI_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(ACI_USERNAME) or C(ANSIBLE_NET_USERNAME) will be used instead.
- The default value is admin.
type: str
aliases: [ user ]
password:
description:
- The password to use for authentication.
- This option is mutual exclusive with C(private_key). If C(private_key) is provided too, it will be used instead.
- If the value is not specified in the task, the value of environment variables C(ACI_PASSWORD) or C(ANSIBLE_NET_PASSWORD) will be used instead.
type: str
private_key:
description:
- Either a PEM-formatted private key file or the private key content used for signature-based authentication.
- This value also influences the default C(certificate_name) that is used.
- This option is mutual exclusive with C(password). If C(password) is provided too, it will be ignored.
- If the value is not specified in the task, the value of environment variable C(ACI_PRIVATE_KEY) or C(ANSIBLE_NET_SSH_KEYFILE) will be used instead.
type: str
aliases: [ cert_key ]
certificate_name:
description:
- The X.509 certificate name attached to the APIC AAA user used for signature-based authentication.
- If a C(private_key) filename was provided, this defaults to the C(private_key) basename, without extension.
- If PEM-formatted content was provided for C(private_key), this defaults to the C(username) value.
- If the value is not specified in the task, the value of environment variable C(ACI_CERTIFICATE_NAME) will be used instead.
type: str
aliases: [ cert_name ]
output_level:
description:
- Influence the output of this ACI 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(ACI_OUTPUT_LEVEL) will be used instead.
type: str
choices: [ debug, info, normal ]
default: normal
timeout:
description:
- The socket level timeout in seconds.
- If the value is not specified in the task, the value of environment variable C(ACI_TIMEOUT) will be used instead.
- The default value is 30.
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(ACI_USE_PROXY) will be used instead.
- The default value is 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(ACI_USE_SSL) will be used instead.
- The default value is true when the connection is local.
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(ACI_VALIDATE_CERTS) will be used instead.
- The default value is true.
type: bool
output_path:
description:
- Path to a file that will be used to dump the ACI JSON configuration objects generated by the module.
- If the value is not specified in the task, the value of environment variable C(ACI_OUTPUT_PATH) will be used instead.
type: str
suppress_verification:
description:
- If C(true), a verifying GET will not be sent after a POST update to APIC.
- If the value is not specified in the task, the value of environment variable C(ACI_NO_VERIFICATION) will be used instead.
- The default value is C(false).
- WARNING - This causes the current return value to be set to the proposed value.
- The current object including default values will be unverifiable in a single task.
type: bool
aliases: [ no_verification, no_verify, suppress_verify ]
seealso:
- ref: aci_guide
description: Detailed information on how to manage your ACI infrastructure using Ansible.
- ref: aci_dev_guide
description: Detailed guide on how to write your own Cisco ACI modules to contribute.
"""
|
