Модуль pcg.alpaca_operator.alpaca_agent — управление агентами ALPACA Operator через REST API

Примечание

Этот модуль входит в коллекцию pcg.alpaca_operator (версия 2.2.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в состав ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install pcg.alpaca_operator. Для использования этого модуля могут потребоваться дополнительные компоненты; подробности см. в разделе Требования.

Чтобы использовать его в плейбуке, укажите: pcg.alpaca_operator.alpaca_agent.

Добавлено в pcg.alpaca_operator 1.0.0

Краткое описание
Требования
Параметры
Атрибуты
Примеры
Возвращаемые значения

Краткое описание

Этот модуль позволяет создавать, обновлять и удалять агентов ALPACA Operator с помощью REST API.

Требования

Указанные ниже компоненты должны быть установлены на узле, выполняющем этот модуль.

ALPACA Operator >= 5.6.0

Параметры

Параметр	Комментарии
api_connection dictionary / обязательный добавлено в pcg.alpaca_operator 2.0.0	Параметры подключения к API ALPACA Operator.
host string добавлено в pcg.alpaca_operator 1.0.0	Имя хоста сервера ALPACA Operator. По умолчанию: `"localhost"`
password string / обязательный добавлено в pcg.alpaca_operator 1.0.0	Пароль для аутентификации в API ALPACA Operator.
port integer добавлено в pcg.alpaca_operator 1.0.0	Порт API ALPACA Operator. По умолчанию: `8443`
protocol string добавлено в pcg.alpaca_operator 1.0.0	Используемый протокол. Допустимые значения: `http` или `https`. Варианты: `"http"` `"https"` ← (по умолчанию)
tls_verify boolean добавлено в pcg.alpaca_operator 1.0.0	Проверять сертификаты SSL. Варианты: `false` `true` ← (по умолчанию)
username string / обязательный добавлено в pcg.alpaca_operator 1.0.0	Имя пользователя для аутентификации в API ALPACA Operator.
description string добавлено в pcg.alpaca_operator 1.0.0	Уникальное описание агента.
escalation dictionary добавлено в pcg.alpaca_operator 1.0.0	Конфигурация эскалации.
failures_before_report integer добавлено в pcg.alpaca_operator 2.0.0	Количество сбоев до отправки отчёта. По умолчанию: `0`
mail_address string добавлено в pcg.alpaca_operator 2.0.0	Адрес электронной почты для уведомлений. По умолчанию: `""`
mail_enabled boolean добавлено в pcg.alpaca_operator 2.0.0	Включены ли уведомления по электронной почте. Варианты: `false` ← (по умолчанию) `true`
sms_address string добавлено в pcg.alpaca_operator 2.0.0	Адрес для SMS-уведомлений. По умолчанию: `""`
sms_enabled boolean добавлено в pcg.alpaca_operator 2.0.0	Включены ли SMS-уведомления. Варианты: `false` ← (по умолчанию) `true`
ip_address string добавлено в pcg.alpaca_operator 2.0.0	IP-адрес агента.
location string добавлено в pcg.alpaca_operator 1.0.0	Расположение агента. Допустимые значения: `virtual`, `local1`, `local2` или `remote`. Варианты: `"virtual"` ← (по умолчанию) `"local1"` `"local2"` `"remote"`
name string / обязательный добавлено в pcg.alpaca_operator 1.0.0	Уникальное имя (имя хоста) агента.
new_name string добавлено в pcg.alpaca_operator 1.0.0	Необязательное новое имя агента. Если агент, указанный в `name`, существует, ему будет присвоено это имя. Если агент не существует, будет создан новый агент с этим именем.
script_group_id integer добавлено в pcg.alpaca_operator 2.0.0	Идентификатор группы скриптов. По умолчанию: `-1`
state string добавлено в pcg.alpaca_operator 1.0.0	Требуемое состояние агента. Варианты: `"present"` ← (по умолчанию) `"absent"`

Атрибуты

Атрибут	Поддержка	Описание
check_mode	Поддержка: полная	Модуль может работать в режиме check_mode и возвращать прогноз изменения состояния, не изменяя целевой объект.

Примеры

- name: Ensure agent exists
  pcg.alpaca_operator.alpaca_agent:
    name: agent01
    ip_address: 192.168.1.100
    location: virtual
    description: Test agent
    escalation:
      failures_before_report: 3
      mail_enabled: true
      mail_address: my.mail@pcg.io
      sms_enabled: true
      sms_address: 0123456789
    script_group_id: 0
    state: present
    api_connection:
      host: localhost
      port: 8443
      protocol: https
      username: secret
      password: secret
      tls_verify: False

- name: Ensure agent is absent
  pcg.alpaca_operator.alpaca_agent:
    name: agent01
    state: absent
    api_connection:
      host: localhost
      port: 8443
      protocol: https
      username: secret
      password: secret
      tls_verify: False

- name: Rename an existing agent
  pcg.alpaca_operator.alpaca_agent:
    name: agent01
    new_name: agent_renamed
    state: present
    api_connection:
      host: localhost
      port: 8443
      protocol: https
      username: secret
      password: secret
      tls_verify: False

Возвращаемые значения

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

Ключ	Описание
agent_config dictionary добавлено в pcg.alpaca_operator 1.0.0	Сведения о конфигурации созданного, обновлённого или удалённого агента Возвращается: если state имеет значение present или absent Пример: `{"description": "Test agent", "escalation": {"failures_before_report": 3, "mail_address": "monitoring@pcg.io", "mail_enabled": true, "sms_address": "", "sms_enabled": false}, "hostname": "testagent", "id": 7, "ip_address": "10.1.1.1", "location": "virtual", "script_group_id": 2}`
changed boolean добавлено в pcg.alpaca_operator 1.0.0	Указывает, были ли внесены какие-либо изменения Возвращается: всегда Пример: `true`
changes dictionary добавлено в pcg.alpaca_operator 1.0.0	Словарь с различиями между текущей и требуемой конфигурацией Возвращается: если state имеет значение present и произошло изменение Пример: `{"escalation": {"mail_enabled": {"current": false, "desired": true}}, "ip_address": {"current": "10.1.1.1", "desired": "10.1.1.2"}}`
msg string добавлено в pcg.alpaca_operator 1.0.0	Сообщение о состоянии, указывающее результат операции Возвращается: всегда Пример: `"Agent created"`

Авторы

Jan-Karsten Hansmeyer (@pcg)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/pcg/alpaca_operator/alpaca_agent_module.html