racampos.dnac.interface (0.0.1) — module

Manage Interface objects of Devices

| "added in version" 1.0 of racampos.dnac"

Authors: first last (@GitHubID)

preview | supported by community

This plugin has a corresponding action plugin.

Install collection

Install with ansible-galaxy collection install racampos.dnac:==0.0.1


Add to requirements.yml

  collections:
    - name: racampos.dnac
      version: 0.0.1

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: query_result
  • 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: query_result
  • 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: query_result
  • 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: query_result
  • 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: query_result
  • 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: query_result
  • 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: query_result
  • 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: query_result
  • 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: query_result
  • 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: query_result

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

get_all_interfaces:
  contains: null
  description: Returns all available Interfaces. This endpoint can return a maximum
    of 500 Interfaces.
  response:
    contains:
      adminStatus:
        description: It is the Interface's adminStatus.
        returned: always
        sample: <adminstatus>
        type: str
      className:
        description: It is the Interface's className.
        returned: always
        sample: <classname>
        type: str
      description:
        description: It is the Interface's description.
        returned: always
        sample: <description>
        type: str
      deviceId:
        description: It is the Interface's deviceId.
        returned: always
        sample: <deviceid>
        type: str
      duplex:
        description: It is the Interface's duplex.
        returned: always
        sample: <duplex>
        type: str
      id:
        description: It is the Interface's id.
        returned: always
        sample: '478012'
        type: str
      ifIndex:
        description: It is the Interface's ifIndex.
        returned: always
        sample: <ifindex>
        type: str
      instanceTenantId:
        description: It is the Interface's instanceTenantId.
        returned: always
        sample: <instancetenantid>
        type: str
      instanceUuid:
        description: It is the Interface's instanceUuid.
        returned: always
        sample: <instanceuuid>
        type: str
      interfaceType:
        description: It is the Interface's InterfaceType.
        returned: always
        sample: <interfacetype>
        type: str
      ipv4Address:
        description: It is the Interface's ipv4Address.
        returned: always
        sample: <ipv4address>
        type: str
      ipv4Mask:
        description: It is the Interface's ipv4Mask.
        returned: always
        sample: <ipv4mask>
        type: str
      isisSupport:
        description: It is the Interface's isisSupport.
        returned: always
        sample: <isissupport>
        type: str
      lastUpdated:
        description: It is the Interface's lastUpdated.
        returned: always
        sample: <lastupdated>
        type: str
      macAddress:
        description: It is the Interface's macAddress.
        returned: always
        sample: <macaddress>
        type: str
      mappedPhysicalInterfaceId:
        description: It is the Interface's mappedPhysicalInterfaceId.
        returned: always
        sample: <mappedphysicalinterfaceid>
        type: str
      mappedPhysicalInterfaceName:
        description: It is the Interface's mappedPhysicalInterfaceName.
        returned: always
        sample: <mappedphysicalinterfacename>
        type: str
      mediaType:
        description: It is the Interface's mediaType.
        returned: always
        sample: <mediatype>
        type: str
      nativeVlanId:
        description: It is the Interface's nativeVlanId.
        returned: always
        sample: <nativevlanid>
        type: str
      ospfSupport:
        description: It is the Interface's ospfSupport.
        returned: always
        sample: <ospfsupport>
        type: str
      pid:
        description: It is the Interface's pid.
        returned: always
        sample: <pid>
        type: str
      portMode:
        description: It is the Interface's portMode.
        returned: always
        sample: <portmode>
        type: str
      portName:
        description: It is the Interface's portName.
        returned: always
        sample: <portname>
        type: str
      portType:
        description: It is the Interface's portType.
        returned: always
        sample: <porttype>
        type: str
      serialNo:
        description: It is the Interface's serialNo.
        returned: always
        sample: <serialno>
        type: str
      series:
        description: It is the Interface's series.
        returned: always
        sample: <series>
        type: str
      speed:
        description: It is the Interface's speed.
        returned: always
        sample: <speed>
        type: str
      status:
        description: It is the Interface's status.
        returned: always
        sample: <status>
        type: str
      vlanId:
        description: It is the Interface's vlanId.
        returned: always
        sample: <vlanid>
        type: str
      voiceVlan:
        description: It is the Interface's voiceVlan.
        returned: always
        sample: <voicevlan>
        type: str
    description: Response, property of the response body (list of objects).
    returned: always
    type: list
  returned: always
  type: dict
  version:
    description: Version, property of the response body.
    returned: always
    sample: '1.0'
    type: str
get_device_interface_count:
  contains: null
  description: Returns the count of Interfaces for all devices.
  response:
    description: Response, property of the response body.
    returned: always
    sample: 0
    type: int
  returned: always
  type: dict
  version:
    description: Version, property of the response body.
    returned: always
    sample: '1.0'
    type: str
get_device_interface_count_by_id:
  contains: null
  description: Returns the Interface count for the given device.
  response:
    description: Response, property of the response body.
    returned: always
    sample: 0
    type: int
  returned: always
  type: dict
  version:
    description: Version, property of the response body.
    returned: always
    sample: '1.0'
    type: str
get_device_interfaces_by_specified_range:
  contains: null
  description: Returns the list of Interfaces for the device for the specified range.
  response:
    contains:
      adminStatus:
        description: It is the Interface's adminStatus.
        returned: always
        sample: <adminstatus>
        type: str
      className:
        description: It is the Interface's className.
        returned: always
        sample: <classname>
        type: str
      description:
        description: It is the Interface's description.
        returned: always
        sample: <description>
        type: str
      deviceId:
        description: It is the Interface's deviceId.
        returned: always
        sample: <deviceid>
        type: str
      duplex:
        description: It is the Interface's duplex.
        returned: always
        sample: <duplex>
        type: str
      id:
        description: It is the Interface's id.
        returned: always
        sample: '478012'
        type: str
      ifIndex:
        description: It is the Interface's ifIndex.
        returned: always
        sample: <ifindex>
        type: str
      instanceTenantId:
        description: It is the Interface's instanceTenantId.
        returned: always
        sample: <instancetenantid>
        type: str
      instanceUuid:
        description: It is the Interface's instanceUuid.
        returned: always
        sample: <instanceuuid>
        type: str
      interfaceType:
        description: It is the Interface's InterfaceType.
        returned: always
        sample: <interfacetype>
        type: str
      ipv4Address:
        description: It is the Interface's ipv4Address.
        returned: always
        sample: <ipv4address>
        type: str
      ipv4Mask:
        description: It is the Interface's ipv4Mask.
        returned: always
        sample: <ipv4mask>
        type: str
      isisSupport:
        description: It is the Interface's isisSupport.
        returned: always
        sample: <isissupport>
        type: str
      lastUpdated:
        description: It is the Interface's lastUpdated.
        returned: always
        sample: <lastupdated>
        type: str
      macAddress:
        description: It is the Interface's macAddress.
        returned: always
        sample: <macaddress>
        type: str
      mappedPhysicalInterfaceId:
        description: It is the Interface's mappedPhysicalInterfaceId.
        returned: always
        sample: <mappedphysicalinterfaceid>
        type: str
      mappedPhysicalInterfaceName:
        description: It is the Interface's mappedPhysicalInterfaceName.
        returned: always
        sample: <mappedphysicalinterfacename>
        type: str
      mediaType:
        description: It is the Interface's mediaType.
        returned: always
        sample: <mediatype>
        type: str
      nativeVlanId:
        description: It is the Interface's nativeVlanId.
        returned: always
        sample: <nativevlanid>
        type: str
      ospfSupport:
        description: It is the Interface's ospfSupport.
        returned: always
        sample: <ospfsupport>
        type: str
      pid:
        description: It is the Interface's pid.
        returned: always
        sample: <pid>
        type: str
      portMode:
        description: It is the Interface's portMode.
        returned: always
        sample: <portmode>
        type: str
      portName:
        description: It is the Interface's portName.
        returned: always
        sample: <portname>
        type: str
      portType:
        description: It is the Interface's portType.
        returned: always
        sample: <porttype>
        type: str
      serialNo:
        description: It is the Interface's serialNo.
        returned: always
        sample: <serialno>
        type: str
      series:
        description: It is the Interface's series.
        returned: always
        sample: <series>
        type: str
      speed:
        description: It is the Interface's speed.
        returned: always
        sample: <speed>
        type: str
      status:
        description: It is the Interface's status.
        returned: always
        sample: <status>
        type: str
      vlanId:
        description: It is the Interface's vlanId.
        returned: always
        sample: <vlanid>
        type: str
      voiceVlan:
        description: It is the Interface's voiceVlan.
        returned: always
        sample: <voicevlan>
        type: str
    description: Response, property of the response body (list of objects).
    returned: always
    type: list
  returned: always
  type: dict
  version:
    description: Version, property of the response body.
    returned: always
    sample: '1.0'
    type: str
get_interface_by_id:
  contains: null
  description: Returns the Interface for the given Interface ID.
  response:
    contains:
      adminStatus:
        description: It is the Interface's adminStatus.
        returned: always
        sample: <adminstatus>
        type: str
      className:
        description: It is the Interface's className.
        returned: always
        sample: <classname>
        type: str
      description:
        description: It is the Interface's description.
        returned: always
        sample: <description>
        type: str
      deviceId:
        description: It is the Interface's deviceId.
        returned: always
        sample: <deviceid>
        type: str
      duplex:
        description: It is the Interface's duplex.
        returned: always
        sample: <duplex>
        type: str
      id:
        description: It is the Interface's id.
        returned: always
        sample: '478012'
        type: str
      ifIndex:
        description: It is the Interface's ifIndex.
        returned: always
        sample: <ifindex>
        type: str
      instanceTenantId:
        description: It is the Interface's instanceTenantId.
        returned: always
        sample: <instancetenantid>
        type: str
      instanceUuid:
        description: It is the Interface's instanceUuid.
        returned: always
        sample: <instanceuuid>
        type: str
      interfaceType:
        description: It is the Interface's InterfaceType.
        returned: always
        sample: <interfacetype>
        type: str
      ipv4Address:
        description: It is the Interface's ipv4Address.
        returned: always
        sample: <ipv4address>
        type: str
      ipv4Mask:
        description: It is the Interface's ipv4Mask.
        returned: always
        sample: <ipv4mask>
        type: str
      isisSupport:
        description: It is the Interface's isisSupport.
        returned: always
        sample: <isissupport>
        type: str
      lastUpdated:
        description: It is the Interface's lastUpdated.
        returned: always
        sample: <lastupdated>
        type: str
      macAddress:
        description: It is the Interface's macAddress.
        returned: always
        sample: <macaddress>
        type: str
      mappedPhysicalInterfaceId:
        description: It is the Interface's mappedPhysicalInterfaceId.
        returned: always
        sample: <mappedphysicalinterfaceid>
        type: str
      mappedPhysicalInterfaceName:
        description: It is the Interface's mappedPhysicalInterfaceName.
        returned: always
        sample: <mappedphysicalinterfacename>
        type: str
      mediaType:
        description: It is the Interface's mediaType.
        returned: always
        sample: <mediatype>
        type: str
      nativeVlanId:
        description: It is the Interface's nativeVlanId.
        returned: always
        sample: <nativevlanid>
        type: str
      ospfSupport:
        description: It is the Interface's ospfSupport.
        returned: always
        sample: <ospfsupport>
        type: str
      pid:
        description: It is the Interface's pid.
        returned: always
        sample: <pid>
        type: str
      portMode:
        description: It is the Interface's portMode.
        returned: always
        sample: <portmode>
        type: str
      portName:
        description: It is the Interface's portName.
        returned: always
        sample: <portname>
        type: str
      portType:
        description: It is the Interface's portType.
        returned: always
        sample: <porttype>
        type: str
      serialNo:
        description: It is the Interface's serialNo.
        returned: always
        sample: <serialno>
        type: str
      series:
        description: It is the Interface's series.
        returned: always
        sample: <series>
        type: str
      speed:
        description: It is the Interface's speed.
        returned: always
        sample: <speed>
        type: str
      status:
        description: It is the Interface's status.
        returned: always
        sample: <status>
        type: str
      vlanId:
        description: It is the Interface's vlanId.
        returned: always
        sample: <vlanid>
        type: str
      voiceVlan:
        description: It is the Interface's voiceVlan.
        returned: always
        sample: <voicevlan>
        type: str
    description: Response, property of the response body.
    returned: always
    type: dict
  returned: always
  type: dict
  version:
    description: Version, property of the response body.
    returned: always
    sample: '1.0'
    type: str
get_interface_by_ip:
  contains: null
  description: Returns list of Interfaces by specified IP address.
  response:
    contains:
      adminStatus:
        description: It is the Interface's adminStatus.
        returned: always
        sample: <adminstatus>
        type: str
      className:
        description: It is the Interface's className.
        returned: always
        sample: <classname>
        type: str
      description:
        description: It is the Interface's description.
        returned: always
        sample: <description>
        type: str
      deviceId:
        description: It is the Interface's deviceId.
        returned: always
        sample: <deviceid>
        type: str
      duplex:
        description: It is the Interface's duplex.
        returned: always
        sample: <duplex>
        type: str
      id:
        description: It is the Interface's id.
        returned: always
        sample: '478012'
        type: str
      ifIndex:
        description: It is the Interface's ifIndex.
        returned: always
        sample: <ifindex>
        type: str
      instanceTenantId:
        description: It is the Interface's instanceTenantId.
        returned: always
        sample: <instancetenantid>
        type: str
      instanceUuid:
        description: It is the Interface's instanceUuid.
        returned: always
        sample: <instanceuuid>
        type: str
      interfaceType:
        description: It is the Interface's InterfaceType.
        returned: always
        sample: <interfacetype>
        type: str
      ipv4Address:
        description: It is the Interface's ipv4Address.
        returned: always
        sample: <ipv4address>
        type: str
      ipv4Mask:
        description: It is the Interface's ipv4Mask.
        returned: always
        sample: <ipv4mask>
        type: str
      isisSupport:
        description: It is the Interface's isisSupport.
        returned: always
        sample: <isissupport>
        type: str
      lastUpdated:
        description: It is the Interface's lastUpdated.
        returned: always
        sample: <lastupdated>
        type: str
      macAddress:
        description: It is the Interface's macAddress.
        returned: always
        sample: <macaddress>
        type: str
      mappedPhysicalInterfaceId:
        description: It is the Interface's mappedPhysicalInterfaceId.
        returned: always
        sample: <mappedphysicalinterfaceid>
        type: str
      mappedPhysicalInterfaceName:
        description: It is the Interface's mappedPhysicalInterfaceName.
        returned: always
        sample: <mappedphysicalinterfacename>
        type: str
      mediaType:
        description: It is the Interface's mediaType.
        returned: always
        sample: <mediatype>
        type: str
      nativeVlanId:
        description: It is the Interface's nativeVlanId.
        returned: always
        sample: <nativevlanid>
        type: str
      ospfSupport:
        description: It is the Interface's ospfSupport.
        returned: always
        sample: <ospfsupport>
        type: str
      pid:
        description: It is the Interface's pid.
        returned: always
        sample: <pid>
        type: str
      portMode:
        description: It is the Interface's portMode.
        returned: always
        sample: <portmode>
        type: str
      portName:
        description: It is the Interface's portName.
        returned: always
        sample: <portname>
        type: str
      portType:
        description: It is the Interface's portType.
        returned: always
        sample: <porttype>
        type: str
      serialNo:
        description: It is the Interface's serialNo.
        returned: always
        sample: <serialno>
        type: str
      series:
        description: It is the Interface's series.
        returned: always
        sample: <series>
        type: str
      speed:
        description: It is the Interface's speed.
        returned: always
        sample: <speed>
        type: str
      status:
        description: It is the Interface's status.
        returned: always
        sample: <status>
        type: str
      vlanId:
        description: It is the Interface's vlanId.
        returned: always
        sample: <vlanid>
        type: str
      voiceVlan:
        description: It is the Interface's voiceVlan.
        returned: always
        sample: <voicevlan>
        type: str
    description: Response, property of the response body (list of objects).
    returned: always
    type: list
  returned: always
  type: dict
  version:
    description: Version, property of the response body.
    returned: always
    sample: '1.0'
    type: str
get_interface_details:
  contains: null
  description: Returns Interface by specified device Id and Interface name.
  response:
    contains:
      adminStatus:
        description: It is the Interface's adminStatus.
        returned: always
        sample: <adminstatus>
        type: str
      className:
        description: It is the Interface's className.
        returned: always
        sample: <classname>
        type: str
      description:
        description: It is the Interface's description.
        returned: always
        sample: <description>
        type: str
      deviceId:
        description: It is the Interface's deviceId.
        returned: always
        sample: <deviceid>
        type: str
      duplex:
        description: It is the Interface's duplex.
        returned: always
        sample: <duplex>
        type: str
      id:
        description: It is the Interface's id.
        returned: always
        sample: '478012'
        type: str
      ifIndex:
        description: It is the Interface's ifIndex.
        returned: always
        sample: <ifindex>
        type: str
      instanceTenantId:
        description: It is the Interface's instanceTenantId.
        returned: always
        sample: <instancetenantid>
        type: str
      instanceUuid:
        description: It is the Interface's instanceUuid.
        returned: always
        sample: <instanceuuid>
        type: str
      interfaceType:
        description: It is the Interface's InterfaceType.
        returned: always
        sample: <interfacetype>
        type: str
      ipv4Address:
        description: It is the Interface's ipv4Address.
        returned: always
        sample: <ipv4address>
        type: str
      ipv4Mask:
        description: It is the Interface's ipv4Mask.
        returned: always
        sample: <ipv4mask>
        type: str
      isisSupport:
        description: It is the Interface's isisSupport.
        returned: always
        sample: <isissupport>
        type: str
      lastUpdated:
        description: It is the Interface's lastUpdated.
        returned: always
        sample: <lastupdated>
        type: str
      macAddress:
        description: It is the Interface's macAddress.
        returned: always
        sample: <macaddress>
        type: str
      mappedPhysicalInterfaceId:
        description: It is the Interface's mappedPhysicalInterfaceId.
        returned: always
        sample: <mappedphysicalinterfaceid>
        type: str
      mappedPhysicalInterfaceName:
        description: It is the Interface's mappedPhysicalInterfaceName.
        returned: always
        sample: <mappedphysicalinterfacename>
        type: str
      mediaType:
        description: It is the Interface's mediaType.
        returned: always
        sample: <mediatype>
        type: str
      nativeVlanId:
        description: It is the Interface's nativeVlanId.
        returned: always
        sample: <nativevlanid>
        type: str
      ospfSupport:
        description: It is the Interface's ospfSupport.
        returned: always
        sample: <ospfsupport>
        type: str
      pid:
        description: It is the Interface's pid.
        returned: always
        sample: <pid>
        type: str
      portMode:
        description: It is the Interface's portMode.
        returned: always
        sample: <portmode>
        type: str
      portName:
        description: It is the Interface's portName.
        returned: always
        sample: <portname>
        type: str
      portType:
        description: It is the Interface's portType.
        returned: always
        sample: <porttype>
        type: str
      serialNo:
        description: It is the Interface's serialNo.
        returned: always
        sample: <serialno>
        type: str
      series:
        description: It is the Interface's series.
        returned: always
        sample: <series>
        type: str
      speed:
        description: It is the Interface's speed.
        returned: always
        sample: <speed>
        type: str
      status:
        description: It is the Interface's status.
        returned: always
        sample: <status>
        type: str
      vlanId:
        description: It is the Interface's vlanId.
        returned: always
        sample: <vlanid>
        type: str
      voiceVlan:
        description: It is the Interface's voiceVlan.
        returned: always
        sample: <voicevlan>
        type: str
    description: Response, property of the response body.
    returned: always
    type: dict
  returned: always
  type: dict
  version:
    description: Version, property of the response body.
    returned: always
    sample: '1.0'
    type: str
get_interface_info_by_id:
  contains: null
  description: Returns list of Interfaces by specified device.
  response:
    contains:
      adminStatus:
        description: It is the Interface's adminStatus.
        returned: always
        sample: <adminstatus>
        type: str
      className:
        description: It is the Interface's className.
        returned: always
        sample: <classname>
        type: str
      description:
        description: It is the Interface's description.
        returned: always
        sample: <description>
        type: str
      deviceId:
        description: It is the Interface's deviceId.
        returned: always
        sample: <deviceid>
        type: str
      duplex:
        description: It is the Interface's duplex.
        returned: always
        sample: <duplex>
        type: str
      id:
        description: It is the Interface's id.
        returned: always
        sample: '478012'
        type: str
      ifIndex:
        description: It is the Interface's ifIndex.
        returned: always
        sample: <ifindex>
        type: str
      instanceTenantId:
        description: It is the Interface's instanceTenantId.
        returned: always
        sample: <instancetenantid>
        type: str
      instanceUuid:
        description: It is the Interface's instanceUuid.
        returned: always
        sample: <instanceuuid>
        type: str
      interfaceType:
        description: It is the Interface's InterfaceType.
        returned: always
        sample: <interfacetype>
        type: str
      ipv4Address:
        description: It is the Interface's ipv4Address.
        returned: always
        sample: <ipv4address>
        type: str
      ipv4Mask:
        description: It is the Interface's ipv4Mask.
        returned: always
        sample: <ipv4mask>
        type: str
      isisSupport:
        description: It is the Interface's isisSupport.
        returned: always
        sample: <isissupport>
        type: str
      lastUpdated:
        description: It is the Interface's lastUpdated.
        returned: always
        sample: <lastupdated>
        type: str
      macAddress:
        description: It is the Interface's macAddress.
        returned: always
        sample: <macaddress>
        type: str
      mappedPhysicalInterfaceId:
        description: It is the Interface's mappedPhysicalInterfaceId.
        returned: always
        sample: <mappedphysicalinterfaceid>
        type: str
      mappedPhysicalInterfaceName:
        description: It is the Interface's mappedPhysicalInterfaceName.
        returned: always
        sample: <mappedphysicalinterfacename>
        type: str
      mediaType:
        description: It is the Interface's mediaType.
        returned: always
        sample: <mediatype>
        type: str
      nativeVlanId:
        description: It is the Interface's nativeVlanId.
        returned: always
        sample: <nativevlanid>
        type: str
      ospfSupport:
        description: It is the Interface's ospfSupport.
        returned: always
        sample: <ospfsupport>
        type: str
      pid:
        description: It is the Interface's pid.
        returned: always
        sample: <pid>
        type: str
      portMode:
        description: It is the Interface's portMode.
        returned: always
        sample: <portmode>
        type: str
      portName:
        description: It is the Interface's portName.
        returned: always
        sample: <portname>
        type: str
      portType:
        description: It is the Interface's portType.
        returned: always
        sample: <porttype>
        type: str
      serialNo:
        description: It is the Interface's serialNo.
        returned: always
        sample: <serialno>
        type: str
      series:
        description: It is the Interface's series.
        returned: always
        sample: <series>
        type: str
      speed:
        description: It is the Interface's speed.
        returned: always
        sample: <speed>
        type: str
      status:
        description: It is the Interface's status.
        returned: always
        sample: <status>
        type: str
      vlanId:
        description: It is the Interface's vlanId.
        returned: always
        sample: <vlanid>
        type: str
      voiceVlan:
        description: It is the Interface's voiceVlan.
        returned: always
        sample: <voicevlan>
        type: str
    description: Response, property of the response body (list of objects).
    returned: always
    type: list
  returned: always
  type: dict
  version:
    description: Version, property of the response body.
    returned: always
    sample: '1.0'
    type: str
get_isis_interfaces:
  contains: null
  description: Returns the Interfaces that has ISIS enabled.
  response:
    contains:
      adminStatus:
        description: It is the Interface's adminStatus.
        returned: always
        sample: <adminstatus>
        type: str
      className:
        description: It is the Interface's className.
        returned: always
        sample: <classname>
        type: str
      description:
        description: It is the Interface's description.
        returned: always
        sample: <description>
        type: str
      deviceId:
        description: It is the Interface's deviceId.
        returned: always
        sample: <deviceid>
        type: str
      duplex:
        description: It is the Interface's duplex.
        returned: always
        sample: <duplex>
        type: str
      id:
        description: It is the Interface's id.
        returned: always
        sample: '478012'
        type: str
      ifIndex:
        description: It is the Interface's ifIndex.
        returned: always
        sample: <ifindex>
        type: str
      instanceTenantId:
        description: It is the Interface's instanceTenantId.
        returned: always
        sample: <instancetenantid>
        type: str
      instanceUuid:
        description: It is the Interface's instanceUuid.
        returned: always
        sample: <instanceuuid>
        type: str
      interfaceType:
        description: It is the Interface's InterfaceType.
        returned: always
        sample: <interfacetype>
        type: str
      ipv4Address:
        description: It is the Interface's ipv4Address.
        returned: always
        sample: <ipv4address>
        type: str
      ipv4Mask:
        description: It is the Interface's ipv4Mask.
        returned: always
        sample: <ipv4mask>
        type: str
      isisSupport:
        description: It is the Interface's isisSupport.
        returned: always
        sample: <isissupport>
        type: str
      lastUpdated:
        description: It is the Interface's lastUpdated.
        returned: always
        sample: <lastupdated>
        type: str
      macAddress:
        description: It is the Interface's macAddress.
        returned: always
        sample: <macaddress>
        type: str
      mappedPhysicalInterfaceId:
        description: It is the Interface's mappedPhysicalInterfaceId.
        returned: always
        sample: <mappedphysicalinterfaceid>
        type: str
      mappedPhysicalInterfaceName:
        description: It is the Interface's mappedPhysicalInterfaceName.
        returned: always
        sample: <mappedphysicalinterfacename>
        type: str
      mediaType:
        description: It is the Interface's mediaType.
        returned: always
        sample: <mediatype>
        type: str
      nativeVlanId:
        description: It is the Interface's nativeVlanId.
        returned: always
        sample: <nativevlanid>
        type: str
      ospfSupport:
        description: It is the Interface's ospfSupport.
        returned: always
        sample: <ospfsupport>
        type: str
      pid:
        description: It is the Interface's pid.
        returned: always
        sample: <pid>
        type: str
      portMode:
        description: It is the Interface's portMode.
        returned: always
        sample: <portmode>
        type: str
      portName:
        description: It is the Interface's portName.
        returned: always
        sample: <portname>
        type: str
      portType:
        description: It is the Interface's portType.
        returned: always
        sample: <porttype>
        type: str
      serialNo:
        description: It is the Interface's serialNo.
        returned: always
        sample: <serialno>
        type: str
      series:
        description: It is the Interface's series.
        returned: always
        sample: <series>
        type: str
      speed:
        description: It is the Interface's speed.
        returned: always
        sample: <speed>
        type: str
      status:
        description: It is the Interface's status.
        returned: always
        sample: <status>
        type: str
      vlanId:
        description: It is the Interface's vlanId.
        returned: always
        sample: <vlanid>
        type: str
      voiceVlan:
        description: It is the Interface's voiceVlan.
        returned: always
        sample: <voicevlan>
        type: str
    description: Response, property of the response body (list of objects).
    returned: always
    type: list
  returned: always
  type: dict
  version:
    description: Version, property of the response body.
    returned: always
    sample: '1.0'
    type: str
get_ospf_interfaces:
  contains: null
  description: Returns the Interfaces that has OSPF enabled.
  response:
    contains:
      adminStatus:
        description: It is the Interface's adminStatus.
        returned: always
        sample: <adminstatus>
        type: str
      className:
        description: It is the Interface's className.
        returned: always
        sample: <classname>
        type: str
      description:
        description: It is the Interface's description.
        returned: always
        sample: <description>
        type: str
      deviceId:
        description: It is the Interface's deviceId.
        returned: always
        sample: <deviceid>
        type: str
      duplex:
        description: It is the Interface's duplex.
        returned: always
        sample: <duplex>
        type: str
      id:
        description: It is the Interface's id.
        returned: always
        sample: '478012'
        type: str
      ifIndex:
        description: It is the Interface's ifIndex.
        returned: always
        sample: <ifindex>
        type: str
      instanceTenantId:
        description: It is the Interface's instanceTenantId.
        returned: always
        sample: <instancetenantid>
        type: str
      instanceUuid:
        description: It is the Interface's instanceUuid.
        returned: always
        sample: <instanceuuid>
        type: str
      interfaceType:
        description: It is the Interface's InterfaceType.
        returned: always
        sample: <interfacetype>
        type: str
      ipv4Address:
        description: It is the Interface's ipv4Address.
        returned: always
        sample: <ipv4address>
        type: str
      ipv4Mask:
        description: It is the Interface's ipv4Mask.
        returned: always
        sample: <ipv4mask>
        type: str
      isisSupport:
        description: It is the Interface's isisSupport.
        returned: always
        sample: <isissupport>
        type: str
      lastUpdated:
        description: It is the Interface's lastUpdated.
        returned: always
        sample: <lastupdated>
        type: str
      macAddress:
        description: It is the Interface's macAddress.
        returned: always
        sample: <macaddress>
        type: str
      mappedPhysicalInterfaceId:
        description: It is the Interface's mappedPhysicalInterfaceId.
        returned: always
        sample: <mappedphysicalinterfaceid>
        type: str
      mappedPhysicalInterfaceName:
        description: It is the Interface's mappedPhysicalInterfaceName.
        returned: always
        sample: <mappedphysicalinterfacename>
        type: str
      mediaType:
        description: It is the Interface's mediaType.
        returned: always
        sample: <mediatype>
        type: str
      nativeVlanId:
        description: It is the Interface's nativeVlanId.
        returned: always
        sample: <nativevlanid>
        type: str
      ospfSupport:
        description: It is the Interface's ospfSupport.
        returned: always
        sample: <ospfsupport>
        type: str
      pid:
        description: It is the Interface's pid.
        returned: always
        sample: <pid>
        type: str
      portMode:
        description: It is the Interface's portMode.
        returned: always
        sample: <portmode>
        type: str
      portName:
        description: It is the Interface's portName.
        returned: always
        sample: <portname>
        type: str
      portType:
        description: It is the Interface's portType.
        returned: always
        sample: <porttype>
        type: str
      serialNo:
        description: It is the Interface's serialNo.
        returned: always
        sample: <serialno>
        type: str
      series:
        description: It is the Interface's series.
        returned: always
        sample: <series>
        type: str
      speed:
        description: It is the Interface's speed.
        returned: always
        sample: <speed>
        type: str
      status:
        description: It is the Interface's status.
        returned: always
        sample: <status>
        type: str
      vlanId:
        description: It is the Interface's vlanId.
        returned: always
        sample: <vlanid>
        type: str
      voiceVlan:
        description: It is the Interface's voiceVlan.
        returned: always
        sample: <voicevlan>
        type: str
    description: Response, property of the response body (list of objects).
    returned: always
    type: list
  returned: always
  type: dict
  version:
    description: Version, property of the response body.
    returned: always
    sample: '1.0'
    type: str

See also