cisco.dnac.device_interface_info (6.13.3) — module

Install collection

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

Add to requirements.yml

  collections:
    - name: cisco.dnac
      version: 6.13.3

Description

Get all Device Interface.

Get Device Interface by id.

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

Returns the interface for the given interface ID.

Requirements

• dnacentersdk >= 2.6.0
• python >= 3.9

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Get all Device Interface
  cisco.dnac.device_interface_info:
    dnac_host: "{{dnac_host}}"
    dnac_username: "{{dnac_username}}"
    dnac_password: "{{dnac_password}}"
    dnac_verify: "{{dnac_verify}}"
    dnac_port: "{{dnac_port}}"
    dnac_version: "{{dnac_version}}"
    dnac_debug: "{{dnac_debug}}"
    headers: "{{my_headers | from_json}}"
    offset: 0
    limit: 0
    lastInputTime: string
    lastOutputTime: string
  register: result

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Get Device Interface by id
  cisco.dnac.device_interface_info:
    dnac_host: "{{dnac_host}}"
    dnac_username: "{{dnac_username}}"
    dnac_password: "{{dnac_password}}"
    dnac_verify: "{{dnac_verify}}"
    dnac_port: "{{dnac_port}}"
    dnac_version: "{{dnac_version}}"
    dnac_debug: "{{dnac_debug}}"
    headers: "{{my_headers | from_json}}"
    id: string
  register: result

Inputs

    
id:
    description:
    - Id path parameter. Interface ID.
    type: str

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

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

headers:
    description: Additional headers.
    type: dict

dnac_host:
    description:
    - The Cisco DNA Center hostname.
    required: true
    type: str

dnac_port:
    default: 443
    description:
    - The Cisco DNA Center port.
    type: int

dnac_debug:
    default: false
    description:
    - Flag for Cisco DNA Center SDK to enable debugging.
    type: bool

dnac_verify:
    default: true
    description:
    - Flag to enable or disable SSL certificate verification.
    type: bool

dnac_version:
    default: 2.3.5.3
    description:
    - Informs the SDK which version of Cisco DNA Center to use.
    type: str

dnac_password:
    description:
    - The Cisco DNA Center password to authenticate.
    type: str

dnac_username:
    aliases:
    - user
    default: admin
    description:
    - The Cisco DNA Center username to authenticate.
    type: str

lastInputTime:
    description:
    - LastInputTime query parameter. Last Input Time.
    type: str

lastOutputTime:
    description:
    - LastOutputTime query parameter. Last Output Time.
    type: str

validate_response_schema:
    default: true
    description:
    - Flag for Cisco DNA Center SDK to enable the validation of request bodies against
      a JSON schema.
    type: bool

Outputs

dnac_response:
  description: A dictionary or list with the response returned by the Cisco DNAC Python
    SDK
  returned: always
  sample: "{\n  \"response\": {\n    \"adminStatus\": \"string\",\n    \"className\"\
    : \"string\",\n    \"description\": \"string\",\n    \"deviceId\": \"string\"\
    ,\n    \"duplex\": \"string\",\n    \"id\": \"string\",\n    \"ifIndex\": \"string\"\
    ,\n    \"instanceTenantId\": \"string\",\n    \"instanceUuid\": \"string\",\n\
    \    \"interfaceType\": \"string\",\n    \"ipv4Address\": \"string\",\n    \"\
    ipv4Mask\": \"string\",\n    \"isisSupport\": \"string\",\n    \"lastUpdated\"\
    : \"string\",\n    \"macAddress\": \"string\",\n    \"mappedPhysicalInterfaceId\"\
    : \"string\",\n    \"mappedPhysicalInterfaceName\": \"string\",\n    \"mediaType\"\
    : \"string\",\n    \"nativeVlanId\": \"string\",\n    \"ospfSupport\": \"string\"\
    ,\n    \"pid\": \"string\",\n    \"portMode\": \"string\",\n    \"portName\":\
    \ \"string\",\n    \"portType\": \"string\",\n    \"serialNo\": \"string\",\n\
    \    \"series\": \"string\",\n    \"speed\": \"string\",\n    \"status\": \"string\"\
    ,\n    \"vlanId\": \"string\",\n    \"voiceVlan\": \"string\"\n  },\n  \"version\"\
    : \"string\"\n}\n"
  type: dict

See also

• Cisco DNA Center documentation for Devices GetAllInterfaces: Complete reference of the GetAllInterfaces API. link
• Cisco DNA Center documentation for Devices GetInterfaceById: Complete reference of the GetInterfaceById API. link