New in version 2.5.
| Parameter | Choices/Defaults | Comments |
|---|---|---|
|
ap
string
|
Name of an existing application network profile, that will contain the EPGs.
aliases: app_profile, app_profile_name |
|
|
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 |
|
|
deploy_immediacy
string
|
|
The Deployement Immediacy of Static EPG on PC, VPC or Interface.
The APIC defaults to
lazy when unset during creation. |
|
description
string
added in 2.7 |
Description for the static path to EPG binding.
aliases: descr |
|
|
encap_id
integer
|
The encapsulation ID associating the
epg with the interface path.This acts as the secondary
encap_id when using micro-segmentation.Accepted values are any valid encap ID for specified encap, currently ranges between
1 and 4096.aliases: vlan, vlan_id |
|
|
epg
string
|
The name of the end point group.
aliases: epg_name |
|
|
extpaths
integer
|
The
extpaths integer value part of the tDn.extpaths is only used if interface_type is fex.Usually something like
1011. |
|
|
host
string
/ required
|
IP Address or hostname of APIC resolvable by Ansible control host.
aliases: hostname |
|
|
interface
string
|
The
interface string value part of the tDn.Usually a policy group like
test-IntPolGrp or an interface of the following format 1/7 depending on interface_type. |
|
|
interface_mode
string
|
|
Determines how layer 2 tags will be read from and added to frames.
Values
802.1p and native are identical.Values
access and untagged are identical.Values
regular, tagged and trunk are identical.The APIC defaults to
trunk when unset during creation.aliases: interface_mode_name, mode |
|
interface_type
string
|
|
The type of interface for the static EPG deployement.
|
|
leafs
list
|
The switch ID(s) that the
interface belongs to.When
interface_type is switch_port, port_channel, or fex, then leafs is a string of the leaf ID.When
interface_type is vpc, then leafs is a list with both leaf IDs.The
leafs value is usually something like '101' or '101-102' depending on connection_type.aliases: leaves, nodes, paths, switches |
|
|
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. |
|
|
pod_id
integer
|
The pod number part of the tDn.
pod_id is usually an integer below 10.aliases: pod, pod_number |
|
|
port
integer
|
Port number to be used for REST connection.
The default value depends on parameter
use_ssl. |
|
|
primary_encap_id
integer
|
Determines the primary encapsulation ID associating the
epg with the interface path when using micro-segmentation.Accepted values are any valid encap ID for specified encap, currently ranges between
1 and 4096.aliases: primary_vlan, primary_vlan_id |
|
|
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 |
|
|
state
string
|
|
Use
present or absent for adding or removing.Use
query for listing an object or multiple objects. |
|
tenant
string
|
Name of an existing tenant.
aliases: tenant_name |
|
|
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
tenant, ap, epg used must exist before using this module in your playbook. The aci_tenant, aci_ap, aci_epg modules can be used for this.See also
- name: Deploy Static Path binding for given EPG
aci_static_binding_to_epg:
host: apic
username: admin
password: SomeSecretPassword
tenant: accessport-code-cert
ap: accessport_code_app
epg: accessport_epg1
encap_id: 222
deploy_immediacy: lazy
interface_mode: untagged
interface_type: switch_port
pod_id: 1
leafs: 101
interface: '1/7'
state: present
delegate_to: localhost
- name: Remove Static Path binding for given EPG
aci_static_binding_to_epg:
host: apic
username: admin
password: SomeSecretPassword
tenant: accessport-code-cert
ap: accessport_code_app
epg: accessport_epg1
interface_type: switch_port
pod: 1
leafs: 101
interface: '1/7'
state: absent
delegate_to: localhost
- name: Get specific Static Path binding for given EPG
aci_static_binding_to_epg:
host: apic
username: admin
password: SomeSecretPassword
tenant: accessport-code-cert
ap: accessport_code_app
epg: accessport_epg1
interface_type: switch_port
pod: 1
leafs: 101
interface: '1/7'
state: query
delegate_to: localhost
register: query_result
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': {'dn': 'uni/tn-production', 'ownerKey': '', 'name': 'production', 'descr': 'Production environment', 'nameAlias': '', 'ownerTag': ''}}}]
|
|
error
dictionary
|
failure |
The error information as returned from the APIC
Sample:
{'text': 'unknown managed object class foo', 'code': '122'}
|
|
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': {'dn': 'uni/tn-production', 'ownerKey': '', 'name': 'production', 'descr': 'Production', 'nameAlias': '', 'ownerTag': ''}}}]
|
|
proposed
dictionary
|
info |
The assembled configuration from the user-provided parameters
Sample:
{'fvTenant': {'attributes': {'name': 'production', 'descr': 'Production environment'}}}
|
|
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
|
Hint
If you notice any issues in this documentation you can edit this document to improve it.