aci_interface_policy_leaf_policy_group
Manage fabric interface policy leaf policy groups (infra:AccBndlGrp and infra:AccPortGrp)
Collection: cisco.aci
Full Name: cisco.aci.aci_interface_policy_leaf_policy_group
Synopsis
Manage fabric interface policy leaf policy groups (infra:AccBndlGrp and infra:AccPortGrp)
Parameters
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
| aep | string | The name of the attached entity profile (AEP) used by the leaf interface policy group. | ||
| annotation | string | orchestrator:ansible | User-defined string for annotating an object. If the value is not specified in the task, the value of environment variable C(ACI_ANNOTATION) will be used instead. If the value is not specified in the task and environment variable C(ACI_ANNOTATION) then the default value will be used. | |
| cdp_policy | string | The name of the cdp policy used by the leaf interface policy group. | ||
| certificate_name | string | The X.509 certificate name attached to the APIC AAA user used for signature-based authentication. If a C(private_key) filename was provided, this defaults to the C(private_key) basename, without extension. If PEM-formatted content was provided for C(private_key), this defaults to the C(username) value. If the value is not specified in the task, the value of environment variable C(ACI_CERTIFICATE_NAME) will be used instead. | ||
| copp_policy | string | The name of the copp policy used by the leaf interface policy group. | ||
| description | string | The description of the leaf interface policy group. | ||
| dwdm | string | The name of the dwdm used by the leaf interface policy group. | ||
| egress_data_plane_policing_policy | string | The name of the egress data plane policing policy used by the leaf interface policy group. | ||
| fibre_channel_interface_policy | string | The name of the fibre channel interface policy used by the leaf interface policy group. | ||
| host | string | 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 C(ACI_HOST) will be used instead. | ||
| ingress_data_plane_policing_policy | string | The name of the ingress data plane policing policy used by the leaf interface policy group. | ||
| l2_interface_policy | string | The name of the l2 interface policy used by the leaf interface policy group. | ||
| lag_type | string | yes | Selector for the type of leaf interface policy group. C(leaf) for Leaf Access Port Policy Group C(link) for Port Channel (PC) C(node) for Virtual Port Channel (VPC) | |
| link_flap_policy | string | The name of the link flap policy used by the leaf interface policy group. | ||
| link_level_flow_control | string | The name of the link level flow control used by the leaf interface policy group. | ||
| link_level_policy | string | The name of the link level policy used by the leaf interface policy group. | ||
| lldp_policy | string | The name of the lldp policy used by the leaf interface policy group. | ||
| mac_sec_interface_policy | string | The name of the mac sec interface policy used by the leaf interface policy group. | ||
| mcp_policy | string | The name of the mcp policy used by the leaf interface policy group. | ||
| monitoring_policy | string | The name of the monitoring policy used by the leaf interface policy group. | ||
| name_alias | string | The alias for the current object. This relates to the nameAlias field in ACI. | ||
| output_level | string | normal | Influence the output of this ACI module. C(normal) means the standard output, incl. C(current) dict C(info) adds informational output, incl. C(previous), C(proposed) and C(sent) dicts C(debug) adds debugging output, incl. C(filter_string), C(method), C(response), C(status) and C(url) information If the value is not specified in the task, the value of environment variable C(ACI_OUTPUT_LEVEL) will be used instead. | |
| 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 C(ACI_OUTPUT_PATH) will be used instead. | ||
| 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 C(ACI_OWNER_KEY) will be used instead. | ||
| 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 C(ACI_OWNER_TAG) will be used instead. | ||
| password | string | The password to use for authentication. This option is mutual exclusive with C(private_key). If C(private_key) is provided too, it will be used instead. If the value is not specified in the task, the value of environment variables C(ACI_PASSWORD) or C(ANSIBLE_NET_PASSWORD) will be used instead. | ||
| poe_interface_policy | string | The name of the poe interface policy used by the leaf interface policy group. | ||
| policy_group | string | The name of the leaf interface policy group. | ||
| port | int | Port number to be used for REST connection. The default value depends on parameter C(use_ssl). If the value is not specified in the task, the value of environment variable C(ACI_PORT) will be used instead. | ||
| port_authentication | string | The name of the port authentication used by the leaf interface policy group. | ||
| port_channel_policy | string | The name of the port channel policy used by the leaf interface policy group. | ||
| port_security_policy | string | The name of the port security policy used by the leaf interface policy group. | ||
| priority_flow_control_policy | string | The name of the priority flow control policy used by the leaf interface policy group. | ||
| 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 C(certificate_name) that is used. This option is mutual exclusive with C(password). If C(password) is provided too, it will be ignored. If the value is not specified in the task, the value of environment variable C(ACI_PRIVATE_KEY) or C(ANSIBLE_NET_SSH_KEYFILE) will be used instead. | ||
| slow_drain_policy | string | The name of the slow drain policy used by the leaf interface policy group. | ||
| state | string | present | Use C(present) or C(absent) for adding or removing. Use C(query) for listing an object or multiple objects. | |
| storm_control_interface_policy | string | The name of the storm control interface policy used by the leaf interface policy group. | ||
| stp_interface_policy | string | The name of the stp interface policy used by the leaf interface policy group. | ||
| suppress_previous | bool | If C(true), a GET to check previous will not be sent before a POST update to APIC. If the value is not specified in the task, the value of environment variable C(ACI_SUPPRESS_PREVIOUS) will be used instead. The default value is C(false). 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. | ||
| suppress_verification | bool | If C(true), a verifying GET will not be sent after a POST update to APIC. If the value is not specified in the task, the value of environment variable C(ACI_SUPPRESS_VERIFICATION) will be used instead. The default value is C(false). 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. | ||
| sync_e_interface_policy | string | The name of the syncE interface policy used by the leaf interface policy group. Only availavle in APIC version 5.2 or later. | ||
| timeout | int | The socket level timeout in seconds. If the value is not specified in the task, the value of environment variable C(ACI_TIMEOUT) will be used instead. The default value is 30. | ||
| transceiver_policy | dict | The name of the transceiver policy used by the leaf interface policy group. Only availavle in APIC version 6.0(2h) or later. | ||
| use_proxy | bool | If C(false), it will not use a proxy, even if one is defined in an environment variable on the target hosts. If the value is not specified in the task, the value of environment variable C(ACI_USE_PROXY) will be used instead. The default value is true. | ||
| use_ssl | bool | If C(false), an HTTP connection will be used instead of the default HTTPS connection. If the value is not specified in the task, the value of environment variable C(ACI_USE_SSL) will be used instead. The default value is true when the connection is local. | ||
| username | string | The username to use for authentication. If the value is not specified in the task, the value of environment variables C(ACI_USERNAME) or C(ANSIBLE_NET_USERNAME) will be used instead. The default value is admin. | ||
| validate_certs | bool | If C(false), SSL certificates will not be validated. This should only set to C(false) when used on personally controlled sites using self-signed certificates. If the value is not specified in the task, the value of environment variable C(ACI_VALIDATE_CERTS) will be used instead. The default value is true. |
Example
yaml
- {"cisco.aci.aci_interface_policy_leaf_policy_group": {"cdp_policy": "cdppolicy", "description": "policygroupname description", "host": "apic", "lag_type": "link", "link_level_policy": "linklevelpolicy", "lldp_policy": "lldppolicy", "password": "SomeSecretPassword", "policy_group": "policygroupname", "port_channel_policy": "lacppolicy", "state": "present", "username": "admin"}, "delegate_to": "localhost", "name": "Create a Port Channel (PC) Interface Policy Group"}
- {"cisco.aci.aci_interface_policy_leaf_policy_group": {"cdp_policy": "cdppolicy", "host": "apic", "lag_type": "node", "link_level_policy": "linklevelpolicy", "lldp_policy": "lldppolicy", "password": "SomeSecretPassword", "policy_group": "policygroupname", "port_channel_policy": "lacppolicy", "state": "present", "username": "admin"}, "delegate_to": "localhost", "name": "Create a Virtual Port Channel (VPC) Interface Policy Group"}
- {"cisco.aci.aci_interface_policy_leaf_policy_group": {"cdp_policy": "cdppolicy", "host": "apic", "lag_type": "leaf", "link_level_policy": "linklevelpolicy", "lldp_policy": "lldppolicy", "password": "SomeSecretPassword", "policy_group": "policygroupname", "state": "present", "username": "admin"}, "delegate_to": "localhost", "name": "Create a Leaf Access Port Policy Group"}
- {"cisco.aci.aci_interface_policy_leaf_policy_group": {"host": "apic", "lag_type": "link", "password": "SomeSecretPassword", "state": "query", "username": "admin"}, "delegate_to": "localhost", "name": "Query all Leaf Access Port Policy Groups of type link", "register": "query_result"}
- {"cisco.aci.aci_interface_policy_leaf_policy_group": {"host": "apic", "lag_type": "leaf", "password": "SomeSecretPassword", "policy_group": "policygroupname", "state": "query", "username": "admin"}, "delegate_to": "localhost", "name": "Query a specific Lead Access Port Policy Group", "register": "query_result"}
- {"cisco.aci.aci_interface_policy_leaf_policy_group": {"host": "apic", "lag_type": "leaf", "password": "SomeSecretPassword", "policy_group": "policygroupname", "state": "absent", "username": "admin"}, "delegate_to": "localhost", "name": "Delete an Interface policy Leaf Policy Group"}