cisco.aci.aci_access_port_to_interface_policy_leaf_profile module – Manage Fabric interface policy leaf profile interface selectors (infra:HPortS, infra:RsAccBaseGrp, and infra:PortBlk)
Note
This module is part of the cisco.aci collection (version 2.10.1).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install cisco.aci
.
To use it in a playbook, specify: cisco.aci.aci_access_port_to_interface_policy_leaf_profile
.
Synopsis
Manage Fabric interface policy leaf profile interface selectors on Cisco ACI fabrics.
Parameters
Parameter |
Comments |
---|---|
The name of the Fabric access policy leaf interface profile access port selector. |
|
User-defined string for annotating an object. If the value is not specified in the task, the value of environment variable If the value is not specified in the task and environment variable Default: |
|
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 |
|
The description to assign to the |
|
Id of the fex profile, a valid FEX ID is between 101 to 199. |
|
The name of the Fex Profile. Value of the fex_profile is overridden by the policy_group. |
|
Deprecated Starting with Ansible 2.8 we recommend using cisco.aci.aci_access_port_block_to_access_port instead. The parameter will be removed in Ansible 2.12. <hr> The beginning (from-range) of the card range block for the leaf access port block. |
|
Deprecated Starting with Ansible 2.8 we recommend using cisco.aci.aci_access_port_block_to_access_port instead. The parameter will be removed in Ansible 2.12. <hr> The beginning (from-range) of the port range block for the leaf access port block. |
|
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 |
|
The name of the Fabric access policy leaf interface profile. |
|
The type of interface for the static EPG deployment. The interface_type fex_profile can not be configured with a profile of type fex. Choices:
|
|
Deprecated Starting with Ansible 2.8 we recommend using cisco.aci.aci_access_port_block_to_access_port instead. The parameter will be removed in Ansible 2.12. <hr> The description to assign to the |
|
Influence the output of this ACI module.
If the value is not specified in the task, the value of environment variable Choices:
|
|
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 |
|
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 |
|
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 |
|
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 |
|
The name of the fabric access policy group to be associated with the leaf interface profile interface selector. |
|
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 |
|
Deprecated Starting with Ansible 2.8 we recommend using cisco.aci.aci_access_port_block_to_access_port instead. The parameter will be removed in Ansible 2.12. <hr> The name of the Fabric access policy leaf interface profile access port block. |
|
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 |
|
Use Use Choices:
|
|
If If the value is not specified in the task, the value of environment variable The default value is 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. Choices:
|
|
If If the value is not specified in the task, the value of environment variable The default value is 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. Choices:
|
|
The socket level timeout in seconds. If the value is not specified in the task, the value of environment variable The default value is 30. |
|
Deprecated Starting with Ansible 2.8 we recommend using cisco.aci.aci_access_port_block_to_access_port instead. The parameter will be removed in Ansible 2.12. <hr> The end (to-range) of the card range block for the leaf access port block. |
|
Deprecated Starting with Ansible 2.8 we recommend using cisco.aci.aci_access_port_block_to_access_port instead. The parameter will be removed in Ansible 2.12. <hr> The end (to-range) of the port range block for the leaf access port block. |
|
The type of access port to be created under respective profile. Choices:
|
|
If If the value is not specified in the task, the value of environment variable The default value is true. Choices:
|
|
If If the value is not specified in the task, the value of environment variable The default value is true when the connection is local. Choices:
|
|
The username to use for authentication. If the value is not specified in the task, the value of environment variables The default value is admin. |
|
If This should only set to If the value is not specified in the task, the value of environment variable The default value is true. Choices:
|
Notes
Note
The
interface_profile
must exist before using this module in your playbook. The cisco.aci.aci_interface_policy_leaf_profile modules can be used for this.
See Also
See also
- cisco.aci.aci_access_port_block_to_access_port
Manage Port blocks of Fabric Access Leaf/Spine Interface Port Selectors (infra:PortBlk).
- 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
cisco.aci.aci_access_port_to_interface_policy_leaf_profile:
host: apic
username: admin
password: SomeSecretPassword
interface_profile: leafintprfname
access_port_selector: accessportselectorname
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)
cisco.aci.aci_access_port_to_interface_policy_leaf_profile:
host: apic
username: admin
password: SomeSecretPassword
interface_profile: leafintprfname
access_port_selector: accessportselectorname
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
cisco.aci.aci_access_port_to_interface_policy_leaf_profile:
host: apic
username: admin
password: SomeSecretPassword
interface_profile: leafintprfname
access_port_selector: accessportselectorname
state: absent
delegate_to: localhost
- name: Remove an interface access port selector associated with an Interface Policy Fex Profile
cisco.aci.aci_access_port_to_interface_policy_leaf_profile:
host: apic
username: admin
password: SomeSecretPassword
interface_profile: fexintprfname
access_port_selector: accessportselectorname
state: absent
delegate_to: localhost
- name: Query Specific access_port_selector under given leaf_interface_profile
cisco.aci.aci_access_port_to_interface_policy_leaf_profile:
host: apic
username: admin
password: SomeSecretPassword
interface_profile: leafintprfname
access_port_selector: accessportselectorname
state: query
delegate_to: localhost
register: query_result
- name: Query Specific access_port_selector under given Fex leaf_interface_profile
cisco.aci.aci_access_port_to_interface_policy_leaf_profile:
host: apic
username: admin
password: SomeSecretPassword
interface_profile: fexintprfname
access_port_selector: accessportselectorname
state: query
delegate_to: localhost
register: query_result
- name: Create and Bind Access Port Selector with Fex Profile Policy Group
cisco.aci.aci_access_port_to_interface_policy_leaf_profile:
host: apic
username: admin
password: SomeSecretPassword
leaf_interface_profile: leafintprftest
fex_profile: fexintprftest
policy_group: fexintprftest
access_port_selector_name: anstest_fex_accessportselector
interface_type: fex_profile
from_port: 13
to_port: 13
port_blk: block2
fex_id: 105
state: present
delegate_to: localhost
- name: Create and Bind Access Port Selector with PC Policy Group
cisco.aci.aci_access_port_to_interface_policy_leaf_profile:
host: apic
username: admin
password: SomeSecretPassword
interface_profile: leafintprfname
access_port_selector: accessportselectorname
policy_group: pcintprftest
access_port_selector_name: anstest_pc_accessportselector
interface_type: port_channel
port_blk: leafportblkname
from_port: 13
to_port: 13
state: present
delegate_to: localhost
- name: Create and Bind Access Port Selector with VPC Policy Group
cisco.aci.aci_access_port_to_interface_policy_leaf_profile:
host: apic
username: admin
password: SomeSecretPassword
interface_profile: leafintprfname
access_port_selector: accessportselectorname
policy_group: vpcintprftest
access_port_selector_name: anstest_vpc_accessportselector
interface_type: vpc
port_blk: leafportblkname
from_port: 13
to_port: 13
state: present
delegate_to: localhost
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
The existing configuration from the APIC after the module has finished Returned: success Sample: |
|
The error information as returned from the APIC Returned: failure Sample: |
|
The filter string used for the request Returned: failure or debug Sample: |
|
The HTTP method used for the request to the APIC Returned: failure or debug Sample: |
|
The original configuration from the APIC before the module has started Returned: info Sample: |
|
The assembled configuration from the user-provided parameters Returned: info Sample: |
|
The raw output returned by the APIC REST API (xml or json) Returned: parse error Sample: |
|
The HTTP response from the APIC Returned: failure or debug Sample: |
|
The actual/minimal configuration pushed to the APIC Returned: info Sample: |
|
The HTTP status from the APIC Returned: failure or debug Sample: |
|
The HTTP url used for the request to the APIC Returned: failure or debug Sample: |