cisco.dnac.interface (2.0.7) — module

Manage Interface objects of Devices

| "added in version" 1.0.0 of cisco.dnac"

Authors: Rafael Campos (@racampos)

This plugin has a corresponding action plugin.

Install collection

Install with ansible-galaxy collection install cisco.dnac:==2.0.7


Add to requirements.yml

  collections:
    - name: cisco.dnac
      version: 2.0.7

Description

Returns all available Interfaces. This endpoint can return a maximum of 500 Interfaces.

Returns the Interface for the given Interface ID.

Returns the count of Interfaces for all devices.

Returns list of Interfaces by specified IP address.

Returns list of Interfaces by specified device.

Returns the list of Interfaces for the device for the specified range.

Returns the Interface count for the given device.

Returns Interface by specified device Id and Interface name.

Returns the Interfaces that has ISIS enabled.

Returns the Interfaces that has OSPF enabled.


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: get_all_interfaces
  cisco.dnac.interface:
    state: query  # required
    limit: 1  #  number
    offset: 1  #  number
  register: nm_get_all_interfaces
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: get_interface_by_id
  cisco.dnac.interface:
    state: query  # required
    id: SomeValue  # string, required
  register: nm_get_interface_by_id
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: get_device_interface_count
  cisco.dnac.interface:
    state: query  # required
    count: True  # boolean, required
  register: nm_get_device_interface_count
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: get_interface_by_ip
  cisco.dnac.interface:
    state: query  # required
    ip_address: SomeValue  # string, required
  register: nm_get_interface_by_ip
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: get_interface_info_by_id
  cisco.dnac.interface:
    state: query  # required
    device_id: SomeValue  # string, required
  register: nm_get_interface_info_by_id
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: get_device_interfaces_by_specified_range
  cisco.dnac.interface:
    state: query  # required
    device_id: SomeValue  # string, required
    records_to_return: 1  #  integer, required
    start_index: 1  #  integer, required
  register: nm_get_device_interfaces_by_specified_range
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: get_device_interface_count_by_id
  cisco.dnac.interface:
    state: query  # required
    device_id: SomeValue  # string, required
    count: True  # boolean, required
  register: nm_get_device_interface_count_by_id
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: get_interface_details
  cisco.dnac.interface:
    state: query  # required
    device_id: SomeValue  # string, required
    name: SomeValue  # string, required
  register: nm_get_interface_details
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: get_isis_interfaces
  cisco.dnac.interface:
    state: query  # required
    isis: True  # boolean, required
  register: nm_get_isis_interfaces
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: get_ospf_interfaces
  cisco.dnac.interface:
    state: query  # required
    ospf: True  # boolean, required
  register: nm_get_ospf_interfaces

Inputs

    
id:
    description:
    - Interface ID.
    required: true
    type: str

isis:
    description:
    - Specifies that the Interface is isis.
    required: true
    type: bool

name:
    description:
    - Interface name.
    required: true
    type: str

ospf:
    description:
    - Specifies that the Interface is ospf.
    required: true
    type: bool

count:
    description:
    - If true gets the number of objects.
    required: true
    type: bool

limit:
    description:
    - Limit query parameter.
    type: int

offset:
    description:
    - Offset query parameter.
    type: int

device_id:
    description:
    - Device ID.
    required: true
    type: str

ip_address:
    description:
    - IP address of the Interface.
    required: true
    type: str

start_index:
    description:
    - Start index.
    required: true
    type: int

records_to_return:
    description:
    - Number of records to return.
    required: true
    type: int

Outputs

dnac_response:
  description: A dictionary with the response returned by the DNA Center Python SDK
  returned: always
  sample:
    response: 29
    version: '1.0'
  type: dict
missing_params:
  description: Provided arguments do not comply with the schema of the DNA Center
    Python SDK function
  returned: when the function request schema is not satisfied
  sample: null
  type: list
sdk_function:
  description: The DNA Center SDK function used to execute the task
  returned: always
  sample: devices.get_all_interfaces
  type: str

See also