=  Команда board  =

== Назначение команды ==

Клманда `board` позволяет получить информацию об установленных в кассете платах. Команда возвращает список плат с указанием их типов, названий и других атрибутов.

== Ключи запроса ==

||  '''Ключ'''  ||  '''Тип значения'''  ||  '''обязательный'''  ||  '''Описание'''  ||
||  cmd  ||  строка  ||  да  || "board" - имя команды ||

=== Пример запроса ===

 `{"cmd":"board"}`

== Права доступа ==

Для выполнения команды `board` не требуется наличия каких-либо прав.

== Возвращаемые данные ==

В случае успешного выполнения команда `board` возвращает JSON-объект со следующими ключами:

||  '''Ключ'''  ||  '''Тип значения'''  ||  '''Описание'''  ||
||  cmd  ||  строка  || "board" - имя команды ||
||  address  ||  число  || адрес (номер слота) платы SW-01, к которой выполнялось обращение ||
||  master  ||  логический  || true если плата SW-01, к которой направлен запрос, работает в активном режиме, false - если в режиме резерва ||
||  boards  ||  массив  || Если плата SW-01, к которой направлен запрос, работает в активном режиме (master=true), массив содержит список объектов (хэшей), каждый из которых описывает установленную в кассете плату. Описание ключей хэша дано ниже. Если плата SW-01 работает в режиме резерва, содержимое массива не несет полезной информации и должно игнорироваться клиентом. ||
||  confInSync  ||  логический  || Этот ключ присутствует только если master=false. Значение показывает, был ли файл конфигурации синхронизирован с мастер-платой (платой SW-01, работающей в активном режиме). ||
||  configTime  ||  число  || Этот ключ присутствует только если master=false. Значение - дата генерации конфиг-файла (UNIX-time) в активной плате SW-01. ||
||  confSyncTime  ||  число  || Этот ключ присутствует только если master=false. Если конфиг-файл синхронизирован с мастер-платой (confInSync=true), это последней синхронизации конфиг-файла (UNIX-time). ||
||  confSyncPct  ||  число  || Этот ключ присутствует только если master=false. -файл синхронизирован с мастер-платой (confInSync=true), это последней синхронизации конфиг-файла (UNIX-time). ||
||  now  ||  число  || Этот ключ присутствует только если master=false. Значение - текущее системное время платы SW-01, отвечающей на запрос (UNIX-time). ||

Элементы массива `boards` содержат следующие ключи:

||  '''Ключ'''  ||  '''Тип значения'''  ||  '''Описание'''  ||
||  slot  ||  число  || Номер слота, в котором установлена плата. ||
||  present  ||  логический  || true если в слоте установлена какая-либо плата. ||
||  type  ||  число  || Этот ключ присутствует только если present=true и содержит код типа платы. ||
||  variant  ||  число  || Этот ключ присутствует только если present=true и содержит номер исполнения платы. ||
||  name  ||  строка  || Этот ключ присутствует только если present=true и содержит наименование платы. ||
||  alarm  ||  число  || Этот ключ присутствует только если present=true и содержит 0 если в плате отсутствуют аварии, иначе приоритет наиболее приоритетной аварии (1 - срочная, 2 и более - не срочные). ||
||  comment  ||  строка  || Этот ключ присутствует только если present=true и содержит текстовый комментарий. ||
||  required  ||  логический  || Этот ключ присутствует только если present=true. Ключ required имеет значение true, если для платы установлен атрибут "обязательная". ||
||  last_alarm  ||  строка  || Этот ключ присутствует только если present=true и содержит описание последней аварии платы. ||
||  last_alarm_time  ||  число  || Этот ключ присутствует только если present=true и содержит время начала последней аварии платы (UNIX-time). ||

== Пример ответа ==

{{{
{
  "address":9,
  "boards":[
    {
      "alarm":0,
      "comment":"",
      "last_alarm":"ALARM (Общая авария платы)",
      "last_alarm_time":1504368065,
      "name":"PE-04",
      "present":true,
      "required":false,
      "slot":1,
      "type":22,
      "variant":1
    },
    {
      "alarm":0,
      "comment":"",
      "last_alarm":"",
      "last_alarm_time":0,
      "name":"FO-08",
      "present":true,
      "required":false,
      "slot":2,
      "type":3,
      "variant":1
    },
    {
      "present":false,
      "slot":3
    },
    {
      "present":false,
      "slot":4
    },
    {
      "present":false,
      "slot":5
    },
    {
      "present":false,
      "slot":6
    },
    {
      "present":false,
      "slot":7
    },
    {
      "present":false,
      "slot":8
    },
    {
      "alarm":0,
      "comment":"",
      "last_alarm":"",
      "last_alarm_time":0,
      "name":"SW-01",
      "present":true,
      "required":false,
      "slot":9,
      "type":1,
      "variant":1
    },
    {
      "present":false,
      "slot":10
    },
    {
      "present":false,
      "slot":11
    },
    {
      "present":false,
      "slot":12
    },
    {
      "present":false,
      "slot":13
    },
    {
      "present":false,
      "slot":14
    },
    {
      "present":false,
      "slot":15
    },
    {
      "present":false,
      "slot":16
    },
    {
      "present":false,
      "slot":17
    },
    {
      "present":false,
      "slot":18
    },
    {
      "present":false,
      "slot":19
    },
    {
      "alarm":0,
      "comment":"",
      "last_alarm":"",
      "last_alarm_time":0,
      "name":"BS-220",
      "present":true,
      "required":false,
      "slot":20,
      "type":24,
      "variant":1
    },
    {
      "present":false,
      "slot":21
    },
    {
      "present":false,
      "slot":22
    }
  ],
  "cmd":"board",
  "master":true
}
}}}

== См. также ==

[wiki:ApiBoardComment команда boardComment]