New in version 2.5.
Parameter | Choices/Defaults | Comments |
---|---|---|
access_port_selector required | The name of the Fabric access policy leaf interface profile access port selector. aliases: name, access_port_selector_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 | The description to assign to the access_port_selector
| |
from_card (added in 2.6) | The beginning (from-range) of the card range block for the leaf access port block. aliases: from_card_range | |
from_port required | The beginning (from-range) of the port range block for the leaf access port block. aliases: from, fromPort, from_port_range | |
host required | IP Address or hostname of APIC resolvable by Ansible control host. aliases: hostname | |
interface_type (added in 2.6) |
| The type of interface for the static EPG deployement. |
leaf_interface_profile required | The name of the Fabric access policy leaf interface profile. aliases: leaf_interface_profile_name | |
leaf_port_blk required | The name of the Fabric access policy leaf interface profile access port block. aliases: leaf_port_blk_name | |
leaf_port_blk_description | The description to assign to the leaf_port_blk
| |
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 | The name of the fabric access policy group to be associated with the leaf interface profile interface selector. aliases: policy_group_name | |
port | Port number to be used for REST connection. The default value depends on parameter `use_ssl`. | |
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 | |
state |
| Use present or absent for adding or removing.Use query for listing an object or multiple objects. |
timeout int | Default: 30 | The socket level timeout in seconds. |
to_card (added in 2.6) | The end (to-range) of the card range block for the leaf access port block. aliases: to_card_range | |
to_port required | The end (to-range) of the port range block for the leaf access port block. aliases: to, toPort, to_port_range | |
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
- 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 toi_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
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_access_port_to_interface_policy_leaf_profile_module.html