Parameter |
Choices/Defaults |
Comments |
certificate_name
|
|
The X.509 certificate name attached to the APIC AAA user used for signature-based authentication.
It defaults to the private_key basename, without extension.
aliases: cert_name
|
description
|
|
The description for the Config Export Policy.
aliases: descr
|
export_policy
|
|
The name of the Export Policy to use for Config Snapshots.
aliases: name
|
format
|
|
Sets the config backup to be formatted in JSON or XML.
The APIC defaults to json when unset.
|
host
required |
|
IP Address or hostname of APIC resolvable by Ansible control host.
aliases: hostname
|
include_secure
bool |
|
Determines if secure information should be included in the backup.
The APIC defaults to yes when unset.
|
max_count
int |
|
Determines how many snapshots can exist for the Export Policy before the APIC starts to rollover.
Accepted values range between 1 and 10 .
The APIC defaults to 3 when unset.
|
output_level
|
Choices:
- debug
- info
normal ←
|
Influence the output of this ACI module.
normal means the standard output, incl. current dict
info adds informational output, incl. previous , proposed and sent dicts
debug adds debugging output, incl. filter_string , method , response , status and url information
|
password
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
|
|
Port number to be used for REST connection.
The default value depends on parameter `use_ssl`.
|
private_key
required |
|
PEM formatted file that contains your private key to be used for signature-based authentication.
The name of the key (without extension) is used as the certificate name in ACI, unless certificate_name is specified.
This option is mutual exclusive with password . If password is provided too, it will be ignored.
aliases: cert_key
|
snapshot
|
|
The name of the snapshot to delete.
|
state
|
Choices:
- absent
present ←
- query
|
Use present or absent for adding or removing.
Use query for listing an object or multiple objects.
|
timeout
int |
Default:
30
|
The socket level timeout in seconds.
|
use_proxy
bool |
|
If no , it will not use a proxy, even if one is defined in an environment variable on the target hosts.
|
use_ssl
bool |
|
If no , an HTTP connection will be used instead of the default HTTPS connection.
|
username
|
Default:
admin
|
The username to use for authentication.
aliases: user
|
validate_certs
bool |
|
If no , SSL certificates will not be validated.
This should only set to no when used on personally controlled sites using self-signed certificates.
|