aci_access_port_to_interface_policy_leaf_profile
Manage Fabric interface policy leaf profile interface selectors (infra:HPortS, infra:RsAccBaseGrp, and infra:PortBlk)
Collection: cisco.aci
Full Name: cisco.aci.aci_access_port_to_interface_policy_leaf_profile
Synopsis
Manage Fabric interface policy leaf profile interface selectors (infra:HPortS, infra:RsAccBaseGrp, and infra:PortBlk)
Parameters
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
| access_port_selector | string | The name of the Fabric access policy leaf interface profile access port selector. | ||
| 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. | |
| 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. | ||
| description | string | The description to assign to the C(access_port_selector) | ||
| fex_id | int | Id of the fex profile, a valid FEX ID is between 101 to 199. | ||
| fex_profile | string | The name of the Fex Profile. Value of the fex_profile is overridden by the policy_group. | ||
| from_card | string | B(Deprecated) Starting with Ansible 2.8 we recommend using M(cisco.aci.aci_access_port_block_to_access_port) instead. The parameter will be removed in Ansible 2.12. HORIZONTALLINE The beginning (from-range) of the card range block for the leaf access port block. | ||
| from_port | string | B(Deprecated) Starting with Ansible 2.8 we recommend using M(cisco.aci.aci_access_port_block_to_access_port) instead. The parameter will be removed in Ansible 2.12. HORIZONTALLINE The beginning (from-range) of the port range block for the leaf access port block. | ||
| 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. | ||
| interface_profile | string | The name of the Fabric access policy leaf interface profile. | ||
| interface_type | string | switch_port | The type of interface for the static EPG deployment. The interface_type fex_profile can not be configured with a profile of type fex. | |
| leaf_port_blk_description | string | B(Deprecated) Starting with Ansible 2.8 we recommend using M(cisco.aci.aci_access_port_block_to_access_port) instead. The parameter will be removed in Ansible 2.12. HORIZONTALLINE The description to assign to the C(leaf_port_blk) | ||
| 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. | ||
| policy_group | string | The name of the fabric access policy group to be associated with the leaf interface profile interface selector. | ||
| 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_blk | string | B(Deprecated) Starting with Ansible 2.8 we recommend using M(cisco.aci.aci_access_port_block_to_access_port) instead. The parameter will be removed in Ansible 2.12. HORIZONTALLINE The name of the Fabric access policy leaf interface profile access port block. | ||
| 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. | ||
| state | string | present | Use C(present) or C(absent) for adding or removing. Use C(query) for listing an object or multiple objects. | |
| 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. | ||
| 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. | ||
| to_card | string | B(Deprecated) Starting with Ansible 2.8 we recommend using M(cisco.aci.aci_access_port_block_to_access_port) instead. The parameter will be removed in Ansible 2.12. HORIZONTALLINE The end (to-range) of the card range block for the leaf access port block. | ||
| to_port | string | B(Deprecated) Starting with Ansible 2.8 we recommend using M(cisco.aci.aci_access_port_block_to_access_port) instead. The parameter will be removed in Ansible 2.12. HORIZONTALLINE The end (to-range) of the port range block for the leaf access port block. | ||
| type | string | leaf | The type of access port to be created under respective profile. | |
| 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_access_port_to_interface_policy_leaf_profile": {"access_port_selector": "accessportselectorname", "from_port": 13, "host": "apic", "interface_profile": "leafintprfname", "password": "SomeSecretPassword", "policy_group": "policygroupname", "port_blk": "leafportblkname", "state": "present", "to_port": 16, "username": "admin"}, "delegate_to": "localhost", "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": {"access_port_selector": "accessportselectorname", "from_port": 13, "host": "apic", "interface_profile": "leafintprfname", "password": "SomeSecretPassword", "port_blk": "leafportblkname", "state": "present", "to_port": 16, "username": "admin"}, "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": {"access_port_selector": "accessportselectorname", "host": "apic", "interface_profile": "leafintprfname", "password": "SomeSecretPassword", "state": "absent", "username": "admin"}, "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": {"access_port_selector": "accessportselectorname", "host": "apic", "interface_profile": "fexintprfname", "password": "SomeSecretPassword", "state": "absent", "username": "admin"}, "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": {"access_port_selector": "accessportselectorname", "host": "apic", "interface_profile": "leafintprfname", "password": "SomeSecretPassword", "state": "query", "username": "admin"}, "delegate_to": "localhost", "name": "Query Specific access_port_selector under given leaf_interface_profile", "register": "query_result"}
- {"cisco.aci.aci_access_port_to_interface_policy_leaf_profile": {"access_port_selector": "accessportselectorname", "host": "apic", "interface_profile": "fexintprfname", "password": "SomeSecretPassword", "state": "query", "username": "admin"}, "delegate_to": "localhost", "name": "Query Specific access_port_selector under given Fex leaf_interface_profile", "register": "query_result"}
- {"cisco.aci.aci_access_port_to_interface_policy_leaf_profile": {"access_port_selector_name": "anstest_fex_accessportselector", "fex_id": 105, "fex_profile": "fexintprftest", "from_port": 13, "host": "apic", "interface_type": "fex_profile", "leaf_interface_profile": "leafintprftest", "password": "SomeSecretPassword", "policy_group": "fexintprftest", "port_blk": "block2", "state": "present", "to_port": 13, "username": "admin"}, "delegate_to": "localhost", "name": "Create and Bind Access Port Selector with Fex Profile Policy Group"}
- {"cisco.aci.aci_access_port_to_interface_policy_leaf_profile": {"access_port_selector": "accessportselectorname", "access_port_selector_name": "anstest_pc_accessportselector", "from_port": 13, "host": "apic", "interface_profile": "leafintprfname", "interface_type": "port_channel", "password": "SomeSecretPassword", "policy_group": "pcintprftest", "port_blk": "leafportblkname", "state": "present", "to_port": 13, "username": "admin"}, "delegate_to": "localhost", "name": "Create and Bind Access Port Selector with PC Policy Group"}
- {"cisco.aci.aci_access_port_to_interface_policy_leaf_profile": {"access_port_selector": "accessportselectorname", "access_port_selector_name": "anstest_vpc_accessportselector", "from_port": 13, "host": "apic", "interface_profile": "leafintprfname", "interface_type": "vpc", "password": "SomeSecretPassword", "policy_group": "vpcintprftest", "port_blk": "leafportblkname", "state": "present", "to_port": 13, "username": "admin"}, "delegate_to": "localhost", "name": "Create and Bind Access Port Selector with VPC Policy Group"}