设备OSPF邻居状态
******************

获取交换的OSPF协议的OSPF邻居的状态情况。

采集原理
~~~~~~~~~

采集器通过周期性地查询设备OSPF邻居的状态情况。

.. attention:: *对于交换机没有启用OSPF协议的，采集会报错误。只有交换机启用了OSPF协议，才能正常返回值。*

.. attention:: *本OID不支持地址簇IPv6, VRF表，不支持虚拟连接。另外华为设备需要二外配置才能支持此OID（必须在设备上配置ospf mib-binding命令）*

采集任务参数配置要求
~~~~~~~~~~~~~~~~~~~~~~~
.. list-table::
    :widths: auto
    :stub-columns: 1
    :align: left

    * - **采集方式**
      - SNMP

    * - **SNMP OID**
      - 1.3.6.1.2.1.14.10.1.6

    * - **返回值**
      - [批量返回]邻居状态值，如下几种(1-down, 2-attempt, 3-init, 4-twoWay, 5-exchangeStart, 6-exchange, 7-loading, 8-full)
	  
    * - **采集超时时间**
      - 默认20000ms

    * - **采集周期**
      - 次/5min

    * - **配置筛选条件**
      - #. 业务线
        #. 区域(地域)
        #. 机房
        #. POD
        #. 业务属性（服务角色）
        #. 设备角色
        #. 设备IP、IP地址段

    * - **特殊要求**
      - #. 使用同一机房的采集去采集该机房的ARP数目，如果该机房没有采集器，使用一组指定的默认采集器去采集
        #. 支持手动指定某一些IP地址（ip地址段）使用特定的采集器


任务处理流程
~~~~~~~~~~~~~~

a. 从筛选条件中筛选出符合要求的设备；设备优先使用带内IP地址作为目标地址去采集，如果没有带内地址，则使用带外去采集。
#. 将筛选出的设备，设置采集周期；
#. 对上述设备执行下发任务至指定的采集节点（包括人工指定，和按同一个机房使用本机房的采集器两种方式，后一种为默认行为）；
#. 对于不能通过自动下发任务至同机房采集器的任务，下发任务至默认的采集器去采集；
#. 采集器执行任务，当请求报文发出去之后。如果超时时间内（默认 2000ms）没有收到返回，超时，此时刻没有数据。如果有返回，将返回值做预处理。

任务筛选条件的互斥关系
~~~~~~~~~~~~~~~~~~~~~~~~

a. 机房--POD--设备IP，存在父子关系，当父节点未被选中或者是多选状态下，子节点不能继续选择；当且仅当机房、POD、同时处于单选状态下方可继续选择设备IP；
#. 区域--机房，存在父子关系，当父节点未被选中或者是多选状态下，子节点不能继续选择；
#. 设备IP地址仅仅可以在没有任何其他项勾选的情况下，才可以支持手工输入多个IP地址，或者多个地址段；


设备OSPF邻居状态采集示例
~~~~~~~~~~~~~~~~~~~~~~~~

如下是一个OSPF邻居状态状态采集示例。“=”右边的即为OSPF邻居的状态。“=”左边，两部分构成，oid + OSPF邻居地址 + 其他参数。如下 ``OID:1.3.6.1.2.1.14.10.1.6.`` + ``邻居地址: 100.127.218.3`` + ``其他：0``

.. code-block:: shell

    [linux ~]$ snmpbulkwalk -c 360buy -v 2c -O Qn 172.20.0.61 1.3.6.1.2.1.14.10.1.6 
	.1.3.6.1.2.1.14.10.1.6.100.127.218.3.0 = 8
	.1.3.6.1.2.1.14.10.1.6.100.127.218.17.0 = 8
	.1.3.6.1.2.1.14.10.1.6.100.127.218.25.0 = 8
	.1.3.6.1.2.1.14.10.1.6.100.127.218.33.0 = 8


下方是该设备没有启用OSPF协议，导致采集失败。
	
.. code-block:: shell	

	[linux ~]$ snmpbulkwalk -c 360buy -v 2c -O Qn 172.20.6.1 1.3.6.1.2.1.14.10.1.6     
	.1.3.6.1.2.1.14.10.1.6 = No Such Instance currently exists at this OID


采集值预处理
~~~~~~~~~~~~~~~~

采集会有二类情形，一是采集超时，没有取回结果；二是采集成功且获取回数据。

a. 如果采集超时，则本次采集为空，即这个时刻没有采集数据，不做任何数据的补充，不能标记为0值等；
#. 解析返回值，取出返回值中的 ``OSPF邻居地址`` 和对应的 ``邻居状态``

数据染色
~~~~~~~~~~~~~~~~

对每条采集数据，染色如下。

a. 时间戳（采集时间）
#. 业务线
#. 区域(地域)
#. 机房
#. POD
#. 房间
#. 机柜
#. 业务属性（服务角色）
#. 设备角色
#. 带内管理IP
#. 带外管理IP
#. 设备名
#. 厂商
#. 设备品牌
#. 设备型号
#. 设备流程状态
#. OSPF邻居地址
#. OSPF邻居状态值
#. OSPF邻居状态(1-down, 2-attempt, 3-init, 4-twoWay, 5-exchangeStart, 6-exchange, 7-loading, 8-full)

可视化
==================

针对单台设备的所有OSPF邻居，对一段时间内的OSPF邻居状态做可视化。要求如下。

#. 以横坐标为时间轴，纵坐标为邻居状态。刻画邻的状态和时间的关系。每个采集时刻一个数据点。
#. 默认展示一个小时的使用率信息；



未完成的部分
==================

#. 尚未开始