aci_interface_policy_leaf_policy_group – Manage fabric interface policy leaf policy groups (infra:AccBndlGrp, infra:AccPortGrp)

New in version 2.5.

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. aliases: aep_name
cdp_policy string		Choice of cdp_policy to be used as part of the leaf policy group to be created. aliases: cdp_policy_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
description string		Description for the leaf policy group to be created. aliases: descr
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. aliases: egress_data_plane_policing_policy_name
fibre_channel_interface_policy string		Choice of fibre_channel_interface_policy to be used as part of the leaf policy group to be created. aliases: fibre_channel_interface_policy_name
host string / required		IP Address or hostname of APIC resolvable by Ansible control host. aliases: hostname
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. aliases: ingress_data_plane_policing_policy_name
l2_interface_policy string		Choice of l2_interface_policy to be used as part of the leaf policy group to be created. aliases: l2_interface_policy_name
lag_type string / required	Choices: leaf link node	Selector for the type of leaf policy group we want to create. leaf for Leaf Access Port Policy Group link for Port Channel (PC) node for Virtual Port Channel (VPC) aliases: lag_type_name
link_level_policy string		Choice of link_level_policy to be used as part of the leaf policy group to be created. aliases: link_level_policy_name
lldp_policy string		Choice of lldp_policy to be used as part of the leaf policy group to be created. aliases: lldp_policy_name
mcp_policy string		Choice of mcp_policy to be used as part of the leaf policy group to be created. aliases: mcp_policy_name
monitoring_policy string		Choice of monitoring_policy to be used as part of the leaf policy group to be created. aliases: monitoring_policy_name
output_level string	Choices: debug info normal ←	Influence the output of this ACI module. normal means the standard output, incl. current dict info adds informational output, incl. previous, proposed and sent dicts debug 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.
policy_group string		Name of the leaf policy group to be added/deleted. aliases: name, policy_group_name
port integer		Port number to be used for REST connection. The default value depends on parameter use_ssl.
port_channel_policy string		Choice of port_channel_policy to be used as part of the leaf policy group to be created. aliases: port_channel_policy_name
port_security_policy string		Choice of port_security_policy to be used as part of the leaf policy group to be created. aliases: port_security_policy_name
priority_flow_control_policy string		Choice of priority_flow_control_policy to be used as part of the leaf policy group to be created. aliases: priority_flow_control_policy_name
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
slow_drain_policy string		Choice of slow_drain_policy to be used as part of the leaf policy group to be created. aliases: slow_drain_policy_name
state string	Choices: absent present ← query	Use present or absent for adding or removing. Use query for listing an object or multiple objects.
storm_control_interface_policy string		Choice of storm_control_interface_policy to be used as part of the leaf policy group to be created. aliases: storm_control_interface_policy_name
stp_interface_policy string		Choice of stp_interface_policy to be used as part of the leaf policy group to be created. aliases: stp_interface_policy_name
timeout integer	Default: 30	The socket level timeout in seconds.
use_proxy boolean	Choices: no yes ←	If no, it will not use a proxy, even if one is defined in an environment variable on the target hosts.
use_ssl boolean	Choices: no yes ←	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	Choices: no yes ←	If no, SSL certificates will not be validated. This should only set to no when used on personally controlled sites using self-signed certificates.

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) and leaf 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
  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
    fibre_channel_interface_policy: whateverfcpolicy
    state: present
  delegate_to: localhost

- name: Create a Virtual Port Channel (VPC) Interface Policy Group (no description)
  aci_interface_policy_leaf_policy_group:
    host: apic
    username: admin
    password: SomeSecretPassword
    lag_type: node
    policy_group: policygroupname
    link_level_policy: whateverlinklevelpolicy
    fibre_channel_interface_policy: whateverfcpolicy
    state: present
  delegate_to: localhost

- name: Create a Leaf Access Port Policy Group (no description)
  aci_interface_policy_leaf_policy_group:
    host: apic
    username: admin
    password: SomeSecretPassword
    lag_type: leaf
    policy_group: policygroupname
    link_level_policy: whateverlinklevelpolicy
    fibre_channel_interface_policy: whateverfcpolicy
    state: present
  delegate_to: localhost

- name: Query all Leaf Access Port Policy Groups of type link
  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
  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
  aci_interface_policy_leaf_policy_group:
    host: apic
    username: admin
    password: SomeSecretPassword
    lag_type: type_name
    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	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: <?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

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)

Hint

If you notice any issues in this documentation, you can edit this document to improve it.