aci_static_binding_to_epg – Bind static paths to EPGs (fv:RsPathAtt)
aci_static_binding_to_epg – Bind static paths to EPGs (fv:RsPathAtt)
New in version 2.5.
Synopsis
- Bind static paths to EPGs on Cisco ACI fabrics.
Parameters
Parameter | Choices/Defaults | Comments |
---|---|---|
ap - |
Name of an existing application network profile, that will contain the EPGs.
| |
certificate_name - |
The X.509 certificate name attached to the APIC AAA user used for signature-based authentication. It defaults to the
| |
deploy_immediacy - |
|
The Deployement Immediacy of Static EPG on PC, VPC or Interface. The APIC defaults to |
description - added in 2.7 |
Description for the static path to EPG binding.
| |
encap_id integer |
The encapsulation ID associating the This acts as the secondary Accepted values are any valid encap ID for specified encap, currently ranges between
| |
epg - |
The name of the end point group.
| |
extpaths integer |
The
Usually something like | |
host - / required |
IP Address or hostname of APIC resolvable by Ansible control host.
| |
interface - |
The Usually a policy group like | |
interface_mode - |
|
Determines how layer 2 tags will be read from and added to frames. Values Values Values The APIC defaults to
|
interface_type - |
|
The type of interface for the static EPG deployement. |
leafs - |
The switch ID(s) that the When When The
| |
output_level - |
|
Influence the output of this ACI module.
|
password - / required |
The password to use for authentication. This option is mutual exclusive with | |
pod_id integer |
The pod number part of the tDn.
| |
port - |
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 Accepted values are any valid encap ID for specified encap, currently ranges between
| |
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 This option is mutual exclusive with
| |
state - |
|
Use Use |
tenant - |
Name of an existing tenant.
| |
timeout integer |
Default: 30 |
The socket level timeout in seconds. |
use_proxy boolean |
|
If |
use_ssl boolean |
|
If |
username - |
Default: "admin" |
The username to use for authentication.
|
validate_certs boolean |
|
If This should only set to |
Notes
Note
- The
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. - More information about the internal APIC classes fv:RsPathAtt from the APIC Management Information Model reference.
See Also
See also
- Cisco ACI Guide
- Detailed information on how to manage your ACI infrastructure using Ansible.
- Developing Cisco ACI modules
- Detailed guide on how to write your own Cisco ACI modules to contribute.
Examples
- 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
Return Values
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:
|
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: |
Status
- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by an Ansible Partner. [certified]
Authors
- Bruno Calogero (@brunocalogero)
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.7/modules/aci_static_binding_to_epg_module.html