Параметры установки

Таблица параметров

В таблице ниже описаны параметры для команды установки агента.

  • Если в инфраструктуре используются IPv6-адреса, то их необходимо указывать без скобок при вводе команды на установку агента в командную строку.

  • Значение опроса Сервера управления BZ_POLLING_PERIOD / POLLING_PERIOD составляет:

    • 300 секунд для Multi-Node инсталляций с большим количеством агентов.

    • 15 секунд для тестовых All-in-One инсталляций.

Параметр

Описание

AUTHORITY_SERVICE

(Windows)

BZ_AUTHORITY_SERVICE

(Linux и macOS)

Адрес и номер порта Сервера управления BI.ZONE EDR для неавторизованных агентов.
Примеры:

  • IPv4-адрес: 1.2.3.4:9992,

  • IPv6-адрес: [::ae21:ad12]:9992,

  • DNS-имя: sensors.localdomain:9992.

Номер порта на сервере по умолчанию: 9992

SENSORS_SERVICE

(Windows)

BZ_SENSORS_SERVICE

(Linux и macOS)

Адрес и номер порта Сервера управления BI.ZONE EDR для авторизованных агентов.
Примеры:

  • IPv4-адрес: 1.2.3.4:9991,

  • IPv6-адрес: [::ae21:ad12]:9992,

  • DNS-имя: sensors.localdomain:9991.

Номер порта на сервере по умолчанию: 9991

RELAY_SERVICE

(Windows)
BZ_RELAY_SERVICE

(Linux и macOS)

Обратите внимание — Компонент отправки телеметрии не используется в All-in-one инсталляции.

Адрес и номер порта Компонента отправки телеметрии для авторизованных агентов и агентов в автономном режиме работы.

Примеры:

  • IPv4-адрес: 1.2.3.4:9994,

  • IPv6-адрес: [::ae21:ad12]:9992,

  • DNS-имя: sensors.localdomain:9994.

Значений может быть несколько, в этом случае они указываются через запятую. При установке пустого значения или отсутствии этой опции данные отправляются на основной адрес SENSORS_SERVICE. Значение по умолчанию пустое

POLLING_PERIOD

(Windows)

BZ_POLLING_PERIOD

(Linux и macOS)

Период опроса Сервера управления агентом. Единица измерения (s/m) обязательна. Рекомендуемые значения:

  • 300 секунд для Multi-Node инсталляций с большим количеством агентов.

  • 15 секунд для тестовых All-in-One инсталляций.

DIAL_TIMEOUT

(Windows)

BZ_DIAL_TIMEOUT

(Linux и macOS)

Таймаут подключения к серверу. Единица измерения (s/m) обязательна. Минимальное допустимое значение: 5s. Значение по умолчанию: 15s. DIAL_TIMEOUT должен быть меньше POLLING_PERIOD.

AGENT_GROUPS

(Windows)
BZ_AGENT_GROUPS

(Linux и macOS)

Список ключей групп, разделенных пробелами, в которые агент будет автоматически добавлен сразу после установки

VDI

(Windows)

BZ_VDI

(Linux и macOS)

Определяет необходимость старта сервиса после установки. Значение true применятся для запуска сервиса после следующей загрузки системы, любое другое значение для немедленного старта. Значение по умолчанию: false. Параметр чувствителен к регистру символов

SERVICE

(Windows)

BZ_SERVICE

(Linux и macOS)

Определяет, будет ли производиться автоматическая регистрация сервиса и запуск агента после его установки. Возможные значения:

  • true (значение по умолчанию). В этом случае сразу после установки агент сам зарегистрирует свой сервис и запустится;

  • false — после установки агента не будет производиться регистрация сервиса агента и его запуск. При этом файлы агента будут распакованы, агент будет готов к работе, но потребует ручной регистрации сервиса для начала работы.

    Чтобы зарегистрировать сервис агента вручную, используйте команду bzsenagent service install (для Windows и macOS) или systemctl enable bzsenagent (для Linux). Агент запустится после перезагрузки системы.

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

ID_TYPE

(Windows)

BZ_ID_TYPE

(Linux и macOS)

Способ идентификации агента. Возможные значения:

  • name-id;

  • os-id;

  • name+os-id (используется по умолчанию).

  • agent-id;

Подробно способы описаны в подразделе Способы идентификации (ниже).

ID_REFRESH

(Windows)

BZ_ID_REFRESH

(Linux и macOS)

Квалификатор для способа идентификации агента. Возможные значения: true (по умолчанию), false.

Значение по умолчанию: true, значение false оставлено для обратной совместимости. Подробнее в подразделе Способы идентификации (ниже).

При значении false агент будет идентифицироваться по заданной схеме идентификации только при первом обращении к серверу (при регистрации), в дальнейшем будет использоваться схема agent-id.

При значении true агент будет идентифицироваться сервером по заданной схеме на протяжении всей работы. При изменении идентификационных параметров во время работы (например, при переименовании хоста во время идентификации по схеме name+os-id) агент будет перерегистрирован с сохранением установленных модулей

LOG_LEVEL

(Windows)

BZ_LOG_LEVEL

(Linux и macOS)

Уровень логирования. Возможные значения: trace, debug, info, warn, error

PROTECTION

(Windows)

BZ_PROTECTION

(Linux)

Отключение самозащиты агента. Возможные значения: enabled (по умолчанию), disabled.

При использовании disabled сервис самозащиты не будет установлен при установке и авторизации агента.

Но в дальнейшем останется возможность включить сервис самозащиты:

  • В UI сервера (в любой момент);

  • При деавторизации и повторной авторизации (автоматически)

PORTABLE

(Windows)

BZ_PORTABLE

(Linux и macOS)

Тип агента для установки. Возможные значения:

  • true — будет установлен автономный агент, при этом значении игнорируются параметры, отвечающие за взаимодействие сервера и агента;

  • false — значение по умолчанию, будет установлен обычный агент

GUI_ENABLED

(Windows)

BZ_GUI_ENABLED

(macOS)

Установка GUI для агента. Возможные значения:

  • true — агент будет установлен с GUI;

  • false — значение по умолчанию, агент будет установлен без GUI

Способы идентификации

Ниже описаны способы идентификации, используемые через параметр ID_TYPE/ BZ_ID_TYPE для команды установки агента.

name-id

Идентификация по параметру NameID — идентификатору, зависящему только от имени хоста в сети. Рассчитывается как хеш от FQDN хоста без завершающей точки (или, в случае отсутствия, просто имени хоста), приведенного к lower-case.

Рекомендуется использовать в среде, где имена хостов не меняются. Например, домен и зарегистрированные в нем реальные и виртуальные машины. Обратите внимание — в пределах одного леса доменов NameID не может повторяться.

os-id

Идентификация по параметру OSID — идентификатору, зависящему только от установленной операционной системы. Рассчитывается как хеш от следующих зависящих от платформы значений:

  • Для Windows: HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Cryptography\MachineGuID;

  • Для Linux: из файлов /var/lib/dbus/machine-ID или /etc/machine-ID;

  • Для MacOS: IOPlatformUUID.

Рекомендуется использовать в среде, где имя хоста можно поменять. Обратите внимание — OSID может повторяться (для клонированных ВМ без sysprep), может не повторяться.

name+os-id

Идентификация по параметрам NameID и OSID. Значение используется по умолчанию.

Рекомендуется для использования в бездоменной среде, где имена хостов могут совпадать. Например, если на сервер приходят несколько агентов с одинаковым именем WORKGROUP\Host1.

agent-id

Идентификация по параметру AgentID. Не рекомендуется использовать. Допускается к использованию если способы выше не могут быть реализованы, и получена рекомендация от сотрудников BI.ZONE.