/ home / cisco / cisco.dnac / 6.13.3 / module / interface_info

cisco.dnac.interface_info (6.13.3) — module

Information module for Interface

| "added in version" 6.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:==6.13.3

Add to requirements.yml

  collections:
    - name: cisco.dnac
      version: 6.13.3

Description

Get all Interface.

Get list of all properties & operations valid for an interface.

Requirements

dnacentersdk >= 2.6.0
python >= 3.9

Usage examples

Scanned by Steampunk Spotter

- name: Get all Interface
  cisco.dnac.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}}"
    interfaceUuid: string
  register: result

Inputs

    
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

interfaceUuid:
    description:
    - InterfaceUuid path parameter. Interface ID.
    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    \"type\": \"string\",\n    \"properties\": {\n\
    \      \"interfaceUuid\": {\n        \"type\": \"string\"\n      },\n      \"\
    properties\": {\n        \"type\": \"string\",\n        \"items\": [\n       \
    \   {\n            \"type\": \"string\",\n            \"properties\": {\n    \
    \          \"name\": {\n                \"type\": \"string\"\n              },\n\
    \              \"applicable\": {\n                \"type\": \"string\"\n     \
    \         },\n              \"failureReason\": {\n                \"type\": \"\
    string\"\n              }\n            },\n            \"required\": [\n     \
    \         \"string\"\n            ]\n          }\n        ]\n      },\n      \"\
    operations\": {\n        \"type\": \"string\",\n        \"items\": [\n       \
    \   {\n            \"type\": \"string\",\n            \"properties\": {\n    \
    \          \"name\": {\n                \"type\": \"string\"\n              },\n\
    \              \"applicable\": {\n                \"type\": \"string\"\n     \
    \         },\n              \"failureReason\": {\n                \"type\": \"\
    string\"\n              }\n            },\n            \"required\": [\n     \
    \         \"string\"\n            ]\n          }\n        ]\n      }\n    },\n\
    \    \"required\": [\n      \"string\"\n    ]\n  },\n  \"version\": {\n    \"\
    type\": \"string\"\n  }\n}\n"
  type: dict