Просмотр кода страницы ЕдиныйАгент настройка через интерфейс командной строки

Используйте интерфейс командной строки <code>oneagentctl</code> для выполнения некоторых настроек ЕдиногоАгента после установки на уровне отдельного хоста.

==Расположение==
Расположение инструмента зависит от того, настроили ли вы установку ЕдиногоАгента с помощью параметра <code><INSTALL_PATH></code>:

'''Linux''' или '''AIX''':

<code><INSTALL_PATH>/agent/tools</code>

Вам нужны root-права.

'''Развертывание на основе Docker'''

<code><INSTALL_PATH>/agent/tools</code>

Обратите внимание, что этот путь будет отличаться для развертывания на основе тома.

'''Windows''':

<code><INSTALL_PATH>\agent\tools</code>

Вам нужны права администратора. Если вы попытаетесь запустить <code>oneagentctl</code> в консоли Windows без прав администратора, Windows отобразит всплывающее окно контроля учетных записей и завершится ошибкой.

==Типы параметров==
Команда <code>oneagentctl</code> принимает параметр <code>get</code> для проверки состояния или значения параметра и параметр <code>set</code> для изменения параметра. Обратите внимание, что вы можете использовать несколько заданных параметров в одной команде.

==Перезапуск ЕдиныйАгент==
При использовании <code>set</code> параметров необходимо перезапустить службу ЕдиногоАгента, чтобы изменения вступили в силу. Вы можете использовать параметр <code>--restart-service</code> с командой, которая автоматически запускает перезагрузку. В некоторых случаях вам также потребуется перезапустить отслеживаемые приложения. Вы также можете использовать параметр перезапуска сам по себе, без других параметров. См. пример команды ниже.

'''Linux''' или '''AIX''':

<code>./oneagentctl --set-proxy=my-proxy.com --restart-service</code>

'''Windows''':

<code>.\oneagentctl.exe --set-proxy=my-proxy.com --restart-service</code>

==Показать справку==
Используйте параметр <code>--help</code> для отображения всех поддерживаемых параметров.

'''Linux''' или '''AIX''':

<code>./oneagentctl --help</code>

'''Windows''':

<code>.\oneagentctl.exe --help</code>

==Показать версию ЕдиногоАгента==
Используйте параметр <code>--version</code> для отображения версии ЕдиногоАгента.

'''Linux''' или '''AIX''':

<code>./oneagentctl --version</code>

'''Windows''':

<code>.\oneagentctl.exe --version</code>

==Связь с ЕдинымАгентом==

===Изменить настройки связи с ЕдинымАгентом===
<code>ЕдиныйАгент версии 1.185</code>

*Используйте параметр <code>--set-server</code>, чтобы задать конечную точку связи ЕдиногоАгента. Используйте IP-адрес или имя. В зависимости от вашего развертывания это может быть сервер Ключ-Астром, управляемый кластер Ключ-Астром или АктивныйШлюз.
*Используйте параметр <code>--set-tenant</code>, чтобы задать идентификатор среды. По умолчанию для него уже установлено правильное значение. Если вы продаете услуги на основе Ключ-Астром, используйте этот параметр, чтобы установить идентификаторы ваших клиентов из пула идентификаторов, приобретенных вами у Ключ-Астром. Всегда используйте в сочетании с параметром <code>--set-tenant-token</code>, который определяет токен клиента для внутренней проверки подлинности.
*Используйте параметр <code>--set-tenant-token</code>, чтобы установить токен клиента, который используется для аутентификации связи с определенной конечной точкой. Всегда используйте в сочетании с <code>--set-tenant</code>
*Используйте параметр <code>--set-proxy</code> для установки прокси-сервера.

Выполните следующую команду, чтобы настроить параметры подключения ЕдиногоАгента:

'''Linux''' или '''AIX''':

<code>./oneagentctl --set-server=<nowiki>https://my-server.com:443</nowiki> --set-tenant=abc123456 --set-tenant-token=abcdefg123456790 --set-proxy=my-proxy.com</code>

'''Windows''':

<code>.\oneagentctl.exe --set-server=<nowiki>https://my-server.com:443</nowiki> --set-tenant=abc123456 --set-tenant-token=abcdefg123456790 --set-proxy=my-proxy.com</code>

Эти параметры требуют перезапуска ЕдиногоАгента, а также перезапуска всех приложений, отслеживаемых модулями глубокого кода. Добавьте <code>--restart-service</code> в команду для автоматического перезапуска ЕдиногоАгента(версия 1.189+) или для остановки и запуска процесса ЕдиногоАгента вручную. Инструкции для конкретных ОС см. в [[Остановить/перезапустить ЕдиныйАгент в Linux|Linux]], [[ЕдиныйАгент остановка/перезапуск в Windows|Windows]] или AIX.

Эта команда немедленно изменит конечную точку подключения модуля ОС, но модули кода не смогут прочитать новую настройку до следующего перезапуска.

ЕдиныйАгент и Ключ-Астром Кластер автоматически поддерживают рабочее соединение. Если детали конечной точки изменяются, кластер уведомляет ЕдиныйАгент об изменении, и ЕдиныйАгент автоматически обновляет конечную точку, которую вы установили с помощью <code>--set-server</code>, до нового рабочего значения.

===Показать текущие конечные точки связи===
<code>ЕдиныйАгент версии 1.185</code>

Используйте параметр <code>--get-server</code>, чтобы отобразить конечные точки, на которые ЕдиныйАгент должен отправлять данные. Это может быть сервер Ключ-Астром, управляемый кластер Ключ-Астром или АктивныйШлюз.

'''Linux''' или '''AIX''':

<code>./oneagentctl --get-server</code>

'''Windows''':

<code>.\oneagentctl.exe --get-сервер</code>

Начиная с ЕдиногоАгента версии 1.207, конечные точки представляются в формате, в котором конечные точки с одинаковым приоритетом группируются с помощью фигурных скобок <code>({...})</code> и сортируются в соответствии с приоритетом подключения. Звездочка (<code>*</code>) указывает конечную точку, на которую ЕдиныйАгент в данный момент отправляет данные. Конечные точки разделяются точкой с запятой (<code>;</code>). Например:
 {<nowiki>https://endpoint1.com/communication;https:/10.0.0.0/communication;*https://endpoint3.com/communication}{https://endpoint4.com:443/communication}</nowiki>

===Показать идентификатор среды===
Идентификатор среды Ключ-Астром, который вы получили по электронной почте с активацией.

Используйте параметр <code>--get-tenant</code> для отображения идентификатора среды:

'''Linux''' или '''AIX''':

<code>./oneagentctl --get-tenant</code>

'''Windows''':

<code>.\oneagentctl.exe --get-tenant</code>

===Показать токен арендатора===
Используйте параметр <code>--get-tenant-token</code> для отображения текущего определенного токена:

'''Linux''' или '''AIX''':

<code>./oneagentctl --get-tenant-token</code>

'''Windows''':

<code>.\oneagentctl.exe --get-tenant-token</code>

===Показать текущий прокси===
<code>ЕдиныйАгент версии 1.185</code>

Используйте параметр <code>--get-proxy</code>, чтобы отобразить текущий определенный прокси, через который ЕдиныйАгент подключается:

'''Linux''' или '''AIX''':

<code>./oneagentctl --get-proxy</code>

'''Windows''':

<code>.\oneagentctl.exe --get-proxy</code>

===Очистить конфигурацию прокси===
Используйте для параметра <code>--set-proxy</code> пустое значение, чтобы очистить конфигурацию прокси:

'''Linux''' или '''AIX''':

<code>./oneagentctl --set-proxy=</code>

'''Windows''':

<code>.\oneagentctl.exe --set-proxy=</code> Перезапустите службу ЕдиногоАгента, чтобы изменения вступили в силу.

===Проверить текущий диапазон портов===
ЕдиныйАгент состоит из различных процессов, которые обмениваются данными через TCP-порт со сторожевым таймером. При запуске, сторожевой таймер ЕдиногоАгента пытается открыть первый доступный порт между портами 50000 и 50100. В некоторых случаях вам может понадобиться этот порт для ваших собственных приложений, которые запускаются после ЕдиногоАгента.

Используйте параметр <code>--get-watchdog-portrange</code>, чтобы проверить текущий диапазон портов, определенный для сторожевого таймера.

'''Linux''' или '''AIX''':

<code>./oneagentctl --get-watchdog-portrange</code>

'''Windows''':

<code>.\oneagentctl.exe --get-watchdog-portrange</code>

===Установить новый диапазон портов===
Используйте параметр <code>--set-watchdog-portrange=arg</code>, чтобы изменить диапазон портов прослушивания сторожевого таймера на <code><arg></code>. <code><arg></code> должен содержать два номера порта, разделенных двоеточием (<code>:</code>). Например <code>50000:50100</code>. Максимальный поддерживаемый диапазон портов — от 1024 до 65535. Диапазон портов должен охватывать не менее 4 портов. Номер порта, начиная с диапазона, должен быть меньше.

'''Linux''' или '''AIX''':

<code>./oneagentctl --set-watchdog-portrange=50000:50100</code>

'''Windows''':

<code>.\oneagentctl.exe --set-watchdog-portrange=50000:50100</code>

==Автоматические обновления==
<code>ЕдиныйАгент версии 1.213</code>

Дополнительные сведения см. в разделах по обновлению ЕдиногоАгента для [[Обновление ЕдиногоАгента в Linux|Linux]], [[Обновление ЕдиногоАгента КлючАстром в Windows|Windows]] и AIX.

===Проверьте, включено ли автоматическое обновление===
Используйте параметр <code>get-auto-update-enabled</code>, чтобы проверить, включено ли автоматическое обновление ЕдиногоАгента:

'''Linux''' или '''AIX''':

<code>./oneagentctl --get-auto-update-enabled</code>

'''Windows''':

<code>.\oneagentctl.exe --get-auto-update-enabled</code>

===Включить или отключить автообновление===
Установите для параметра <code>--set-auto-update-enabled</code> значение <code>true</code> или <code>false</code>, чтобы отключить или включить автоматическое обновление ЕдиногоАгента :

'''Linux''' или '''AIX''':

<code>./oneagentctl --set-auto-update-enabled=true</code>

'''Windows''':

<code>.\oneagentctl.exe --set-auto-update-enabled=true</code>

'''Предупреждение''': после того, как вы используете эту команду для отключения автообновлений, вы не сможете управлять автоматическими обновлениями ЕдиногоАгента с помощью веб-интерфейса Ключ-Астром в меню '''Настройки''' > '''Предпочтения''' > '''Обновления''' '''ЕдиногоАгента'''.

==Мониторинг логов==
Дополнительные сведения см. в разделе [[Мониторинг логов]]. Примечание. Мониторинг логов не поддерживается в AIX.

===Проверьте, включен ли Мониторинг логов===
Используйте параметр <code>--get-app-log-content-access</code>, чтобы проверить, включен ли мониторинг журналов:

'''Linux''':

<code>./oneagentctl --get-app-log-content-access</code>

'''Windows''':

<code>.\oneagentctl.exe --get-app-log-content-access</code>

===Включить или отключить мониторинг журналов===
Установите для параметра <code>--set-app-log-content-access</code> значение <code>true</code> или <code>false</code>, чтобы отключить или включить Мониторинг логов:

'''Linux''':

<code>./oneagentctl --set-app-log-content-access=true</code>

'''Windows''':

<code>.\oneagentctl.exe --set-app-log-content-access=true</code> Перезапустите службу ЕдиногоАгента, чтобы применить изменения.

==Создать архив поддержки==
<code>ЕдиныйАгент версии 1.225+</code>

Если у вас нет доступа к веб-интерфейсу Ключ-Астром или вы хотите создать скрипт для сбора диагностических данных, вы можете использовать команду <code>oneagentctl</code> для сбора подмножества полных [[ЕдиныйАгент диагностики|диагностических данных ЕдиногоАгента]] прямо на хосте, где установлен ЕдиныйАгент. С помощью диагностических данных, собранных для ЕдиногоАгента, вы можете:

*легко собирать диагностические данные для конкретного хоста
*напрямую предоставить службе поддержки Ключ-Астром детали, необходимые для диагностики проблемы

Команда требует, чтобы служба ЕдиногоАгента была запущена.

Чтобы создать архив поддержки с диагностическими данными, запустите <code>oneagentctl</code> с параметром <code>--create-support-archive</code>. По умолчанию архив поддержки содержит данные за 7-дневный период времени и создается в текущем рабочем каталоге. При желании вы можете установить собственный каталог и временной интервал с параметрами <code>каталога</code> и <code>дней</code>. Примечание: <code>onegentctl</code> не создает каталог; вы должны указать его на существующий каталог с относительным или абсолютным путем. Например:

'''Linux''' или '''AIX''':

<code>./oneagentctl --create-support-archive directory=/data/support-archive days=30</code>

'''Windows''':

<code>.\oneagentctl.exe --create-support-archive directory=C:\data\support-archive days=30</code>

Команда сохраняет архив как файл <code>support_archive_agent_YYYY-MM-DD_hhmmss.zip</code>. Например:
 Creating support archive from last 30 days in C:\data\support-archive
 Waiting 30s for archive request to be processed
 Processing archive, waiting up to 15m 0s
 Archive saved as C:\data\support-archive\support_archive_agent_2021-09-07_121619.zip

=== Содержание диагностических данных ===
Все собранные диагностические данные сжимаются в архив <code>support_archive_agent_YYYY-MM-DD_hhmmss.zip</code>, который включает следующее подмножество полных диагностических данных ЕдиногоАгента:
{| class="wikitable"
!Папка или файл
!Описание
|-
|<code>support_archive</code> (ZIP)
|Содержит локальную конфигурацию агента ЕдиногоАгента, установленного на узле или в процессе, в котором выполнялась процедура устранения неполадок, а также файлы журналов, связанные с ЕдинымАгентом.
|-
|<code>diagnostic_files</code> (ZIP)
|Содержит информацию об обнаружении группы процессов, проблемах автоматического внедрения и конфигурации расширения ЕдиногоАгента.
|}

== Доступ к системным журналам для проактивной поддержки ==
ЕдиныйАгент загружает определенные системные журналы, чтобы Ключ-Астром мог диагностировать проблемы, которые могут быть вызваны условиями в вашей среде. Журналы также сохраняются в архиве поддержки. Чаще всего такие проблемы связаны с глубоким мониторингом или установками автоматического обновления.

=== Проверьте, включен ли доступ к системным журналам. ===
Используйте параметр <code>--get-system-logs-access-enabled</code>, чтобы проверить, включен ли доступ к системным журналам:

'''Linux''' или '''AIX''':

<code>./oneagentctl --get-system-logs-access-enabled</code>

'''Windows''':

<code>.\oneagentctl.exe --get-system-logs-access-enabled</code>

=== Включить или отключить доступ к системным журналам ===
Установите для параметра <code>--set-system-logs-access-enabled</code> значение <code>true</code> или <code>false</code>, чтобы отключить или включить доступ к системным журналам:

'''Linux''' или '''AIX''':

<code>./oneagentctl --set-system-logs-access-enabled=true</code>

'''Windows''':

<code>.\oneagentctl.exe --set-system-logs-access-enabled=true</code> Перезапустите службу ЕдиногоАгента, чтобы изменения вступили в силу.

Обратите внимание, что параметры --set-system-logs-access-enabled и --get-system-logs-access-enabled относятся к настройке самодиагностики и не связаны с мониторингом журналов.
 '''Примечание''':
 Отключение доступа к системному журналу ограничивает наши возможности по упреждающей диагностике и устранению проблем. Если доступ к системным журналам закрыт, вам может потребоваться вручную предоставить Ключ-Астром содержимое ваших системных журналов, чтобы мы могли диагностировать проблемы в вашей среде.

== Идентификатор хоста ==
Ключ-Астром присваивает уникальный идентификатор каждому отслеживаемому узлу в вашей среде. Идентификаторы хостов можно использовать в качестве параметров в запросах Ключ-Астром API, например, Topology и Smartscape API — Hosts API. Идентификатор хоста также представляет собой URL-адрес страницы '''обзора хоста''', например, <code><nowiki>https://environment.org/#newhosts/hostdetails;id=HOST-6E56EE455C84E232</nowiki></code>.

=== Показать свой идентификатор хоста ===
<code>ЕдиныйАгент версии 1.197</code>

Чтобы найти идентификатор хоста, используйте параметр <code>--get-host-id</code>. Например:

'''Linux''' или '''AIX''':

<code>./oneagentctl --get-host-id</code>

'''Windows''':

<code>.\oneagentctl.exe --get-host-id</code>

=== Определите источник идентификатора хоста ===
Доступно на всех поддерживаемых платформах для ЕдиногоАгента версии 1.223+. Для ЕдиногоАгента версии 1.221 и более ранних эта функция поддерживается только для Citrix Virtual Apps and Desktops.

Особенно важно сохранять статический идентификатор хоста в динамических виртуальных средах, где хосты воссоздаются ежедневно.

Чтобы '''определить источник для генерации идентификатора хоста''', используйте <code>--set-host-id-source</code> и установите для него одно из предопределенных значений:

* <code>auto</code> — разрешить Ключ-Астром автоматически генерировать идентификатор хоста.
* <code>ip-addresses</code> — Сгенерируйте идентификатор хоста на основе IP-адреса хоста
* <code>mac-addresses</code> — Сгенерируйте идентификатор хоста на основе MAC-адреса сетевого адаптера хоста.
* <code>fqdn</code> — создание идентификатора узла на основе полного доменного имени узла (FQDN) в формате host.domain. Если полное доменное имя не содержит символа точки, вместо него используется MAC-адрес сетевой карты.
* Если вы отслеживаете несколько сред, вы можете разделить узлы с одинаковыми IP-адресами, MAC-адресами или полными доменными именами, используя разные пространства имен для каждой среды. Пространство имен может содержать только буквенно-цифровые символы, дефисы, символы подчеркивания и точки; максимальная длина составляет 256 символов.
** <code>ip-адреса;namespace=<пространство имен></code>
** <code>mac-адреса; namespace=<пространство имен></code>
** <code>fqdn;namespace=<пространство имен></code>

Например, чтобы установить в качестве источника идентификатора хоста <code>ip-адреса</code> и назначить его пространству имен с именем <code>test</code>, запустите <code>oneagentctl</code> со следующим параметром:

'''Linux''' или '''AIX''':

<code>./oneagentctl --set-host-id-source="ip-addresses;namespace=test"</code>

'''Windows''':

<code>.\oneagentctl.exe --set-host-id-source="ip-addresses;namespace=test"</code>

После изменения источника идентификатора хоста необходимо перезапустить все отслеживаемые приложения, а затем перезапустить службу ЕдиногоАгента, чтобы создать новый объект хоста в вашей среде. Вы можете использовать параметр <code>--restart-service</code> с <code>oneagentctl</code> для автоматического перезапуска ЕдиногоАгента или остановки и запуска процесса ЕдиногоАгента вручную. Инструкции для конкретных ОС см. в [[Остановить/перезапустить ЕдиныйАгент в Linux|Linux]], [[ЕдиныйАгент остановка/перезапуск в Windows|Windows]] или AIX.

Чтобы '''проверить источник идентификатора хоста''', используйте параметр <code>--get-host-id-source</code>:

'''Linux''' или '''AIX''':

<code>./oneagentctl --get-host-id-source</code>

'''Windows''':

<code>.\oneagentctl.exe --get-host-id-source</code>

Для источника идентификатора хоста, заданного для <code>ip-адресов</code> и пространства имен <code>test</code>, команда вернет следующий результат:
 ip-addresses;namespace=test

== Группы хостов ==
Обзор того, как использовать группы узлов, см. в разделе Организация среды с помощью групп узлов.

=== Изменить назначение группы хостов ===
Используйте параметр <code>--set-host-group</code>, чтобы изменить назначение группы хостов.

Чтобы назначить хост <code>MyHostGroup</code>:

'''Linux''' или '''AIX''':

<code>./oneagentctl --set-host-group=MyHostGroup</code>

'''Windows''':

<code>.\oneagentctl.exe --set-host-group=MyHostGroup</code>

Требования к строке группы хостов:

* Может содержать только буквенно-цифровые символы, дефисы, символы подчеркивания и точки.
* Не должен начинаться с dt.
* Максимальная длина – 100 символов.

Использование <code>--set-host-group</code> требует перезапуска ЕдиногоАгента, а также перезапуска всех отслеживаемых служб. Добавьте <code>--restart-service</code> в команду для автоматического перезапуска ЕдиногоАгента(версия 1.189+) или для остановки и запуска процесса ЕдиногоАгента вручную. Инструкции для конкретных ОС см. в [[Остановить/перезапустить ЕдиныйАгент в Linux|Linux]], [[ЕдиныйАгент остановка/перезапуск в Windows|Windows]] или AIX.

=== Очистить назначение группы хостов ===
Используйте параметр <code>--set-host-group</code> с пустым значением, чтобы очистить назначение группы хостов:

'''Linux''' или '''AIX''':

<code>./oneagentctl --set-host-group=</code>

'''Windows''':

<code>.\oneagentctl.exe --set-host-group=</code>

=== Показать назначение группы хостов ===
Используйте параметр <code>--get-host-group</code> для отображения текущего назначения группы хостов:

'''Linux''' или '''AIX''':

<code>./oneagentctl --get-host-group</code>

'''Windows''':

<code>.\oneagentctl.exe --get-host-group</code>

== Теги хоста и метаданные ==
В динамических или больших средах ручная пометка узлов может оказаться нецелесообразной. Для динамических развертываний, включающих часто меняющиеся экземпляры и имена хостов (например, AWS или MS Azure), вы можете использовать выделенные параметры <code>oneagentctl</code> для применения пользовательских тегов, имен и метаданных к вашим хостам.

Перечисленные ниже методы <code>oneagentctl</code> позволяют редактировать только метаданные, добавленные с помощью самого oneagentctl или ранее с помощью файлов конфигурации. Теги и метаданные, добавленные с помощью веб-интерфейса Ключ-Астром, а также извлеченные из контролируемой среды (например, теги AWS), не редактируются с помощью <code>oneagentctl</code> и не будут отображаться с помощью параметров<code>--get-host-tags</code> и <code>--get-host-properties</code>.

=== Пользовательское имя хоста ===
Используйте инструмент командной строки <code>oneagentctl</code> с параметром <code>--set-host-name</code>, чтобы переопределить автоматически обнаруженное имя хоста. Имя хоста не должно содержать символы <code><</code>, <code>></code>, <code>&</code>, <code>CR</code> (возврат каретки) или <code>LF</code> (перевод строки). Максимальная длина 256 символов.

'''Важно''': Эта команда добавляет пользовательское имя хоста для отображения в пользовательском интерфейсе, но обнаруженное имя хоста не изменяется. Дополнительные сведения см. в разделе Установка пользовательских имен хостов.

Чтобы изменить имя хоста:

'''Linux''' или '''AIX''': <code>./oneagentctl --set-host-name=myhostname</code>

'''Windows''': <code>.\oneagentctl.exe --set-host-name=myhostname</code>

Чтобы вернуться к автоматически определенному имени хоста, установите для параметра <code>--set-host-name</code> пустое значение, как в <code>--set-host-name=""</code>. Например:

'''Linux''' или '''AIX''': <code>./oneagentctl --set-host-name=""</code>

'''Windows''': <code>.\oneagentctl.exe --set-host-name=""</code>

Изменение может не отображаться в веб-интерфейсе Ключ-Астром до 6 минут.

Использование <code>--set-host-name</code> требует перезапуска ЕдиногоАгента. Добавьте <code>--restart-service</code> в команду для автоматического перезапуска ЕдиногоАгента (версия 1.189+) или для остановки и запуска процесса ЕдиногоАгента вручную. Инструкции для конкретных ОС см. в [[Остановить/перезапустить ЕдиныйАгент в Linux|Linux]], [[ЕдиныйАгент остановка/перезапуск в Windows|Windows]] или AIX.

Чтобы показать имя хоста:

'''Linux''' или '''AIX''':

<code>./oneagentctl --get-host-name</code>

'''Windows''':

<code>.\oneagentctl.exe --get-host-name</code>

=== Пользовательские метаданные хоста ===
После настройки настраиваемые метаданные отображаются в виде набора свойств в нижней части раздела «'''Свойства и теги'''» на странице обзора хоста. Значения свойств не должны содержать символ <code>=</code> (если только он не используется в качестве разделителя значения ключа) или пробельные символы. Максимальная длина — 256 символов, включая разделитель «ключ-значение». Имя ключа не должно начинаться с символа <code>#</code>.

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

Чтобы '''добавить или изменить свойства хоста''', выполните следующую команду:

'''Linux''' или '''AIX''':

<code>./oneagentctl --set-host-property=AppName --set-host-property=Environment=Dev</code>

'''Windows''':

<code>.\oneagentctl.exe --set-host-property=AppName --set-host-property Environment=Dev</code>

Вы можете добавить или изменить более одного свойства в одной команде.

Чтобы '''удалить свойства хоста''', выполните следующую команду:

'''Linux''' или '''AIX''':

<code>./oneagentctl --remove-host-property=AppName --remove-host-property=Environment=Dev</code>

'''Windows''':

<code>.\oneagentctl.exe --remove-host-property=AppName --remove-host-property=Environment=Dev</code>

Вы можете удалить более одного свойства с помощью одной команды. Если ключ свойства, переданный в команду, не существует, будет возвращен ненулевой код выхода, но все существующие свойства, переданные в команде, будут удалены. После удаления свойств хоста они остаются видимыми в веб-интерфейсе Ключ-Астром до 7 часов.

Чтобы <code>отобразить все свойства</code>, настроенные для хоста, выполните следующую команду:

'''Linux''' или '''AIX''':

<code>./oneagentctl --get-host-properties</code>

'''Windows''':

<code>.\oneagentctl.exe --get-host-properties</code>

=== Пользовательские теги хоста ===
После настройки пользовательских тегов хоста они отображаются в верхней части раздела «'''Свойства и теги'''» на странице обзора хоста. Значение свойства не должно содержать <code>=</code> (если только оно не используется в качестве разделителя значений ключа) или пробельные символы. Максимальная длина — 256 символов, включая разделитель «ключ-значение». Имя ключа не должно начинаться с <code>#</code>.

Чтобы '''добавить или изменить''' теги хоста, выполните следующую команду:

'''Linux''' или '''AIX''':

<code>./oneagentctl --set-host-tag=TestHost --set-host-tag=role=fallback --set-host-tag=Gdansk</code>

'''Windows''':

<code>.\oneagentctl.exe --set-host-tag=TestHost --set-host-tag=role=fallback --set-host-tag=Gdansk</code>

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

Чтобы '''удалить теги''', выполните следующую команду:

'''Linux''' или '''AIX''':

<code>./oneagentctl --remove-host-tag=role=fallback --remove-host-tag=Gdansk</code>

'''Windows''':

<code>.\oneagentctl.exe --remove-host-tag=role=fallback --remove-host-tag=Gdansk</code>

Вы можете удалить более одного тега с помощью одной и той же команды. Если тег, переданный в команде, не существует, возвращается ненулевой код выхода, но все существующие теги, переданные в команде, удаляются. После удаления теги остаются видимыми в веб-интерфейсе Ключ-Астромдо 6 часов.

Чтобы '''отобразить все теги''', настроенные для хоста, выполните следующую команду:

'''Linux''' или '''AIX''':

<code>./oneagentctl --get-host-tags</code>

'''Windows''':

<code>.\oneagentctl.exe --get-host-tags</code>

== Мониторинг инфраструктуры ==
Используйте режим мониторинга инфраструктуры вместо режима мониторинга полного стека. При таком подходе вы получаете данные о работоспособности только инфраструктуры, без данных о производительности приложений или пользователей. Дополнительные сведения см. в разделе Мониторинг инфраструктуры.

=== Проверьте, включен ли режим мониторинга инфраструктуры ===
Используйте параметр <code>--get-infra-only</code>, чтобы проверить, включен ли режим мониторинга инфраструктуры:

'''Linux''' или '''AIX''':

<code>./oneagentctl --get-infra-only</code>

'''Windows''':

<code>.\oneagentctl.exe --get-infra-only</code>

=== Включить или отключить режим мониторинга инфраструктуры ===
Установите для параметра <code>--set-infra-only</code> значение <code>true</code> или <code>false</code>, чтобы включить или отключить режим мониторинга инфраструктуры.

Чтобы включить режим мониторинга инфраструктуры:

'''Linux''' или '''AIX''':

<code>./oneagentctl --set-infra-only=true</code>

'''Windows''':

<code>.\oneagentctl.exe --set-infra-only=true</code>

Изменение режима мониторинга инфраструктуры требует перезапуска ЕдиногоАгента, а также перезапуска всех отслеживаемых служб. Добавьте <code>--restart-service</code> в команду для автоматического перезапуска ЕдиногоАгента (версия 1.189+) или для остановки и запуска процесса ЕдиногоАгента вручную. Инструкции для конкретных ОС см. в [[Остановить/перезапустить ЕдиныйАгент в Linux|Linux]], [[ЕдиныйАгент остановка/перезапуск в Windows|Windows]] или AIX.

=== Автоматическая инъекция в мониторинге инфраструктуры ===
<code>ЕдиныйАгент версии 1.213</code>

Автоматическое внедрение ЕдиногоАгента включено по умолчанию в режиме мониторинга инфраструктуры, чтобы получать и сообщать показатели JMX/PMI.

Дополнительные сведения см. в разделе Режим мониторинга инфраструктуры.

=== Проверьте, включена ли автоинъекция ===
Используйте параметр <code>get-auto-injection-enabled</code>, чтобы проверить, включено ли автоматическое внедрение ЕдиногоАгента:

'''Linux''' или '''AIX''':

<code>./oneagentctl --get-auto-injection-enabled</code>

'''Windows''':

<code>.\oneagentctl.exe --get-auto-injection-enabled</code>

=== Включить или отключить автоинъекцию ===
Установите для параметра <code>--set-auto-injection-enabled</code> значение <code>true</code> или <code>false</code>, чтобы включить или отключить автоматическую инъекцию ЕдиногоАгента:

Чтобы включить автоинъекции:

'''Linux''' или '''AIX''':

<code>./oneagentctl --set-auto-injection-enabled=true</code>

'''Windows''':

<code>.\oneagentctl.exe --set-auto-injection-enabled=true</code>

Чтобы отключить автоинъекции:

'''Linux''' или '''AIX''':

<code>./oneagentctl --set-auto-injection-enabled=false</code>

'''Windows''':

<code>.\oneagentctl.exe --set-auto-injection-enabled=false</code>

Дополнительные сведения см. в разделе Отключение автоматического внедрения.

== Прием метрик ==
<code>ЕдиныйАгент версии 1.201</code>

Прием локальных метрик в настоящее время поддерживается только в Windows и Linux.

Вы можете использовать команду <code>oneagentctl</code> для проверки или изменения портов связи, используемых для локального приема метрик, с помощью API метрик ЕдиногоАгента, интеграции сценариев, Telegraf или Ключ-АстромStatsd. Для изменения порта приема метрик требуется перезапуск ЕдиногоАгента. Добавьте <code>--restart-service</code> в команду для автоматического перезапуска ЕдиногоАгента.

Дополнительные сведения см. в разделе Прием метрик.

=== API ЕдиногоАгента, интеграция сценариев и Telegraf ===
Порт приема метрик по умолчанию — 14499. При необходимости вы можете использовать команду <code>oneagentctl</code>, чтобы проверить или изменить порт. Для изменения порта приема метрик требуется перезапуск ЕдиногоАгента. Добавьте <code>--restart-service</code> в команду для автоматического перезапуска ЕдиногоАгента.

=== Проверьте порт приема ===
Используйте параметр <code>--get-extensions-ingest-port</code>, чтобы отобразить текущий локальный порт приема, по умолчанию <code>14499</code>.

'''Linux''': <code>./oneagentctl --get-extensions-ingest-port</code>

'''Windows''': <code>.\oneagentctl.exe --get-extensions-ingest-port</code>

=== Установите собственный порт приема ===
Используйте параметр <code>--set-extensions-ingest-port=<arg></code>, чтобы задать собственный локальный порт приема.

'''Linux''': <code>./oneagentctl --set-extensions-ingest-port=14499 --restart-service</code>

'''Windows''': <code>.\oneagentctl.exe --set-extensions-ingest-port=14499 --restart-service</code>

=== Настроить прокси ===
Настройте прокси-сервер хоста, чтобы разрешить трафику локального хоста идти на порт приема метрик, по умолчанию <code>14499</code>.

=== StatsD ===

=== Прослушиватель ЕдиногоАгента ===
Порт прослушивания UDP Ключ-АстромStatsD по умолчанию для прослушивателя ЕдиногоАгента— <code>18125</code>. При необходимости можно использовать команду <code>oneagentctl</code>, чтобы проверить или изменить порт приема метрик. Изменение порта требует перезапуска ЕдиногоАгента. Добавьте <code>--restart-service</code> в команду для автоматического перезапуска ЕдиногоАгента.

==== Проверьте порт приема ====
Используйте параметр <code>--get-extensions-statsd-port</code>, чтобы показать текущий порт прослушивания UDP Ключ-АстромStatsD (по умолчанию = <code>18125</code>).

'''Linux''': <code>./oneagentctl --get-extensions-statsd-port</code>

'''Windows''': <code>.\oneagentctl.exe --get-extensions-statsd-port</code>

==== Установите собственный порт приема ====
Используйте параметр <code>--set-extensions-statsd-port=<arg></code>, чтобы установить собственный порт прослушивания UDP Ключ-АстромStatsD.

'''Linux''': <code>./oneagentctl --set-extensions-statsd-port=18125 --restart-service</code>

'''Windows''': <code>.\oneagentctl.exe --set-extensions-statsd-port=18125 --restart-service</code>

=== Удаленная статистикаD ===
Порт прослушивания UDP Ключ-АстромStatsD по умолчанию для удаленного прослушивателя — <code>18126</code>.

Чтобы изменить порт прослушивания по умолчанию <code>18126</code>, измените параметр <code>StatsdPort</code> в файле extensionsuser.conf АктивногоШлюза:

'''Linux''' <code>/var/lib/AstromKey/remotepluginmodule/agent/conf/extensionsuser.conf</code>

'''Windows''' <code>C:\ProgramData\AstromKey\remotepluginmodule\agent\conf\extensionsuser.conf</code>:
 StatsdPort=18126

== Сетевые зоны ==
Чтобы узнать о правилах именования сетевых зон и другую справочную информацию, см. раздел [[Сетевые зоны]].

=== Установить сетевую зону ===
Используйте параметр <code>--set-network-zone</code>, чтобы указать ЕдиномуАгенту обмениваться данными через указанную сетевую зону. Имя сетевой зоны представляет собой строку буквенно-цифровых символов. Вы также можете использовать дефисы (<code>-</code>), символы подчеркивания (<code>_</code>) и точку (<code>.</code>) в качестве разделителя. Имя сетевой зоны не должно начинаться с точки. Длина строки ограничена 256 символами. Имена сетевых зон не чувствительны к регистру. Ключ-Астром хранит эти имена в нижнем регистре. Дополнительные сведения см. в разделе об именовании зон сети.

В '''Linux''' или '''AIX''':

<code>./oneagentctl --set-network-zone=<your.network.zone></code>

В '''Windows''':

<code>.\oneagentctl.exe --set-network-zone=<your.network.zone></code>

==== Сбросить сетевую зону ====
Вы можете сбросить настройку сетевой зоны, передав пустое имя сетевой зоны:

В '''Linux''' или '''AIX''':

<code>./oneagentctl --set-network-zone=""</code>

В '''Windows''':

<code>.\oneagentctl.exe --set-network-zone=""</code>

=== Показать настройки зоны сети ===
Используйте параметр <code>--get-network-zone</code> для отображения текущей конфигурации сетевой зоны:

В '''Linux''' или '''AIX''':

<code>./oneagentctl --get-network-zone</code>

В '''Windows''':

<code>.\oneagentctl.exe --get-network-zone</code>

== Передача параметров конфигурации во время установки ==
Вы можете передать параметры <code>--set-*</code> во время установки. Параметры конфигурации применяются непосредственно перед запуском службы ЕдиногоАгента, и нет необходимости перезапускать ее, чтобы применить вашу конфигурацию.

=== Linux или AIX ===
Чтобы пройти через параметры конфигурации, просто добавьте параметр и поставьте перед значением знак равенства (<code>=</code>). Например:
 /bin/sh OneAgent-Linux.sh –-set-host-group=test_group

=== Windows ===

==== EXE установщик ====
Чтобы передать параметры конфигурации с помощью установщика EXE, просто добавьте параметр и поставьте перед значением знак равенства (<code>=</code>). Например:
 OneAgent-Windows.exe --set-host-group=test_group

==== MSI-пакет ====
Вы также можете передать параметры конфигурации с помощью пакета MSI. Однако на этот раз вы должны использовать дополнительный параметр <code>ADDITIONAL_CONFIGURATION</code>. Например:
 OneAgent-Windows.msi ADDITIONAL_CONFIGURATION="--set-host-group=test_group"

== Криптографические алгоритмы FIPS 140 ==
<code>ЕдиныйАгент версии 1.245+</code>

ЕдиныйАгент использует режим FIPS для обеспечения соответствия стандарту компьютерной безопасности FIPS 140-3.

=== Проверьте, включен ли FIPS 140. ===
Используйте <code>--get-fips-enabled</code>, чтобы проверить, использует ли ЕдиныйАгент проверенные криптографические алгоритмы FIPS 140.

В '''Linux''' или '''AIX'''

<code>./oneagentctl --get-fips-enabled</code>

В '''Windows'''

<code>./oneagentctl.exe --get-fips-enabled</code>

=== Включить или отключить FIPS 140 ===
Установите для параметра <code>--set-fips-enabled</code> значение <code>true</code> или <code>false</code>, чтобы включить или отключить проверенные криптографические алгоритмы FIPS 140 в ЕдиномАгенте.

Чтобы включить режим FIPS:

В '''Linux''' или '''AIX'''

<code>./oneagentctl --set-fips-enabled=true</code>

В '''Windows'''

<code>./oneagentctl.exe --set-fips-enabled=true</code>

Чтобы отключить режим FIPS:

В '''Linux''' или '''AIX'''

<code>/oneagentctl --set-fips-enabled=false</code>

В '''Windows'''

<code>./oneagentctl.exe --set-fips-enabled=false</code>

Если вы хотите включить режим FIPS для развертывания только приложений, перейдите в <code>/paas/package/agent</code> и удалите <code>dt_fips_disabled.flag</code>.