DCImanager-Essential API

Материал из ISPWiki
Перейти к: навигация, поиск

Содержание

SSH ключи

Функция: sshpubkey

Результат: список элементов

SSH ключи

Уровень доступа: admin user

  • name - Наименование ключа

SSH ключи

Функция: sshpubkey.edit

Уровень доступа: admin user

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

Создание объекта:

Изменение объекта

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • name - Наименование ключа. Наименование ключа
  • pubkey - Публичный SSH ключ. Публичный SSH ключ

Удалить

Функция: sshpubkey.delete

Удалить

Уровень доступа: admin user

Параметры:

  • elid - один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор - это элемент id из функции sshpubkey.

Результат: успешное выполнение операции или сообщение об ошибке

Типы серверов

Функция: servertype

Результат: список элементов

Типы серверов

Уровень доступа: admin

  • name - Имя
  • servers - Серверы
  • freeservers - Свободные серверы
  • oscnt - Поддерживается ОС
  • notes - Примечания

Список ОС, поддерживаемых типом

Функция: servertype.oslist

Результат: список элементов

Список ОС, поддерживаемых типом

Уровень доступа: admin

  • os - Операционная система

Добавление ОС

Функция: servertype.oslist.edit

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта. Просмотр параметров объекта:

  • Параметры:
    • plid - уникальный идентификатор родительского списка (элемент id из функции servertype).
    • elid - уникальный идентификатор (элемент id из функции servertype.oslist)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok - значение параметра должно быть не пустым, обычно "yes".
    • plid - уникальный идентификатор родительского списка (элемент id из функции servertype).
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта:

  • Параметры:
    • sok - значение параметра должно быть не пустым, обычно "yes".
    • plid - уникальный идентификатор родительского списка (элемент id из функции servertype).
    • elid - уникальный идентификатор (элемент id из функции servertype.oslist)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):


  • os - ОС.

Удалить

Функция: servertype.oslist.delete

Удалить

Уровень доступа: admin

Параметры:

  • elid - один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор - это элемент id из функции servertype.oslist.

Результат: успешное выполнение операции или сообщение об ошибке

Имя

Функция: servertype.cpulist

Результат: список элементов

Список процессоров типа

Уровень доступа: admin

  • name - Имя

Удалить

Функция: servertype.cpulist.delete

Удалить

Уровень доступа: admin

Параметры:

  • elid - один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор - это элемент id из функции servertype.cpulist.

Результат: успешное выполнение операции или сообщение об ошибке

Добавление процессора

Функция: servertype.cpulist.edit

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта. Просмотр параметров объекта:

  • Параметры:
    • plid - уникальный идентификатор родительского списка (элемент id из функции servertype).
    • elid - уникальный идентификатор (элемент id из функции servertype.cpulist)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok - значение параметра должно быть не пустым, обычно "yes".
    • plid - уникальный идентификатор родительского списка (элемент id из функции servertype).
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта:

  • Параметры:
    • sok - значение параметра должно быть не пустым, обычно "yes".
    • plid - уникальный идентификатор родительского списка (элемент id из функции servertype).
    • elid - уникальный идентификатор (элемент id из функции servertype.cpulist)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):


  • cpu - Процессор. Выберите процессор, который будет входить в данный тип.

Удалить тип сервера

Функция: servertype.delete

Удалить тип сервера

Уровень доступа: admin

Параметры:

  • elid - один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор - это элемент id из функции servertype.

Результат: успешное выполнение операции или сообщение об ошибке

Редактирование типа сервера

Функция: servertype.edit

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

Создание объекта:

Изменение объекта

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • name - Имя.
  • corecnt - Количество ядер. Количество ядер на сервере, с учётом всех процессоров
  • ram - Оперативная память (Мб). Объём оперативной памяти, установленной на сервере.
  • ramperf - Производительность оперативной памяти (опер./с). Производительность оперативной памяти, установленной на сервере, должна быть больше этого значения.
  • hddcnt - Количество жёстких дисков. Количество жёстких дисков, установленных на сервере
  • hddsize - Размер жесткого диска (Гб). Размер каждого жесткого диска, установленного на сервере, должен быть больше этого значения.
  • hddperf - Производительность жёстких дисков. Производительность каждого жёсткого диска, установленного на сервере, должна быть больше этого значения.
  • raid - . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) На серверах данного типа используется аппаратный RAID
  • srvsize - Размер в стойке.
  • notes - Примечания.

Протестировать шаблоны ОС для данного типа

Функция: servertype.checktype

Протестировать шаблоны ОС для данного типа

Уровень доступа: admin

Параметры:

  • elid - один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор - это элемент id из функции servertype.

Результат: успешное выполнение операции или сообщение об ошибке

Глобальные настройки

Функция: globalsettings

Уровень доступа: admin

Данная функция одновременно используется для просмотра и изменения данных формы

Просмотр данных:

Изменение данных:

Список параметров или дополнительных параметров запроса (см.выше):

  • diagonfree - . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Автоматически запускать диагностику серверов при их освобождении
  • diagonfreetemplate - Шаблон диагностики.
  • shutdownafterdiag - . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) После завершения диагностики сервера будут автоматически отключены
  • allowipmiautoconfig - . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Если на сервере во время диагностики будет обнаружен IPMI, то он будет автоматически добавлен в подключения сервера (если его ещё нет) и настроен в соответствии с данными в DCImanager
  • clearhddondiag - . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) При выполнении диагностики жесткие диски сервера будут очищены(если шаблон диагностики поддерживает такое поведение)
  • servers_autoshutdown - . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Все серверы без владельца, на которых не запущены операции, будут автоматически отключаться.
  • enablesearch - . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Автопоиск будет выполняться
  • network - Сеть поиска серверов. Сеть(интерфейс), которая будет использоваться для временного размещения в ней новых серверов.
  • iprange - Диапозон адресов. Диапозон IP-адресов, который будет использоваться для новых серверов. Должен соответствовать сети поиска серверов.
  • template - Шаблон автопоиска. Шаблон, с помощью которого будет осуществляться автопоиск серверов
  • httpproxy - Прокси-сервер (IPv4). Прокси-сервер(IPv4), который будет использоваться для установки операционных систем. Оставьте пустым, если не хотите использовать прокси-сервер.
  • httpproxyv6 - Прокси-сервер(IPv6). Прокси-сервер(IPv6), который будет использоваться для установки операционных систем. Оставьте пустым, если не хотите использовать прокси-сервер.

Установка ОС

Функция: operstat

Результат: отчёт

Статистика использования шаблонов ОС

Уровень доступа: admin

Операции

Функция: operation

Результат: список элементов

Управление операциями

Уровень доступа: admin

  • date - Начало
  • type - Операция
  • user - Пользователь
  • state - Состояние

Удалить все неактивные операции

Функция: operation.clear

Удалить все неактивные операции

Уровень доступа: admin

Журнал

Функция: operation.log

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

Создание объекта:

Изменение объекта

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • log - .

Отменить выбранные операции

Функция: operation.cancel

Отменить выбранные операции

Уровень доступа: admin

Параметры:

  • elid - один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор - это элемент id из функции operation.

Результат: успешное выполнение операции или сообщение об ошибке

Настройки панели

Функция: usrparam

Уровень доступа: user

Данная функция одновременно используется для просмотра и изменения данных формы

Просмотр данных:

Изменение данных:

Список параметров или дополнительных параметров запроса (см.выше):

  • name - Имя пользователя. Текущее имя пользователя, для которого вы изменяете настройки панели управления
  • theme - Тема. Тема панели управления
  • lang - Язык. Язык панели управления
  • atype - Доступ к панели управления. Укажите с каких IP-адресов вы хотите разрешить доступ к панели управления.
    Будьте предельно внимательны! Допустив ошибку, возможно, вы не сможете больше попасть в панель управления
  • addr - Список IP-адресов. Укажите список IP-адресов, с которых вы хотите разрешить доступ к панели управления. Можно указать отдельные адреса (123.45.67.89), адреса по маске (123.45.67.0/24), либо диапазон адресов (123.45.67.89-123.45.67.98)
  • startpage - Стартовая страница. Страница, которая будет отображаться первой после того, как вы войдете в систему.
  • rows - Строк на странице. Количество строк таблицы, которые будут отображаться на каждой странице, по умолчанию
  • recordlimit - Количество записей. Максимальное количество записей, которое будет выведено в список. Ограничение нужно для предотвращения длительного формирования результата на больших объемах данных. Зачастую удобнее воспользоваться фильтром, нежели ожидать формирования большого списка, а потом просматривать его.
  • buttonview - Вид кнопок. Выберите предпочитаемое отображение кнопок на панели инструментов
  • experience - Уровень опыта пользователя. Укажите предпочитаемый уровень опыта пользователя. Уровень опыта влияет на количество отображаемых полей, и на сложность настройки системы.

Поиск серверов

Функция: serversearch

Результат: список элементов

Поиск серверов

Уровень доступа: admin

  • name - Имя
  • rack - Стойка
  • status - Состояние
  • type - Тип
  • mac - MAC-адрес

Ввести выбранные серверы в эксплуатацию

Функция: serversearch.approve

Ввести выбранные серверы в эксплуатацию

Уровень доступа: admin

Параметры:

  • elid - один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор - это элемент id из функции serversearch.

Результат: успешное выполнение операции или сообщение об ошибке

Удалить найденный сервер

Функция: server.delete

Удалить найденный сервер

Уровень доступа: admin

Параметры:

  • elid - один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор - это элемент id из функции serversearch.

Результат: успешное выполнение операции или сообщение об ошибке

Управление подключениями сервера

Функция: server.connection

Результат: список элементов

Управление подключениями сервера

Уровень доступа: admin

  • type - Тип
  • device - Устройство
  • state - Состояние

Редактировать порт коммутатора, соответствующий выбранному подключению

Функция: server.connection.redirect

Редактировать порт коммутатора, соответствующий выбранному подключению

Уровень доступа: admin

Включить выбранные порты

Функция: server.connection.on

Включить выбранные порты

Уровень доступа: admin

Параметры:

  • elid - один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор - это элемент id из функции server.connection.

Результат: успешное выполнение операции или сообщение об ошибке

Создать подключение

Функция: conncreatewiz

Создать подключение

Уровень доступа: admin

Удалить подключение

Функция: server.connection.delete

Удалить подключение

Уровень доступа: admin

Параметры:

  • elid - один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор - это элемент id из функции server.connection.

Результат: успешное выполнение операции или сообщение об ошибке

Редактирование подключения сервера

Функция: server.connection.edit

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта. Просмотр параметров объекта:

  • Параметры:
    • plid - уникальный идентификатор родительского списка (элемент id из функции serversearch).
    • elid - уникальный идентификатор (элемент id из функции server.connection)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok - значение параметра должно быть не пустым, обычно "yes".
    • plid - уникальный идентификатор родительского списка (элемент id из функции serversearch).
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта:

  • Параметры:
    • sok - значение параметра должно быть не пустым, обычно "yes".
    • plid - уникальный идентификатор родительского списка (элемент id из функции serversearch).
    • elid - уникальный идентификатор (элемент id из функции server.connection)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):


  • devtype - Тип устройства.
  • device - Устройство.
  • port - Порт.
  • ipmi - Версия IPMI.
  • ipmiip - IP-адрес.
  • ipmiuser - Пользователь.
  • ipmipass - Пароль.
  • service - . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Если установлен флаг, то это подключение не будет участвовать в таких операциях, как перезагрузка сервера, включение/отключение питания сервера. А также не будет учитываться трафик.

Выключить выбранные порты

Функция: server.connection.off

Выключить выбранные порты

Уровень доступа: admin

Параметры:

  • elid - один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор - это элемент id из функции server.connection.

Результат: успешное выполнение операции или сообщение об ошибке

Виртуальные сети (VLAN)

Функция: vlan

Результат: список элементов

Управление виртуальными сетями (VLAN)

Уровень доступа: admin

  • id - VLAN
  • name - Имя
  • notes - Примечания

Удалить

Функция: vlan.delete

Удалить

Уровень доступа: admin

Параметры:

  • elid - один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор - это элемент id из функции vlan.

Результат: успешное выполнение операции или сообщение об ошибке

Редактирование виртуальной сети

Функция: vlan.edit

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

Создание объекта:

Изменение объекта

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • id - VLAN Id. Идентификатор виртуальной сети (VLAN ID)
  • name - Имя. Имя виртуальной сети. Используется при настройке сетевого оборудования.
  • notes - Примечания.

Потребление питания

Функция: power

Результат: отчёт

Статистика потребления энергии

Уровень доступа: admin user

Подключения

Функция: serverconnstat

Результат: отчёт

Информация о несоответствиях в подключениях серверов

Уровень доступа: admin

Шаблоны ОС

Функция: osmgr

Результат: список элементов

Управление шаблонами ОС

Уровень доступа: admin

  • name - Шаблон
  • type - Тип
  • state - Состояние
  • repo - Источник
  • date - Дата

Изменить параметры шаблона ОС

Функция: osmgr.edit

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

Создание объекта:

Изменение объекта

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • autoupdate - . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Включить/выключить автообновление шаблона.

Если обновление включено, система проверяет версию шаблона раз в сутки и обновляет в случае необходимости

  • restrict - . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Если ограничение включено, то установка шаблона возможна только под администраторским аккаунтом 

Обновить список шаблонов

Функция: osmgr.fetch

Обновить список шаблонов

Уровень доступа: admin

Удалить выбранные шаблоны

Функция: osmgr.delete

Удалить выбранные шаблоны

Уровень доступа: admin

Параметры:

  • elid - один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор - это элемент id из функции osmgr.

Результат: успешное выполнение операции или сообщение об ошибке

Репозиторий

Функция: repo

Результат: список элементов

Репозитории шаблонов ОС

Уровень доступа: admin

  • name - Репозиторий
  • location - Ссылка

Удалить репозиторий

Функция: repo.delete

Удалить репозиторий

Уровень доступа: admin

Параметры:

  • elid - один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор - это элемент name из функции repo.

Результат: успешное выполнение операции или сообщение об ошибке

Редактирование репозитория шаблонов ОС

Функция: repo.edit

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта. Просмотр параметров объекта:

  • Параметры:
    • plid - уникальный идентификатор родительского списка (элемент id из функции osmgr).
    • elid - уникальный идентификатор (элемент name из функции repo)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok - значение параметра должно быть не пустым, обычно "yes".
    • plid - уникальный идентификатор родительского списка (элемент id из функции osmgr).
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта:

  • Параметры:
    • sok - значение параметра должно быть не пустым, обычно "yes".
    • plid - уникальный идентификатор родительского списка (элемент id из функции osmgr).
    • elid - уникальный идентификатор (элемент name из функции repo)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):


  • name - Репозиторий. Наименование репозитория
  • location - Ссылка. Ссылка на репозиторий

Установить/Обновить выбранные шаблоны

Функция: osmgr.install

Установить/Обновить выбранные шаблоны

Уровень доступа: admin

Параметры:

  • elid - один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор - это элемент id из функции osmgr.

Результат: успешное выполнение операции или сообщение об ошибке

Обновить

Функция: osmgr.update


Уровень доступа: admin

Запчасти

Функция: spare

Результат: список элементов

Запчасти

Уровень доступа: admin 17

  • category - Категория
  • type - Тип
  • serial - Серийный номер
  • purchasedate - Дата покупки
  • now_in - Место нахождения
  • is_from - Предыдущее место
  • status - Состояние
  • notes - Примечания

Редактирование запчасти

Функция: spare.edit

Уровень доступа: admin 17

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

Создание объекта:

Изменение объекта

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • category - Категория.
  • type - Тип.
  • seller - Поставщик.
  • newseller - Новый поставщик.
  • purchasedate - Дата покупки.
  • warranty - Гарантия (мес.).
  • price - Стоимость.
  • serial - Серийный номер.
  • broken - . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Данная запчать неисправна
  • warranty_change - . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Данная запчасть отправлена поставщику на замену.
  • notes - Примечания.

Функция: spare.filter

Уровень доступа: admin 17

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

Создание объекта:

Изменение объекта

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • serial - Серийный номер.
  • category - Категория.
  • type - Тип.

Извлечь запчасть и поместить её на склад

Функция: spare.plugout

Извлечь запчасть и поместить её на склад

Уровень доступа: admin 17

Параметры:

  • elid - один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор - это элемент id из функции spare.

Результат: успешное выполнение операции или сообщение об ошибке

Удалить

Функция: spare.delete

Удалить

Уровень доступа: admin 17

Параметры:

  • elid - один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор - это элемент id из функции spare.

Результат: успешное выполнение операции или сообщение об ошибке

Категория

Функция: spare.category

Результат: список элементов

Категории запчастей

Уровень доступа: admin 17

  • name - Категория
  • plugsin - Устанавливается в
  • subcount - Типов в категории

Удалить

Функция: spare.category.delete

Удалить

Уровень доступа: admin 17

Параметры:

  • elid - один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор - это элемент id из функции spare.category.

Результат: успешное выполнение операции или сообщение об ошибке

Редактирование категории запчастей

Функция: spare.category.edit

Уровень доступа: admin 17

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта. Просмотр параметров объекта:

  • Параметры:
    • plid - уникальный идентификатор родительского списка (элемент id из функции spare).
    • elid - уникальный идентификатор (элемент id из функции spare.category)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok - значение параметра должно быть не пустым, обычно "yes".
    • plid - уникальный идентификатор родительского списка (элемент id из функции spare).
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта:

  • Параметры:
    • sok - значение параметра должно быть не пустым, обычно "yes".
    • plid - уникальный идентификатор родительского списка (элемент id из функции spare).
    • elid - уникальный идентификатор (элемент id из функции spare.category)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):


  • name - Имя.
  • plugsin - Устанавливается в.

Тип

Функция: spare.category.type

Результат: список элементов

Типы запчастей

Уровень доступа: admin 17

  • name - Тип
Удалить

Функция: spare.category.type.delete

Удалить

Уровень доступа: admin 17

Параметры:

  • elid - один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор - это элемент id из функции spare.category.type.

Результат: успешное выполнение операции или сообщение об ошибке

Редактирование типа запчастей

Функция: spare.category.type.edit

Уровень доступа: admin 17

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта. Просмотр параметров объекта:

  • Параметры:
    • plid - уникальный идентификатор родительского списка (элемент id из функции spare.category).
    • elid - уникальный идентификатор (элемент id из функции spare.category.type)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok - значение параметра должно быть не пустым, обычно "yes".
    • plid - уникальный идентификатор родительского списка (элемент id из функции spare.category).
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта:

  • Параметры:
    • sok - значение параметра должно быть не пустым, обычно "yes".
    • plid - уникальный идентификатор родительского списка (элемент id из функции spare.category).
    • elid - уникальный идентификатор (элемент id из функции spare.category.type)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):


  • name - Имя.

Установка запчасти

Функция: spare.plugin

Уровень доступа: admin 17

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

Создание объекта:

Изменение объекта

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • concretserver - . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".)
  • rack - Стойка.
  • server - Сервер.
  • servername - Конкретный сервер.

Извлечь из

Функция: spareplugoutfrom


Уровень доступа: admin 17

Пользователи

Функция: user

Результат: список элементов

Управление пользователями

Уровень доступа: admin+

  • name - Имя пользователя
  • level - Уровень доступа
  • servers - Серверы
  • status - Статус

Редактирование пользователя

Функция: user.edit

Уровень доступа: admin+

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

Создание объекта:

Изменение объекта

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • name - Имя пользователя.
  • level - Уровень доступа.

Функция: user.filter

Уровень доступа: admin+

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

Создание объекта:

Изменение объекта

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • name - Имя пользователя.
  • level - Уровень доступа.

Отключить пользователя

Функция: user.disable

Отключить пользователя

Уровень доступа: admin+

Параметры:

  • elid - один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор - это элемент id из функции user.

Результат: успешное выполнение операции или сообщение об ошибке

Удалить пользователя

Функция: user.delete

Удалить пользователя

Уровень доступа: admin+

Параметры:

  • elid - один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор - это элемент id из функции user.

Результат: успешное выполнение операции или сообщение об ошибке

Включить пользователя

Функция: user.enable

Включить пользователя

Уровень доступа: admin+

Параметры:

  • elid - один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор - это элемент id из функции user.

Результат: успешное выполнение операции или сообщение об ошибке

Войти в панель с правами пользователя

Функция: user.su

Войти в панель с правами пользователя

Уровень доступа: admin+

Питание (PDU)

Функция: pdu

Результат: список элементов

Управление распределителями питания

Уровень доступа: admin

  • name - Имя
  • device - Тип устройства
  • rack - Стойка
  • ip - IP-адрес
  • portcnt - Количество портов
  • notes - Примечания

Управление портами PDU

Функция: pdu.port

Результат: список элементов

Управление портами PDU

Уровень доступа: admin

  • identity - Идентификатор
  • servername - Имя сервера
  • serverhname - Имя хоста
  • descr - Описание
  • state - Состояние
  • power - Нагрузка (Вт)
  • notes - Примечания

Удалить

Функция: pdu.port.delete

Удалить

Уровень доступа: admin

Параметры:

  • elid - один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор - это элемент id из функции pdu.port.

Результат: успешное выполнение операции или сообщение об ошибке

Включить выбранные порты

Функция: pdu.port.on

Включить выбранные порты

Уровень доступа: admin

Параметры:

  • elid - один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор - это элемент id из функции pdu.port.

Результат: успешное выполнение операции или сообщение об ошибке

Выключить выбранные порты

Функция: pdu.port.off

Выключить выбранные порты

Уровень доступа: admin

Параметры:

  • elid - один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор - это элемент id из функции pdu.port.

Результат: успешное выполнение операции или сообщение об ошибке

Получить текущее состояние портов устройства

Функция: pdu.port.refresh

Получить текущее состояние портов устройства

Уровень доступа: admin

Редактирование порта PDU

Функция: pdu.port.edit

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта. Просмотр параметров объекта:

  • Параметры:
    • plid - уникальный идентификатор родительского списка (элемент id из функции pdu).
    • elid - уникальный идентификатор (элемент id из функции pdu.port)
  • Результат: список параметров объекта

Создание объекта:

Изменение объекта:

  • Параметры:
    • sok - значение параметра должно быть не пустым, обычно "yes".
    • plid - уникальный идентификатор родительского списка (элемент id из функции pdu).
    • elid - уникальный идентификатор (элемент id из функции pdu.port)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):


  • identity - Идентификатор. Идентификатор порта устройства (взято с устройства автоматически)
  • descr - Описание. Описание порта устройства (взято с устройства автоматически)
  • service - . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Это служебный порт. Этот порт будет скрыт из списка портов при создании подключений. А также на данном порту не будет производиться поиск серверов.
  • notes - Примечания.

Создать распределитель питания

Функция: pducreatewiz

Создать распределитель питания

Уровень доступа: admin

Получить текущее состояние распределителя питания и его портов

Функция: pdu.refresh

Получить текущее состояние распределителя питания и его портов

Уровень доступа: admin

Параметры:

  • elid - один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор - это элемент id из функции pdu.

Результат: успешное выполнение операции или сообщение об ошибке

Удалить распределитель питания

Функция: pdu.delete

Удалить распределитель питания

Уровень доступа: admin

Параметры:

  • elid - один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор - это элемент id из функции pdu.

Результат: успешное выполнение операции или сообщение об ошибке

Редактирование распределителя питания

Функция: pdu.edit

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

Создание объекта:

Изменение объекта

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • name - Имя.
  • ip - IP-адрес.
  • rack - Стойка.
  • eqsize - Размер. Размер, занимаемый устройством в стойке
  • notes - Примечания.
  • snmpversion - Версия. Выберите версию SNMP
  • snmpauthlevel - Уровень безопасности. Уровень безопасности SNMPv3
  • snmpuser - Пользователь. Пользователь для SNMPv3
  • snmppass - Пароль. Фраза аутентификации для SNMPv3
  • snmppriv - Фраза приватного ключа.
  • snmpcommunity - Community. Community для SNMP v1/v2c
  • telnetuser - Пользователь.
  • telnetpass - Пароль.
  • sshuser - Пользователь.
  • sshpass - Пароль.
  • seller - Поставщик.
  • newseller - Новый поставщик.
  • purchasedate - Дата покупки.
  • warranty - Гарантия (мес.).
  • price - Стоимость.
  • sellerserial - Серийный номер.

Серверы

Функция: server

Результат: список элементов

Управление серверами

Уровень доступа: admin user

  • id - Id
  • name - Имя
  • rack - Стойка
  • type - Тип сервера
  • hostname - Имя хоста
  • owner - Владелец
  • mac - MAC-адрес
  • status - Состояние
  • ip - IP-адрес
  • power - Потребление питания
  • traff - Нагрузка на канал (бит/сек)
  • os - ОС
  • notes - Примечания

Запретить доступ к серверу

Функция: server.disable

Запретить доступ к серверу

Уровень доступа: admin

Параметры:

  • elid - один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор - это элемент id из функции server.

Результат: успешное выполнение операции или сообщение об ошибке

Перезагрузить сервер

Функция: server.reboot

Перезагрузить сервер

Уровень доступа: admin user

Параметры:

  • elid - один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор - это элемент id из функции server.

Результат: успешное выполнение операции или сообщение об ошибке

Операции над сервером

Функция: server.operations

Уровень доступа: admin user

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

Создание объекта:

Изменение объекта

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • operation - Тип операции.
  • ostemplate - Установить ОС.
  • diag - Провести диагностику.
  • rescue - Загрузить шаблон восстановления.
  • hostname - Имя хоста.

Войти

Функция: server.su


Уровень доступа: admin user

Функция: server.filter

Уровень доступа: admin user

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

Создание объекта:

Изменение объекта

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • id - Id.
  • name - Имя сервера.
  • owner - Владелец.
  • rack - Стойка.
  • type - Тип сервера.
  • hostname - Имя хоста.
  • mac - MAC-адрес.
  • ip - IP-адрес.
  • device - Подключен к.
  • os - ОС.

Отключить питание сервера

Функция: server.poweroff

Отключить питание сервера

Уровень доступа: user

Параметры:

  • elid - один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор - это элемент id из функции server.

Результат: успешное выполнение операции или сообщение об ошибке

Список IP-адресов

Функция: iplist

Результат: список элементов

Список IP-адресов

Уровень доступа: admin user

  • id - Id
  • ip - IP-адрес
  • domain - Домен

Назад

Функция: '

Назад

Уровень доступа: admin user

Изменить IP-адрес

Функция: iplist.edit

Уровень доступа: new: admin ; edit: admin user

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта. Просмотр параметров объекта:

  • Параметры:
    • plid - уникальный идентификатор родительского списка (элемент id из функции server).
    • elid - уникальный идентификатор (элемент id из функции iplist)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok - значение параметра должно быть не пустым, обычно "yes".
    • plid - уникальный идентификатор родительского списка (элемент id из функции server).
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта:

  • Параметры:
    • sok - значение параметра должно быть не пустым, обычно "yes".
    • plid - уникальный идентификатор родительского списка (элемент id из функции server).
    • elid - уникальный идентификатор (элемент id из функции iplist)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):


  • iptype - Тип IP-адреса.
  • family - IP-адрес. Выберите предпочитаемый IP-адрес
  • ip - IP-адрес.
  • domain - Домен. Доменное имя, закрепленное за указанным IP-адресом

Удалить IP-адрес

Функция: iplist.delete

Удалить IP-адрес

Уровень доступа: admin

Параметры:

  • elid - один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор - это элемент id из функции iplist.

Результат: успешное выполнение операции или сообщение об ошибке

Информация о сервере

Функция: server.edit

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

Создание объекта:

Изменение объекта

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • name - Имя. Название сервера, должно быть уникальным
  • rack - Стойка.
  • srvsize - Размер. Размер, занимаемый сервером, в стойке
  • owner - Владелец. Пользователь, которому принадлежит данный сервер
  • type - Тип сервера. Тип данного сервера. Используется только для группировки серверов (например, по тарифам).
  • notes - Примечания.
  • forcelock - . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Если установить эту "галочку", то даже администратор не сможет выполнить никаких действий с этим сервером.
  • family - IP-адрес.
  • specialip - Определённый IP-адрес.
  • hostname - Имя хоста. Доменное имя сервера
  • mac - MAC-адрес. MAC-адрес сетевого адаптера сервера. Используется при установке ОС на сервер.
  • cpuname - Процессор. Тип процессора, установленного на сервере
  • cpucnt - Количество процессоров.
  • corecnt - Количество ядер. Общее количество ядер, установленных на сервере
  • cpuperf - Производительность процессора. Производительность процессора в единицах измерениях бенчмарка SysBench
  • ram - Оперативная память(Mb). Объём оперативной памяти, установленной на сервер в MiB
  • ramperf - Производительность оперативной памяти(опер/с). Производительность оперативной памяти сервера, в операциях в секунду.
  • hddinfo - Жесткие диски. Информация о жёстких дисках, установленных на сервере
  • raid - . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) На данном сервере установлен аппаратный RAID
  • laninfo - Сетевые адаптеры. Информация о сетевых адаптерах, установленных на сервере
  • hwproblem - . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Поставьте эту "галочку", если считаете, что данный сервер имеет проблемы с оборудованием и не может эксплуатироваться.
  • seller - Поставщик.
  • newseller - Новый поставщик.
  • purchasedate - Дата покупки.
  • warranty - Гарантия (мес.).
  • price - Стоимость.
  • sellerserial - Серийный номер.

Включить сервер

Функция: server.poweron

Включить сервер

Уровень доступа: user

Параметры:

  • elid - один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор - это элемент id из функции server.

Результат: успешное выполнение операции или сообщение об ошибке

Разрешить доступ к серверу

Функция: server.enable

Разрешить доступ к серверу

Уровень доступа: admin

Параметры:

  • elid - один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор - это элемент id из функции server.

Результат: успешное выполнение операции или сообщение об ошибке

Коммутаторы

Функция: switch

Результат: список элементов

Управление коммутаторами

Уровень доступа: admin

  • name - Имя
  • hostname - Имя хоста
  • device - Тип устройства
  • rack - Стойка
  • ip - IP-адрес
  • portcnt - Количество портов
  • notes - Примечания

Управление портами коммутатора

Функция: switch.port

Результат: список элементов

Управление портами коммутатора

Уровень доступа: admin

  • identity - Идентификатор
  • servername - Имя сервера
  • serverhname - Имя хоста
  • descr - Описание
  • vlan - VLAN
  • speed - Скорость порта
  • duplex - Режим
  • state - Состояние
  • bitsec - Нагрузка (бит/сек)
  • packsec - Нагрузка (пакет/сек)
  • notes - Примечания

Редактирование порта коммутатора

Функция: switch.port.edit

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта. Просмотр параметров объекта:

  • Параметры:
    • plid - уникальный идентификатор родительского списка (элемент id из функции switch).
    • elid - уникальный идентификатор (элемент id из функции switch.port)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok - значение параметра должно быть не пустым, обычно "yes".
    • plid - уникальный идентификатор родительского списка (элемент id из функции switch).
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта:

  • Параметры:
    • sok - значение параметра должно быть не пустым, обычно "yes".
    • plid - уникальный идентификатор родительского списка (элемент id из функции switch).
    • elid - уникальный идентификатор (элемент id из функции switch.port)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):


  • identity - Идентификатор. Идентификатор порта устройства (взято с устройства автоматически)
  • descr - Описание. Описание порта устройства (взято с устройства автоматически)
  • speed - Скорость порта. Выберите скорость порта
  • duplex - Режим порта.
  • vlan - VLAN.
  • uplink - . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Установите флаг, если данный порт подключен не к серверу, а к коммутатору/маршрутизатору уровнем выше
  • service - . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Это служебный порт. Этот порт будет скрыт из списка портов при создании подключений. А также на данном порту не будет производится поиск серверов.
  • maclist - Список MAC-адресов. Список активных MAC-адресов на порту коммутатора
  • notes - Примечания.

Удалить

Функция: switch.port.delete

Удалить

Уровень доступа: admin

Параметры:

  • elid - один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор - это элемент id из функции switch.port.

Результат: успешное выполнение операции или сообщение об ошибке

Включить выбранные порты

Функция: switch.port.on

Включить выбранные порты

Уровень доступа: admin

Параметры:

  • elid - один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор - это элемент id из функции switch.port.

Результат: успешное выполнение операции или сообщение об ошибке

Получить текущее состояние портов устройства

Функция: switch.port.refresh

Получить текущее состояние портов устройства

Уровень доступа: admin

Выключить выбранные порты

Функция: switch.port.off

Выключить выбранные порты

Уровень доступа: admin

Параметры:

  • elid - один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор - это элемент id из функции switch.port.

Результат: успешное выполнение операции или сообщение об ошибке

Создать коммутатор

Функция: switchcreatewiz

Создать коммутатор

Уровень доступа: admin

Редактирование коммутатора

Функция: switch.edit

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

Создание объекта:

Изменение объекта

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • name - Имя.
  • ip - IP-адрес.
  • rack - Стойка.
  • eqsize - Размер. Размер, занимаемый устройством в стойке
  • applyrack - . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Изменить стойку у всех подключенных к данному устройству серверов
  • notes - Примечания.
  • snmpversion - Версия. Выберите версию SNMP
  • snmpauthlevel - Уровень безопасности. Уровень безопасности SNMPv3
  • snmpuser - Пользователь. Пользователь для SNMPv3
  • snmppass - Пароль. Фраза аутентификации для SNMPv3
  • snmppriv - Фраза приватного ключа.
  • snmpcommunity - Community. Community для SNMP v1/v2c
  • telnetuser - Пользователь.
  • telnetpass - Пароль.
  • sshuser - Пользователь.
  • sshpass - Пароль.
  • seller - Поставщик.
  • newseller - Новый поставщик.
  • purchasedate - Дата покупки.
  • warranty - Гарантия (мес.).
  • price - Стоимость.
  • sellerserial - Серийный номер.

Удалить коммутатор

Функция: switch.delete

Удалить коммутатор

Уровень доступа: admin

Параметры:

  • elid - один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор - это элемент id из функции switch.

Результат: успешное выполнение операции или сообщение об ошибке

Получить текущее состояние коммутатора и его портов

Функция: switch.refresh

Получить текущее состояние коммутатора и его портов

Уровень доступа: admin

Параметры:

  • elid - один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор - это элемент id из функции switch.

Результат: успешное выполнение операции или сообщение об ошибке

Трафик

Функция: traffic

Результат: отчёт

Статистика по трафику

Уровень доступа: admin user

Стойки

Функция: rack

Результат: список элементов

Управление стойками

Уровень доступа: admin

  • name - Имя
  • racksize - Места
  • inetport - Порты коммутаторов
  • powerport - Порты питания
  • power - Потребление питания
  • traff - Нагрузка на сеть (пакет/с)
  • status - Состояние
  • notes - Примечания

Редактирование стойки

Функция: rack.edit

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

Создание объекта:

Изменение объекта

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • name - Имя.
  • racksize - Размер стойки. Отображает количесво мест в стойке
  • notes - Примечания.
  • srvsearch - . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".)

Удалить

Функция: rack.delete

Удалить

Уровень доступа: admin

Параметры:

  • elid - один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор - это элемент id из функции rack.

Результат: успешное выполнение операции или сообщение об ошибке

Источник — «https://doc.ispsystem.ru/index.php?title=DCImanager-Essential_API&oldid=8591»