cisco.aci.aci_interface_config module – Manage Interface Configuration of Access (infra:PortConfig) and Fabric (fabric:PortConfig) Ports is only supported for ACI 5.2(7)+

Note

This module is part of the cisco.aci collection (version 2.8.0).

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_interface_config.

Synopsis

  • Manage Interface Configuration of Access (infra:PortConfig) and Fabric (fabric:PortConfig) Ports is only supported for ACI 5.2(7)+

Parameters

Parameter

Comments

admin_state

string

The Admin State of the Interface.

The APIC defaults to up when unset during creation.

Choices:

  • "up"

  • "down"

annotation

string

User-defined string for annotating an object.

If the value is not specified in the task, the value of environment variable ACI_ANNOTATION will be used instead.

If the value is not specified in the task and environment variable ACI_ANNOTATION then the default value will be used.

Default: "orchestrator:ansible"

breakout

string

The Breakout Map of the interface.

The policy_group and breakout cannot be configured simultaneously.

Choices:

  • "100g-2x"

  • "100g-4x"

  • "10g-4x"

  • "25g-4x"

  • "50g-8x"

certificate_name

aliases: cert_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.

If the value is not specified in the task, the value of environment variable ACI_CERTIFICATE_NAME will be used instead.

description

aliases: descr

string

The description of the Interface Configuration object.

host

aliases: hostname

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 ACI_HOST will be used instead.

interface

string

The address of the interface.

The format of the interface value should be 1/1/1 (card/port_id/sub_port) or 1/1 (card/port_id).

The Card ID must be in the range of 1 to 64.

The Port ID must be in the range of 1 to 128.

The Sub Port ID must be in the range of 0 to 16

interface_type

string

The type of the interface.

Choices:

  • "switch_port" ← (default)

  • "pc_or_vpc"

  • "fc"

  • "fc_port_channel"

  • "leaf_fabric"

  • "spine_access"

  • "spine_fabric"

node

aliases: node_id

integer

The ID of the Node.

The value must be between 101 to 4000.

output_level

string

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

If the value is not specified in the task, the value of environment variable ACI_OUTPUT_LEVEL will be used instead.

Choices:

  • "debug"

  • "info"

  • "normal" ← (default)

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 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 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 ACI_OWNER_TAG will be used instead.

password

string

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.

If the value is not specified in the task, the value of environment variables ACI_PASSWORD or ANSIBLE_NET_PASSWORD will be used instead.

pc_member

aliases: port_channel_member

string

The name of the Port Channel Member.

policy_group

aliases: policy_group_name

string

The name of the Policy Group being associated with the Port.

The policy_group and breakout cannot be configured simultaneously.

port

integer

Port number to be used for REST connection.

The default value depends on parameter use_ssl.

If the value is not specified in the task, the value of environment variable ACI_PORT will be used instead.

port_type

string

The type of the interface can be either access or fabric.

Choices:

  • "access" ← (default)

  • "fabric"

private_key

aliases: cert_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 certificate_name that is used.

This option is mutual exclusive with password. If password is provided too, it will be ignored.

If the value is not specified in the task, the value of environment variable ACI_PRIVATE_KEY or ANSIBLE_NET_SSH_KEYFILE will be used instead.

role

aliases: node_type

string

The role of the switch (node) can be either a leaf or a spine.

The APIC defaults to leaf when unset during creation.

Choices:

  • "leaf"

  • "spine"

state

string

Use present or absent for adding or removing.

Use query for listing an object or multiple objects.

Choices:

  • "absent"

  • "present" ← (default)

  • "query"

timeout

integer

The socket level timeout in seconds.

If the value is not specified in the task, the value of environment variable ACI_TIMEOUT will be used instead.

The default value is 30.

use_proxy

boolean

If 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 ACI_USE_PROXY will be used instead.

The default value is true.

Choices:

  • false

  • true

use_ssl

boolean

If 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 ACI_USE_SSL will be used instead.

The default value is true when the connection is local.

Choices:

  • false

  • true

username

aliases: user

string

The username to use for authentication.

If the value is not specified in the task, the value of environment variables ACI_USERNAME or ANSIBLE_NET_USERNAME will be used instead.

The default value is admin.

validate_certs

boolean

If false, SSL certificates will not be validated.

This should only set to 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 ACI_VALIDATE_CERTS will be used instead.

The default value is true.

Choices:

  • false

  • true

See Also

See also

APIC Management Information Model reference

More information about the internal APIC class infra:PortConfig.

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: Add an interface with port channel(PC) policy group
  cisco.aci.aci_interface_config:
    host: apic
    username: admin
    password: SomeSecretPassword
    role: leaf
    port_type: access
    interface_type: port_channel
    policy_group: ans_test_port_channel
    node: 502
    interface: "2/2/2"
    state: present
  delegate_to: localhost

- name: Breakout the existing interface with "100g-4x"
  cisco.aci.aci_interface_config:
    host: apic
    username: admin
    password: SomeSecretPassword
    role: leaf
    port_type: access
    node: 502
    interface: "2/2/2"
    breakout: "100g-4x"
    state: present
  delegate_to: localhost

- name: Query an access interface with node id
  cisco.aci.aci_interface_config:
    host: apic
    username: admin
    password: SomeSecretPassword
    port_type: access
    node: 201
    state: query
  delegate_to: localhost

- name: Query a fabric interface with node id
  cisco.aci.aci_interface_config:
    host: apic
    username: admin
    password: SomeSecretPassword
    port_type: fabric
    node: 202
    state: query
  delegate_to: localhost

- name: Query all access interfaces
  cisco.aci.aci_interface_config:
    host: apic
    username: admin
    password: SomeSecretPassword
    port_type: access
    state: query
  delegate_to: localhost

- name: Query all fabric interfaces
  cisco.aci.aci_interface_config:
    host: apic
    username: admin
    password: SomeSecretPassword
    port_type: fabric
    state: query
  delegate_to: localhost

- name: Remove a interface
  cisco.aci.aci_interface_config:
    host: apic
    username: admin
    password: SomeSecretPassword
    port_type: access
    node: 201
    interface: "1/1/1"
    state: absent
  delegate_to: localhost

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

current

list / elements=string

The existing configuration from the APIC after the module has finished

Returned: success

Sample: [{"fvTenant": {"attributes": {"descr": "Production environment", "dn": "uni/tn-production", "name": "production", "nameAlias": "", "ownerKey": "", "ownerTag": ""}}}]

error

dictionary

The error information as returned from the APIC

Returned: failure

Sample: {"code": "122", "text": "unknown managed object class foo"}

filter_string

string

The filter string used for the request

Returned: failure or debug

Sample: "?rsp-prop-include=config-only"

method

string

The HTTP method used for the request to the APIC

Returned: failure or debug

Sample: "POST"

previous

list / elements=string

The original configuration from the APIC before the module has started

Returned: info

Sample: [{"fvTenant": {"attributes": {"descr": "Production", "dn": "uni/tn-production", "name": "production", "nameAlias": "", "ownerKey": "", "ownerTag": ""}}}]

proposed

dictionary

The assembled configuration from the user-provided parameters

Returned: info

Sample: {"fvTenant": {"attributes": {"descr": "Production environment", "name": "production"}}}

raw

string

The raw output returned by the APIC REST API (xml or json)

Returned: parse error

Sample: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><imdata totalCount=\"1\"><error code=\"122\" text=\"unknown managed object class foo\"/></imdata>"

response

string

The HTTP response from the APIC

Returned: failure or debug

Sample: "OK (30 bytes)"

sent

list / elements=string

The actual/minimal configuration pushed to the APIC

Returned: info

Sample: {"fvTenant": {"attributes": {"descr": "Production environment"}}}

status

integer

The HTTP status from the APIC

Returned: failure or debug

Sample: 200

url

string

The HTTP url used for the request to the APIC

Returned: failure or debug

Sample: "https://10.11.12.13/api/mo/uni/tn-production.json"

Authors

  • Sabari Jaganathan (@sajagana)