aci_access_port_block_to_access_port – Manage port blocks of Fabric interface policy leaf profile interface selectors (infra:HPortS, infra:PortBlk) — Ansible Documentation

- AnsibleFest
- Products
- Community
- Webinars & Training
- Blog

Documentation

# aci_access_port_block_to_access_port – Manage port blocks of Fabric interface policy leaf profile interface selectors (infra:HPortS, infra:PortBlk)

New in version 2.8.

- Synopsis
- Parameters
- See Also
- Examples
- Return Values
- Status

## Synopsis

- Manage port blocks of 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. aliases: name, access_port_selector_name
certificate_name string |  | The X.509 certificate name attached to the APIC AAA user used for signature-based authentication. If a `private_key` filename was provided, this defaults to the `private_key` basename, without extension. If PEM-formatted content was provided for `private_key`, this defaults to the `username` value. aliases: cert_name
from_card string |  | The beginning (from-range) of the card range block for the leaf access port block. aliases: from_card_range
from_port string / required |  | The beginning (from-range) of the port range block for the leaf access port block. aliases: from, fromPort, from_port_range
host string / required |  | IP Address or hostname of APIC resolvable by Ansible control host. aliases: hostname
leaf_interface_profile string / required |  | The name of the Fabric access policy leaf interface profile. aliases: leaf_interface_profile_name
leaf_port_blk string / 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 string | Choices: debug info normal ← | Influence the output of this ACI module. `normal` means the standard output, incl. `current` dict `info` adds informational output, incl. `previous`, `proposed` and `sent` dicts `debug` adds debugging output, incl. `filter_string`, `method`, `response`, `status` and `url` information
password string / 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.
port integer |  | Port number to be used for REST connection. The default value depends on parameter `use_ssl`.
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 `certificate_name` that is used. This option is mutual exclusive with `password`. If `password` is provided too, it will be ignored. aliases: cert_key
state string | Choices: absent present ← query | Use `present` or `absent` for adding or removing. Use `query` for listing an object or multiple objects.
timeout integer | Default: 30 | The socket level timeout in seconds.
to_card string |  | The end (to-range) of the card range block for the leaf access port block. aliases: to_card_range
to_port string / required |  | The end (to-range) of the port range block for the leaf access port block. aliases: to, toPort, to_port_range
use_proxy boolean | Choices: no yes ← | If `no`, it will not use a proxy, even if one is defined in an environment variable on the target hosts.
use_ssl boolean | Choices: no yes ← | If `no`, an HTTP connection will be used instead of the default HTTPS connection.
username string | Default: "admin" | The username to use for authentication. aliases: user
validate_certs boolean | Choices: no yes ← | If `no`, SSL certificates will not be validated. This should only set to `no` when used on personally controlled sites using self-signed certificates.

## See Also

See also

APIC Management Information Model reference
  More information about the internal APIC classes infra:HPortS 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 access port block (single port) to an interface selector
      aci_access_port_block_to_access_port:
        host: apic
        username: admin
        password: SomeSecretPassword
        leaf_interface_profile: leafintprfname
        access_port_selector: accessportselectorname
        leaf_port_blk: leafportblkname
        from_port: 13
        to_port: 13
        state: present
      delegate_to: localhost

    - name: Associate an access port block (port range) to an interface selector
      aci_access_port_block_to_access_port:
        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 access port block from an interface selector
      aci_access_port_block_to_access_port:
        host: apic
        username: admin
        password: SomeSecretPassword
        leaf_interface_profile: leafintprfname
        access_port_selector: accessportselectorname
        leaf_port_blk: leafportblkname
        from_port: 13
        to_port: 13
        state: absent
      delegate_to: localhost

    - name: Query Specific access port block under given access port selector
      aci_access_port_block_to_access_port:
        host: apic
        username: admin
        password: SomeSecretPassword
        leaf_interface_profile: leafintprfname
        access_port_selector: accessportselectorname
        leaf_port_blk: leafportblkname
        state: query
      delegate_to: localhost
      register: query_result

    - name: Query all access port blocks under given leaf interface profile
      aci_access_port_block_to_access_port:
        host: apic
        username: admin
        password: SomeSecretPassword
        leaf_interface_profile: leafintprfname
        state: query
      delegate_to: localhost
      register: query_result

    - name: Query all access port blocks in the fabric
      aci_access_port_block_to_access_port:
        host: apic
        username: admin
        password: SomeSecretPassword
        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': {'dn': 'uni/tn-production', 'ownerKey': '', 'name': 'production', 'descr': 'Production environment', 'nameAlias': '', 'ownerTag': ''}}}]
error dictionary | 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 dictionary | 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 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: https://10.11.12.13/api/mo/uni/tn-production.json

## Status

- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by an Ansible Partner. [certified]

### Authors

- Simon Metzger (@smnmtzgr)

Hint

If you notice any issues in this documentation you can edit this document to improve it.