New in version 2.5.
Parameter | Choices/Defaults | Comments |
---|---|---|
aep | Choice of attached_entity_profile (AEP) to be used as part of the leaf policy group to be created. aliases: aep_name | |
cdp_policy | Choice of cdp_policy to be used as part of the leaf policy group to be created. aliases: cdp_policy_name | |
certificate_name | The X.509 certificate name attached to the APIC AAA user used for signature-based authentication. It defaults to the private_key basename, without extension.aliases: cert_name | |
description | Description for the leaf policy group to be created. aliases: descr | |
egress_data_plane_policing_policy | 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 | 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 required | IP Address or hostname of APIC resolvable by Ansible control host. aliases: hostname | |
ingress_data_plane_policing_policy | 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 | 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 required |
| Selector for the type of leaf policy group we want to create. leaf for Leaf Access Port Policy Grouplink for Port Channel (PC)node for Virtual Port Channel (VPC)aliases: lag_type_name |
link_level_policy | 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 | Choice of lldp_policy to be used as part of the leaf policy group to be created. aliases: lldp_policy_name | |
mcp_policy | Choice of mcp_policy to be used as part of the leaf policy group to be created. aliases: mcp_policy_name | |
monitoring_policy | Choice of monitoring_policy to be used as part of the leaf policy group to be created. aliases: monitoring_policy_name | |
output_level |
| Influence the output of this ACI module. normal means the standard output, incl. current dictinfo adds informational output, incl. previous , proposed and sent dictsdebug adds debugging output, incl. filter_string , method , response , status and url information |
password 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 | Name of the leaf policy group to be added/deleted. aliases: name, policy_group_name | |
port | Port number to be used for REST connection. The default value depends on parameter `use_ssl`. | |
port_channel_policy | 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 | 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 | 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 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 certificate_name is specified.This option is mutual exclusive with password . If password is provided too, it will be ignored.aliases: cert_key | |
slow_drain_policy | Choice of slow_drain_policy to be used as part of the leaf policy group to be created. aliases: slow_drain_policy_name | |
state |
| Use present or absent for adding or removing.Use query for listing an object or multiple objects. |
storm_control_interface_policy | 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 | Choice of stp_interface_policy to be used as part of the leaf policy group to be created. aliases: stp_interface_policy_name | |
timeout int | Default: 30 | The socket level timeout in seconds. |
use_proxy bool |
| If no , it will not use a proxy, even if one is defined in an environment variable on the target hosts. |
use_ssl bool |
| If no , an HTTP connection will be used instead of the default HTTPS connection. |
username | Default: admin | The username to use for authentication. aliases: user |
validate_certs bool |
| If no , SSL certificates will not be validated.This should only set to no when used on personally controlled sites using self-signed certificates. |
Note
link
for Port Channel(PC), node
for Virtual Port Channel(VPC) and leaf
for Leaf Access Port Policy Group.- 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
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': {'dn': 'uni/tn-production', 'ownerKey': '', 'name': 'production', 'descr': 'Production environment', 'nameAlias': '', 'ownerTag': ''}}}] |
error dict | failure | The error information as returned from the APIC Sample: {'text': 'unknown managed object class foo', 'code': '122'} |
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': {'dn': 'uni/tn-production', 'ownerKey': '', 'name': 'production', 'descr': 'Production', 'nameAlias': '', 'ownerTag': ''}}}] |
proposed dict | info | The assembled configuration from the user-provided parameters Sample: {'fvTenant': {'attributes': {'name': 'production', 'descr': 'Production environment'}}} |
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 int | 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 |
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
This module is flagged as community which means that it is maintained by the Ansible Community. See Module Maintenance & Support for more info.
For a list of other modules that are also maintained by the Ansible Community, see here.
Hint
If you notice any issues in this documentation you can edit this document to improve it.
© 2012–2018 Michael DeHaan
© 2018 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.7/modules/aci_interface_policy_leaf_policy_group_module.html