Source code for noc.sa.interfaces.igetcdpneighbors

# -*- coding: utf-8 -*-
##----------------------------------------------------------------------
## IGetCDPNeighbors
##----------------------------------------------------------------------
## Copyright (C) 2007-2009 The NOC Project
## See LICENSE for details
##----------------------------------------------------------------------
"""
"""
from base import *


class IGetCDPNeighbors(Interface):
    """
    IGetCDPNeighbors

    Common usage scenarios

    * device_id = Local device id: FQDN or serial number
    * neighbors = Remote device id: FQDN or serial number
        * device_id = Remote device id: FQDN or serial number
        * local_interface = Local interface
        * remote_interface = Remote interface
        * remote_ip = Remote IP

    :returns: Dictionary
    :rtype: dict
    """
    returns = DictParameter(attrs={
        # Local device id: FQDN or serial number
        "device_id": StringParameter(),
        "neighbors": ListOfParameter(element=DictParameter(attrs={
            # Remote device id: FQDN or serial number
            "device_id": StringParameter(),
            # Local interface
            "local_interface": InterfaceNameParameter(),
            # Remote interface
            "remote_interface": StringParameter(),
            # Remote IP
            "remote_ip": IPParameter(required=False)
        }))
    })