cisco.aci.aci_interface_policy_leaf_policy_group module – Manage fabric interface policy leaf policy groups (infra:AccBndlGrp and infra:AccPortGrp)
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_interface_policy_leaf_policy_group
.
Synopsis
Manage fabric interface policy leaf policy groups on Cisco ACI fabrics.
Parameters
Parameter |
Comments |
---|---|
The name of the attached entity profile (AEP) used by the leaf interface policy group. |
|
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: |
|
The name of the cdp policy used by the leaf interface policy group. |
|
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 name of the copp policy used by the leaf interface policy group. |
|
The description of the leaf interface policy group. |
|
The name of the dwdm used by the leaf interface policy group. |
|
The name of the egress data plane policing policy used by the leaf interface policy group. |
|
The name of the fibre channel interface policy used by the leaf interface policy group. |
|
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 name of the ingress data plane policing policy used by the leaf interface policy group. |
|
The name of the l2 interface policy used by the leaf interface policy group. |
|
Selector for the type of leaf interface policy group.
Choices:
|
|
The name of the link flap policy used by the leaf interface policy group. |
|
The name of the link level flow control used by the leaf interface policy group. |
|
The name of the link level policy used by the leaf interface policy group. |
|
The name of the lldp policy used by the leaf interface policy group. |
|
The name of the mac sec interface policy used by the leaf interface policy group. |
|
The name of the mcp policy used by the leaf interface policy group. |
|
The name of the monitoring policy used by the leaf interface policy group. |
|
The alias for the current object. This relates to the nameAlias field in ACI. |
|
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 |
|
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 |
|
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 |
|
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 name of the poe interface policy used by the leaf interface policy group. |
|
The name of the leaf interface policy group. |
|
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 |
|
The name of the port authentication used by the leaf interface policy group. |
|
The name of the port channel policy used by the leaf interface policy group. |
|
The name of the port security policy used by the leaf interface policy group. |
|
The name of the priority flow control policy used by the leaf interface policy group. |
|
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 |
|
The name of the slow drain policy used by the leaf interface policy group. |
|
Use Use Choices:
|
|
The name of the storm control interface policy used by the leaf interface policy group. |
|
The name of the stp interface policy used by the leaf interface policy group. |
|
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:
|
|
The name of the syncE interface policy used by the leaf interface policy group. Only availavle in APIC version 5.2 or later. |
|
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. |
|
The name of the transceiver policy used by the leaf interface policy group. Only availavle in APIC version 6.0(2h) or later. |
|
The name of the transceiver policy. |
|
The type of the transceiver policy. Choices:
|
|
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
When using the module please select the appropriate link_aggregation_type (lag_type).
link
for Port Channel(PC),node
for Virtual Port Channel(VPC) andleaf
for Leaf Access Port Policy Group.
See Also
See also
- APIC Management Information Model reference
More information about the internal APIC classes infra:AccBndlGrp and infra:AccPortGrp.
- 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: Create a Port Channel (PC) Interface Policy Group
cisco.aci.aci_interface_policy_leaf_policy_group:
host: apic
username: admin
password: SomeSecretPassword
lag_type: link
policy_group: policygroupname
description: policygroupname description
link_level_policy: linklevelpolicy
cdp_policy: cdppolicy
lldp_policy: lldppolicy
port_channel_policy: lacppolicy
state: present
delegate_to: localhost
- name: Create a Virtual Port Channel (VPC) Interface Policy Group
cisco.aci.aci_interface_policy_leaf_policy_group:
host: apic
username: admin
password: SomeSecretPassword
lag_type: node
policy_group: policygroupname
link_level_policy: linklevelpolicy
cdp_policy: cdppolicy
lldp_policy: lldppolicy
port_channel_policy: lacppolicy
state: present
delegate_to: localhost
- name: Create a Leaf Access Port Policy Group
cisco.aci.aci_interface_policy_leaf_policy_group:
host: apic
username: admin
password: SomeSecretPassword
lag_type: leaf
policy_group: policygroupname
link_level_policy: linklevelpolicy
cdp_policy: cdppolicy
lldp_policy: lldppolicy
state: present
delegate_to: localhost
- name: Query all Leaf Access Port Policy Groups of type link
cisco.aci.aci_interface_policy_leaf_policy_group:
host: apic
username: admin
password: SomeSecretPassword
lag_type: link
state: query
delegate_to: localhost
register: query_result
- name: Query a specific Lead Access Port Policy Group
cisco.aci.aci_interface_policy_leaf_policy_group:
host: apic
username: admin
password: SomeSecretPassword
lag_type: leaf
policy_group: policygroupname
state: query
delegate_to: localhost
register: query_result
- name: Delete an Interface policy Leaf Policy Group
cisco.aci.aci_interface_policy_leaf_policy_group:
host: apic
username: admin
password: SomeSecretPassword
lag_type: leaf
policy_group: policygroupname
state: absent
delegate_to: localhost
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: |