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
|
content
|
|
When used instead of src , sets the payload of the API request directly.
This may be convenient to template simple requests.
For anything complex use the template lookup plugin (see examples) or the template module with parameter src .
|
host
required |
|
IP Address or hostname of APIC resolvable by Ansible control host.
aliases: hostname
|
method
|
Choices:
- delete
get ←
- post
|
The HTTP method of the request.
Using delete is typically used for deleting objects.
Using get is typically used for querying objects.
Using post is typically used for modifying objects.
aliases: action
|
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.
|
path
required |
|
URI being used to execute API calls.
Must end in .xml or .json .
aliases: uri
|
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
|
src
path |
|
Name of the absolute path of the filname that includes the body of the HTTP request being sent to the ACI fabric.
If you require a templated payload, use the content parameter together with the template lookup plugin, or use template.
aliases: config_file
|
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.
|