New in version 2.8.
Parameter | Choices/Defaults | Comments |
---|---|---|
adminst
-
|
|
Will trigger an immediate upgrade for nodes if adminst is set to triggered.
|
certificate_name
string
|
The X.509 certificate name attached to the APIC AAA user used for signature-based authentication.
If a
private_key filename was provided, this defaults to the private_key basename, without extension.If PEM-formatted content was provided for
private_key , this defaults to the username value.aliases: cert_name |
|
graceful
boolean
|
|
Whether the system will bring down the nodes gracefully during an upgrade, which reduces traffic lost.
The APIC defaults to
no when unset during creation. |
host
string
/ required
|
IP Address or hostname of APIC resolvable by Ansible control host.
aliases: hostname |
|
ignoreCompat
boolean
|
|
To check whether compatibility checks should be ignored
The APIC defaults to
no when unset during creation. |
name
-
/ required
|
The name for the maintenance policy.
aliases: maintenance_policy |
|
output_level
string
|
|
Influence the output of this ACI module.
normal means the standard output, incl. current dictinfo adds informational output, incl. previous , proposed and sent dictsdebug adds debugging output, incl. filter_string , method , response , status and url information |
password
string
/ required
|
The password to use for authentication.
This option is mutual exclusive with
private_key . If private_key is provided too, it will be used instead. |
|
port
integer
|
Port number to be used for REST connection.
The default value depends on parameter
use_ssl . |
|
private_key
string
/ required
|
Either a PEM-formatted private key file or the private key content used for signature-based authentication.
This value also influences the default
certificate_name that is used.This option is mutual exclusive with
password . If password is provided too, it will be ignored.aliases: cert_key |
|
runmode
-
|
|
Whether the system pauses on error or just continues through it.
|
scheduler
string
/ required
|
The name of scheduler that is applied to the policy.
|
|
state
-
|
|
Use
present or absent for adding or removing.Use
query for listing an object or multiple objects. |
timeout
integer
|
Default: 30
|
The socket level timeout in seconds.
|
use_proxy
boolean
|
|
If
no , it will not use a proxy, even if one is defined in an environment variable on the target hosts. |
use_ssl
boolean
|
|
If
no , an HTTP connection will be used instead of the default HTTPS connection. |
username
string
|
Default: "admin"
|
The username to use for authentication.
aliases: user |
validate_certs
boolean
|
|
If
no , SSL certificates will not be validated.This should only set to
no when used on personally controlled sites using self-signed certificates. |
Note
A scheduler is required for this module, which could have been created using the aci_fabric_scheduler module or via the UI.
See also
Detailed information on how to manage your ACI infrastructure using Ansible.
Detailed guide on how to write your own Cisco ACI modules to contribute.
- name: Ensure maintenance policy is present
aci_maintenance_policy:
host: '{{ inventory_hostname }}'
username: '{{ user }}'
password: '{{ pass }}'
validate_certs: no
name: maintenancePol1
scheduler: simpleScheduler
runmode: False
state: present
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
current
list
|
success |
The existing configuration from the APIC after the module has finished
Sample:
[{'fvTenant': {'attributes': {'descr': 'Production environment', 'dn': 'uni/tn-production', 'name': 'production', 'nameAlias': '', 'ownerKey': '', 'ownerTag': ''}}}]
|
error
dictionary
|
failure |
The error information as returned from the APIC
Sample:
{'code': '122', 'text': 'unknown managed object class foo'}
|
filter_string
string
|
failure or debug |
The filter string used for the request
Sample:
?rsp-prop-include=config-only
|
method
string
|
failure or debug |
The HTTP method used for the request to the APIC
Sample:
POST
|
previous
list
|
info |
The original configuration from the APIC before the module has started
Sample:
[{'fvTenant': {'attributes': {'descr': 'Production', 'dn': 'uni/tn-production', 'name': 'production', 'nameAlias': '', 'ownerKey': '', 'ownerTag': ''}}}]
|
proposed
dictionary
|
info |
The assembled configuration from the user-provided parameters
Sample:
{'fvTenant': {'attributes': {'descr': 'Production environment', 'name': 'production'}}}
|
raw
string
|
parse error |
The raw output returned by the APIC REST API (xml or json)
Sample:
<?xml version="1.0" encoding="UTF-8"?><imdata totalCount="1"><error code="122" text="unknown managed object class foo"/></imdata>
|
response
string
|
failure or debug |
The HTTP response from the APIC
Sample:
OK (30 bytes)
|
sent
list
|
info |
The actual/minimal configuration pushed to the APIC
Sample:
{'fvTenant': {'attributes': {'descr': 'Production environment'}}}
|
status
integer
|
failure or debug |
The HTTP status from the APIC
Sample:
200
|
url
string
|
failure or debug |
The HTTP url used for the request to the APIC
Sample:
https://10.11.12.13/api/mo/uni/tn-production.json
|
This module is not guaranteed to have a backwards compatible interface. [preview]
This module is maintained by the Ansible Community. [community]
Steven Gerhart (@sgerhart)
Hint
If you notice any issues in this documentation you can edit this document to improve it.