aci_access_port_to_interface_policy_leaf_profile – Manage Fabric interface policy leaf profile interface selectors (infra:HPortS, infra:RsAccBaseGrp, infra:PortBlk)
aci_access_port_to_interface_policy_leaf_profile – Manage Fabric interface policy leaf profile interface selectors (infra:HPortS, infra:RsAccBaseGrp, infra:PortBlk)
New in version 2.5.
Synopsis
- Manage Fabric interface policy leaf profile interface selectors on Cisco ACI fabrics.
Parameters
Parameter | Choices/Defaults | Comments |
---|---|---|
access_port_selector string / required |
The name of the Fabric access policy leaf interface profile access port selector.
| |
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
| |
description string |
The description to assign to the | |
from_card string added in 2.6 |
Deprecated Starting with Ansible 2.8 we recommend using the module aci_access_port_block_to_access_port. The parameter will be removed in Ansible 2.12. The beginning (from-range) of the card range block for the leaf access port block.
| |
from_port string / required |
Deprecated Starting with Ansible 2.8 we recommend using the module aci_access_port_block_to_access_port. The parameter will be removed in Ansible 2.12. The beginning (from-range) of the port range block for the leaf access port block.
| |
host string / required |
IP Address or hostname of APIC resolvable by Ansible control host.
| |
interface_type string added in 2.6 |
|
The type of interface for the static EPG deployment. |
leaf_interface_profile string / required |
The name of the Fabric access policy leaf interface profile.
| |
leaf_port_blk string / required |
Deprecated Starting with Ansible 2.8 we recommend using the module aci_access_port_block_to_access_port. The parameter will be removed in Ansible 2.12. The name of the Fabric access policy leaf interface profile access port block.
| |
leaf_port_blk_description string |
Deprecated Starting with Ansible 2.8 we recommend using the module aci_access_port_block_to_access_port. The parameter will be removed in Ansible 2.12. The description to assign to the | |
output_level string |
|
Influence the output of this ACI module.
|
password string / required |
The password to use for authentication. This option is mutual exclusive with | |
policy_group string |
The name of the fabric access policy group to be associated with the leaf interface profile interface selector.
| |
port integer |
Port number to be used for REST connection. The default value depends on parameter | |
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 This option is mutual exclusive with
| |
state string |
|
Use Use |
timeout integer |
Default: 30 |
The socket level timeout in seconds. |
to_card string added in 2.6 |
Deprecated Starting with Ansible 2.8 we recommend using the module aci_access_port_block_to_access_port. The parameter will be removed in Ansible 2.12. The end (to-range) of the card range block for the leaf access port block.
| |
to_port string / required |
Deprecated Starting with Ansible 2.8 we recommend using the module aci_access_port_block_to_access_port. The parameter will be removed in Ansible 2.12. The end (to-range) of the port range block for the leaf access port block.
| |
use_proxy boolean |
|
If |
use_ssl boolean |
|
If |
username string |
Default: "admin" |
The username to use for authentication.
|
validate_certs boolean |
|
If This should only set to |
See Also
See also
- APIC Management Information Model reference
- More information about the internal APIC classes infra:HPortS, infra:RsAccBaseGrp and infra:PortBlk.
- 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: Associate an Interface Access Port Selector to an Interface Policy Leaf Profile with a Policy Group
aci_access_port_to_interface_policy_leaf_profile:
host: apic
username: admin
password: SomeSecretPassword
leaf_interface_profile: leafintprfname
access_port_selector: accessportselectorname
leaf_port_blk: leafportblkname
from_port: 13
to_port: 16
policy_group: policygroupname
state: present
delegate_to: localhost
- name: Associate an interface access port selector to an Interface Policy Leaf Profile (w/o policy group) (check if this works)
aci_access_port_to_interface_policy_leaf_profile:
host: apic
username: admin
password: SomeSecretPassword
leaf_interface_profile: leafintprfname
access_port_selector: accessportselectorname
leaf_port_blk: leafportblkname
from_port: 13
to_port: 16
state: present
delegate_to: localhost
- name: Remove an interface access port selector associated with an Interface Policy Leaf Profile
aci_access_port_to_interface_policy_leaf_profile:
host: apic
username: admin
password: SomeSecretPassword
leaf_interface_profile: leafintprfname
access_port_selector: accessportselectorname
state: absent
delegate_to: localhost
- name: Query Specific access_port_selector under given leaf_interface_profile
aci_access_port_to_interface_policy_leaf_profile:
host: apic
username: admin
password: SomeSecretPassword
leaf_interface_profile: leafintprfname
access_port_selector: accessportselectorname
state: query
delegate_to: localhost
register: query_result
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:
|
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: |
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)
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/aci_access_port_to_interface_policy_leaf_profile_module.html