Spec-Zone.ru › Ansible

Модуль pcg.alpaca_operator.alpaca_command_set — управление всеми командами 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_command_set.

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

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

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

  • Этот модуль Ansible управляет полным набором команд ALPACA Operator, связанных с системой, используя REST API. Он предназначен для применения массовых изменений, например для одновременного развертывания нескольких команд или очистки существующего набора команд. Используйте этот модуль, если необходимо одновременно добавить или удалить несколько команд в указанной системе ALPACA. Он упрощает масштабные обновления системы и подходит для сценариев автоматизации. Важно: этот модуль полностью управляет набором команд в целевой системе. Все команды, не определённые через Ansible, будут удалены из системы!

Требования

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

  • 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.

commands

list / элементы=dictionary

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

Список команд, которыми нужно управлять. Каждая команда может содержать такие поля, как commands.name, commands.agent_id или commands.agent_name, commands.process_id, commands.parameters, commands.schedule, commands.history, commands.escalation и т. д.

По умолчанию: []

agent_id

integer

добавлено в pcg.alpaca_operator 2.0.0

Числовой идентификатор агента. Необязателен, если указано commands.agent_name. Примечание: если системой управляет Ansible, этот агент также должен быть назначен соответствующей системе.

agent_name

string

добавлено в pcg.alpaca_operator 2.0.0

Имя агента. Необязательно, если указано commands.agent_id. Примечание: если системой управляет Ansible, этот агент также должен быть назначен соответствующей системе.

auto_deploy

boolean

добавлено в pcg.alpaca_operator 2.0.0

Автоматически ли развертывать команду.

Допустимые значения:

  • false
  • true

critical

boolean

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

Отмечена ли команда как критическая.

Допустимые значения:

  • false
  • true

disabled

boolean

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

Отключена ли в данный момент команда.

Допустимые значения:

  • false
  • true

escalation

dictionary

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

Настройки эскалации.

mail_address

string

добавлено в pcg.alpaca_operator 2.0.0

Адрес электронной почты для оповещений.

mail_enabled

boolean

добавлено в pcg.alpaca_operator 2.0.0

Включены ли оповещения по электронной почте.

Допустимые значения:

  • false
  • true

min_failure_count

integer

добавлено в pcg.alpaca_operator 2.0.0

Минимальное количество сбоев до эскалации.

sms_address

string

добавлено в pcg.alpaca_operator 2.0.0

Номер телефона для SMS-оповещений.

sms_enabled

boolean

добавлено в pcg.alpaca_operator 2.0.0

Включены ли SMS-оповещения.

Допустимые значения:

  • false
  • true

triggers

dictionary

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

Типы событий, запускающих эскалацию.

every_change

boolean

добавлено в pcg.alpaca_operator 2.0.0

Описание в настоящее время отсутствует

Допустимые значения:

  • false
  • true

to_green

boolean

добавлено в pcg.alpaca_operator 2.0.0

Описание в настоящее время отсутствует

Допустимые значения:

  • false
  • true

to_red

boolean

добавлено в pcg.alpaca_operator 2.0.0

Описание в настоящее время отсутствует

Допустимые значения:

  • false
  • true

to_yellow

boolean

добавлено в pcg.alpaca_operator 2.0.0

Описание в настоящее время отсутствует

Допустимые значения:

  • false
  • true

history

dictionary

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

Настройки хранения истории команд.

document_all_runs

boolean

добавлено в pcg.alpaca_operator 2.0.0

Вести ли документацию по всем запускам.

Допустимые значения:

  • false
  • true

retention

integer

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

Срок хранения в секундах.

name

string

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

Имя или описание команды.

parameters

string

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

Параметры процесса.

parameters_needed

boolean

добавлено в pcg.alpaca_operator 2.0.0

Требуются ли для выполнения команды дополнительные параметры.

Допустимые значения:

  • false
  • true

process_central_id

integer

добавлено в pcg.alpaca_operator 2.0.0

Центральный / глобальный идентификатор выполняемого процесса. Необязателен, если указано commands.process_id.

process_id

integer

добавлено в pcg.alpaca_operator 2.0.0

Идентификатор выполняемого процесса. Необязателен, если указано commands.process_central_id.

schedule

dictionary

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

Настройки расписания.

cron_expression

string

добавлено в pcg.alpaca_operator 2.0.0

Выражение cron, совместимое с Quartz. Обязательно, если commands.schedule.period имеет значение cron_expression.

days_of_week

list / элементы=string

добавлено в pcg.alpaca_operator 2.0.0

Список дней недели для выполнения.

Допустимые значения:

  • "monday"
  • "tuesday"
  • "wednesday"
  • "thursday"
  • "friday"
  • "saturday"
  • "sunday"

period

string

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

Период выполнения по расписанию.

Допустимые значения:

  • "every_5min"
  • "one_per_day"
  • "hourly"
  • "manually"
  • "fixed_time"
  • "hourly_with_mn"
  • "every_minute"
  • "even_hours_with_mn"
  • "odd_hours_with_mn"
  • "even_hours"
  • "odd_hours"
  • "fixed_time_once"
  • "fixed_time_immediate"
  • "cron_expression"
  • "disabled"
  • "start_fixed_time_and_hourly_mn"

time

string

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

Время выполнения в формате HH:mm:ss. Обязательно, если commands.schedule.period имеет значение fixed_time, fixed_time_once или start_fixed_time_and_hourly_mn.

state

string

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

Требуемое состояние команды.

Допустимые значения:

  • "present" ← (по умолчанию)
  • "absent"

timeout

dictionary

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

Настройки тайм-аута выполнения команды.

type

string

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

Тип тайм-аута. Возможные значения: none, default или custom.

Допустимые значения:

  • "none"
  • "default"
  • "custom"

value

integer

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

Значение тайм-аута в секундах (для типа custom).

system

dictionary / обязательный

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

Словарь с идентификационными данными системы. Необходимо указать system.system_id или system.system_name.

system_id

integer

добавлено в pcg.alpaca_operator 2.0.0

Числовой идентификатор целевой системы. Необязателен, если указано system.system_name.

system_name

string

добавлено в pcg.alpaca_operator 2.0.0

Имя целевой системы. Необязательно, если указано system.system_id.

Атрибуты

Атрибут

Поддержка

Описание

check_mode

Поддержка: полная

Можно выполнять в режиме check_mode и возвращать прогноз изменения статуса, не изменяя целевую систему.

Примеры

- name: Ensure that multiple commands are configured correctly on system01
  pcg.alpaca_operator.alpaca_command_set:
    system:
      system_name: system01
    commands:
      - name: "BKP: DB log sync"
        state: present
        agent_name: agent01
        parameters: "-p GLTarch -s <BKP_LOG_SRC> -l 4 -d <BKP_LOG_DEST1> -r <BKP_LOG_DEST2> -b <BKP_LOG_CLEANUP_INT> -t <BKP_LOG_CLEANUP_INT2> -h DB_HOST"
        process_id: 801
        schedule:
          period: manually
          time: "01:00:00"
          days_of_week:
            - monday
            - sunday
        parameters_needed: false
        disabled: false
        critical: true
        history:
          document_all_runs: true
          retention: 900
        auto_deploy: false
        timeout:
          type: default
          value: 30
        escalation:
          mail_enabled: true
          sms_enabled: true
          mail_address: "monitoring@pcg.io"
          sms_address: "0123456789"
          min_failure_count: 1
          triggers:
            every_change: true
            to_red: false
            to_yellow: false
            to_green: true
      - name: "BKP: DB log sync 2"
        state: present
        agent_name: agent02
        parameters: "-p GLTarch -s <BKP_LOG_SRC> -l 4 -d <BKP_LOG_DEST1> -r <BKP_LOG_DEST2> -b <BKP_LOG_CLEANUP_INT> -t <BKP_LOG_CLEANUP_INT2> -h DB_HOST"
        process_id: 801
        schedule:
          period: cron_expression
          cron_expression: '0 */5 * * * ?'
        parameters_needed: false
        disabled: false
        critical: true
        history:
          document_all_runs: true
          retention: 900
        auto_deploy: false
        timeout:
          type: default
          value: 30
        escalation:
          mail_enabled: true
          sms_enabled: true
          mail_address: "monitoring@pcg.io"
          sms_address: "0123456789"
          min_failure_count: 1
          triggers:
            every_change: true
            to_red: false
            to_yellow: false
            to_green: true
    api_connection:
      host: localhost
      port: 8443
      protocol: https
      username: secret
      password: secret
      tls_verify: false

- name: Remove all commands from system system01
  pcg.alpaca_operator.alpaca_command_set:
    system:
      system_name: system01
    commands: []
    api_connection:
      host: localhost
      port: 8443
      protocol: https
      username: secret
      password: secret
      tls_verify: false

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

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

Ключ

Описание

changed

boolean

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

Были ли внесены какие-либо изменения

Возвращается: всегда

changes

dictionary

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

Словарь с описанием всех внесённых или планируемых изменений. Ключи обычно имеют формат `commandIndex_XXX` и обозначают индекс в списке `commands`. Каждая запись содержит различия между текущим и требуемым состояниями. Также включает `removed_commands`, если команды были удалены.

Возвращается: при обнаружении изменений (или если они были бы внесены в режиме check_mode)

command_index_000

dictionary

Различия для команды с индексом 0. Содержит изменённые поля с текущими и требуемыми значениями.

Возвращается: при успешном выполнении

Пример: {"parameters": {"current": "-p foo -s A -d B", "desired": "-p foo -s A -d B -t X"}, "schedule": {"period": {"current": "manually", "desired": "every_minute"}}}

removed_commands

list / элементы=dictionary

Список команд, удалённых из-за отсутствия в требуемом состоянии. Содержит полную конфигурацию каждой команды до удаления.

Возвращается: при успешном выполнении

Пример: [{"agentHostname": "my-agent-01", "agentId": 789, "autoDeploy": false, "critical": true, "disabled": false, "escalation": {"mailAddress": null, "mailEnabled": false, "minFailureCount": 0, "smsAddress": null, "smsEnabled": false, "triggers": {"everyChange": true, "toGreen": true, "toRed": true, "toYellow": true}}, "history": {"documentAllRuns": true, "retention": 900}, "id": 123, "name": "Old Command", "parameters": "-p foo -s A -d B", "parametersNeeded": false, "processId": 456, "schedule": {"daysOfWeek": [], "period": "manually", "time": "01:00:00"}, "timeout": {"type": "DEFAULT", "value": null}}]

msg

string

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

Сообщение о состоянии

Возвращается: всегда

Пример: "One or multiple commands have been created, updated or deleted in system 42"

Авторы

  • 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_command_set_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API