Parameter |
Choices/Defaults |
Comments |
annotation
string
|
|
User-defined string for annotating an object.
If the value is not specified in the task, the value of environment variable ACI_ANNOTATION will be used instead.
|
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.
If the value is not specified in the task, the value of environment variable ACI_CERTIFICATE_NAME will be used instead.
aliases: cert_name
|
compare_export_policy
string
|
|
The export policy that the compare_snapshot is associated to.
|
compare_snapshot
string
|
|
The name of the snapshot to compare with snapshot .
|
description
string
|
|
The description for the Import Policy.
aliases: descr
|
export_policy
string
|
|
The export policy that the snapshot is associated to.
|
fail_on_decrypt
boolean
|
|
Determines if the APIC should fail the rollback if unable to decrypt secured data.
The APIC defaults to yes when unset.
|
host
string
/ required
|
|
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 ACI_HOST will be used instead.
aliases: hostname
|
import_mode
string
|
Choices:
- atomic
- best-effort
|
Determines how the import should be handled by the APIC.
The APIC defaults to atomic when unset.
|
import_policy
string
|
|
The name of the Import Policy to use for config rollback.
|
import_type
string
|
|
Determines how the current and snapshot configuration should be compared for replacement.
The APIC defaults to replace when unset.
|
output_level
string
|
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
If the value is not specified in the task, the value of environment variable ACI_OUTPUT_LEVEL will be used instead.
|
output_path
string
|
|
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 ACI_OUTPUT_PATH will be used instead.
|
owner_key
string
|
|
User-defined string for the ownerKey attribute of an ACI object.
This attribute represents a key for enabling clients to own their data for entity correlation.
If the value is not specified in the task, the value of environment variable ACI_OWNER_KEY will be used instead.
|
owner_tag
string
|
|
User-defined string for the ownerTag attribute of an ACI object.
This attribute represents a tag for enabling clients to add their own data.
For example, to indicate who created this object.
If the value is not specified in the task, the value of environment variable ACI_OWNER_TAG will be used instead.
|
password
string
|
|
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.
If the value is not specified in the task, the value of environment variables ACI_PASSWORD or ANSIBLE_NET_PASSWORD will be used instead.
|
port
integer
|
|
Port number to be used for REST connection.
The default value depends on parameter use_ssl .
If the value is not specified in the task, the value of environment variable ACI_PORT will be used instead.
|
private_key
string
|
|
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.
If the value is not specified in the task, the value of environment variable ACI_PRIVATE_KEY will be used instead.
aliases: cert_key
|
snapshot
string
/ required
|
|
The name of the snapshot to rollback to, or the base snapshot to use for comparison.
The aci_snapshot module can be used to query the list of available snapshots.
|
state
string
|
Choices:
- preview
rollback ←
|
Use preview for previewing the diff between two snapshots.
Use rollback for reverting the configuration to a previous snapshot.
|
timeout
integer
|
Default:
30
|
The socket level timeout in seconds.
If the value is not specified in the task, the value of environment variable ACI_TIMEOUT will be used instead.
|
use_proxy
boolean
|
|
If no , 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 ACI_USE_PROXY will be used instead.
|
use_ssl
boolean
|
|
If no , 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 ACI_USE_SSL will be used instead.
|
username
string
|
Default:
"admin"
|
The username to use for authentication.
If the value is not specified in the task, the value of environment variables ACI_USERNAME or ANSIBLE_NET_USERNAME will be used instead.
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.
If the value is not specified in the task, the value of environment variable ACI_VALIDATE_CERTS will be used instead.
|