cisco.aci.aci_interface_policy_leaf_policy_group – Manage fabric interface policy leaf policy groups (infra:AccBndlGrp, infra:AccPortGrp)
cisco.aci.aci_interface_policy_leaf_policy_group – Manage fabric interface policy leaf policy groups (infra:AccBndlGrp, infra:AccPortGrp)
Note
This plugin is part of the cisco.aci collection (version 2.0.0).
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 | Choices/Defaults | Comments |
---|---|---|
aep string |
Choice of attached_entity_profile (AEP) to be used as part of the leaf policy group to be created.
| |
annotation string |
User-defined string for annotating an object. If the value is not specified in the task, the value of environment variable | |
cdp_policy string |
Choice of cdp_policy to be used as part of the leaf policy group to be created.
| |
certificate_name string |
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
| |
description string |
Description for the leaf policy group to be created.
| |
egress_data_plane_policing_policy string |
Choice of egress_data_plane_policing_policy to be used as part of the leaf policy group to be created.
| |
fibre_channel_interface_policy string |
Choice of fibre_channel_interface_policy to be used as part of the leaf policy group to be created.
| |
host string / required |
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
| |
ingress_data_plane_policing_policy string |
Choice of ingress_data_plane_policing_policy to be used as part of the leaf policy group to be created.
| |
l2_interface_policy string |
Choice of l2_interface_policy to be used as part of the leaf policy group to be created.
| |
lag_type string / required |
|
Selector for the type of leaf policy group we want to create.
|
link_level_policy string |
Choice of link_level_policy to be used as part of the leaf policy group to be created.
| |
lldp_policy string |
Choice of lldp_policy to be used as part of the leaf policy group to be created.
| |
mcp_policy string |
Choice of mcp_policy to be used as part of the leaf policy group to be created.
| |
monitoring_policy string |
Choice of monitoring_policy to be used as part of the leaf policy group to be created.
| |
name_alias string |
The alias for the current object. This relates to the nameAlias field in ACI. | |
output_level string |
|
Influence the output of this ACI module.
If the value is not specified in the task, the value of environment variable |
output_path string |
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 | |
owner_key string |
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 | |
owner_tag string |
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 | |
password string |
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 | |
policy_group string |
Name of the leaf policy group to be added/deleted.
| |
port integer |
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 | |
port_channel_policy string |
Choice of port_channel_policy to be used as part of the leaf policy group to be created.
| |
port_security_policy string |
Choice of port_security_policy to be used as part of the leaf policy group to be created.
| |
priority_flow_control_policy string |
Choice of priority_flow_control_policy to be used as part of the leaf policy group to be created.
| |
private_key string |
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
| |
slow_drain_policy string |
Choice of slow_drain_policy to be used as part of the leaf policy group to be created.
| |
state string |
|
Use Use |
storm_control_interface_policy string |
Choice of storm_control_interface_policy to be used as part of the leaf policy group to be created.
| |
stp_interface_policy string |
Choice of stp_interface_policy to be used as part of the leaf policy group to be created.
| |
timeout integer |
Default: 30 |
The socket level timeout in seconds. If the value is not specified in the task, the value of environment variable |
use_proxy boolean |
|
If If the value is not specified in the task, the value of environment variable |
use_ssl boolean |
|
If If the value is not specified in the task, the value of environment variable |
username string |
Default: "admin" |
The username to use for authentication. If the value is not specified in the task, the value of environment variables
|
validate_certs boolean |
|
If This should only set to If the value is not specified in the task, the value of environment variable |
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: whateverlinklevelpolicy
cdp_policy: whatevercdppolicy
lldp_policy: whateverlldppolicy
port_channel_policy: whateverlacppolicy
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: whateverlinklevelpolicy
cdp_policy: whatevercdppolicy
lldp_policy: whateverlldppolicy
port_channel_policy: whateverlacppolicy
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: whateverlinklevelpolicy
cdp_policy: whatevercdppolicy
lldp_policy: whateverlldppolicy
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 | Returned | Description |
---|---|---|
current list / elements=string |
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 / elements=string |
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 / elements=string |
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: |
Authors
- Bruno Calogero (@brunocalogero)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/cisco/aci/aci_interface_policy_leaf_policy_group_module.html