cisco.aci.aci_static_binding_to_epg module – Bind static paths to EPGs (fv:RsPathAtt)
Note
This module is part of the cisco.aci collection (version 2.10.1).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install cisco.aci
.
To use it in a playbook, specify: cisco.aci.aci_static_binding_to_epg
.
Synopsis
Bind static paths to EPGs on Cisco ACI fabrics.
Parameters
Parameter |
Comments |
---|---|
User-defined string for annotating an object. If the value is not specified in the task, the value of environment variable If the value is not specified in the task and environment variable Default: |
|
Name of an existing application network profile, that will contain the EPGs. |
|
The X.509 certificate name attached to the APIC AAA user used for signature-based authentication. If a If PEM-formatted content was provided for If the value is not specified in the task, the value of environment variable |
|
The Deployment Immediacy of Static EPG on PC, VPC or Interface. The APIC defaults to Choices:
|
|
Description for the static path to EPG binding. |
|
The encapsulation ID associating the This acts as the secondary Accepted values are any valid encap ID for specified encap, currently ranges between |
|
The name of the end point group. |
|
The
When Usually something like |
|
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 |
|
The Usually a policy group like |
|
Determines how layer 2 tags will be read from and added to frames. Values Values Values The APIC defaults to Choices:
|
|
The type of interface for the static EPG deployment. Choices:
|
|
The switch ID(s) that the When When The |
|
Influence the output of this ACI module.
If the value is not specified in the task, the value of environment variable Choices:
|
|
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 |
|
The password to use for authentication. This option is mutual exclusive with If the value is not specified in the task, the value of environment variables |
|
The pod number part of the tDn.
|
|
Port number to be used for REST connection. The default value depends on parameter If the value is not specified in the task, the value of environment variable |
|
Determines the primary encapsulation ID associating the Accepted values are any valid encap ID for specified encap, currently ranges between
|
|
Either a PEM-formatted private key file or the private key content used for signature-based authentication. This value also influences the default This option is mutual exclusive with If the value is not specified in the task, the value of environment variable |
|
Use Use Choices:
|
|
If If the value is not specified in the task, the value of environment variable The default value is WARNING - This causes the previous return value to be empty. The previous state of the object will not be checked and the POST update will contain all properties. Choices:
|
|
If If the value is not specified in the task, the value of environment variable The default value is WARNING - This causes the current return value to be set to the proposed value. The current object including default values will be unverifiable in a single task. Choices:
|
|
Name of an existing tenant. |
|
The socket level timeout in seconds. If the value is not specified in the task, the value of environment variable The default value is 30. |
|
If If the value is not specified in the task, the value of environment variable The default value is true. Choices:
|
|
If If the value is not specified in the task, the value of environment variable The default value is true when the connection is local. Choices:
|
|
The username to use for authentication. If the value is not specified in the task, the value of environment variables The default value is admin. |
|
If This should only set to If the value is not specified in the task, the value of environment variable The default value is true. Choices:
|
Notes
Note
The
tenant
,ap
,epg
used must exist before using this module in your playbook. The cisco.aci.aci_tenant, cisco.aci.aci_ap, cisco.aci.aci_epg modules can be used for this.
See Also
See also
- cisco.aci.aci_tenant
Manage tenants (fv:Tenant).
- cisco.aci.aci_ap
Manage top level Application Profile (AP) objects (fv:Ap).
- cisco.aci.aci_epg
Manage End Point Groups (EPG) objects (fv:AEPg).
- APIC Management Information Model reference
More information about the internal APIC class fv:RsPathAtt.
- 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
cisco.aci.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
cisco.aci.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
cisco.aci.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 |
Description |
---|---|
The existing configuration from the APIC after the module has finished Returned: success Sample: |
|
The error information as returned from the APIC Returned: failure Sample: |
|
The filter string used for the request Returned: failure or debug Sample: |
|
The HTTP method used for the request to the APIC Returned: failure or debug Sample: |
|
The original configuration from the APIC before the module has started Returned: info Sample: |
|
The assembled configuration from the user-provided parameters Returned: info Sample: |
|
The raw output returned by the APIC REST API (xml or json) Returned: parse error Sample: |
|
The HTTP response from the APIC Returned: failure or debug Sample: |
|
The actual/minimal configuration pushed to the APIC Returned: info Sample: |
|
The HTTP status from the APIC Returned: failure or debug Sample: |
|
The HTTP url used for the request to the APIC Returned: failure or debug Sample: |