Spec-Zone.ru › Ansible

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

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

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

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

  • Этот модуль Ansible управляет отдельной командой ALPACA Operator. Он обеспечивает точную настройку отдельных свойств команды. Используйте модуль, когда необходимо настроить или изменить конкретную команду, например изменить время ожидания, включить или отключить команду либо задать новое расписание. Команда однозначно идентифицируется сочетанием её имени (описания) и назначенного ей agentHostname. Примечание: переименование команды и переназначение её другому агенту с помощью этого модуля не поддерживаются, поскольку эти свойства используются для идентификации. Поведение при обновлении: если нужная команда уже существует, необходимо указать только поля, требуемые для её однозначной идентификации (то есть либо system.system_id, либо system.system_name, а также либо command.agent_id, либо command.agent_name). Для всех параметров, явно не заданных при вызове модуля или в сценарии, сохраняются текущие значения из конфигурации.

Требования

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

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

command

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

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

Описание требуемой команды. Оно может содержать такие поля, как command.name, command.agent_id или command.agent_name, command.process_id, command.parameters, command.schedule, command.history, command.escalation и т. д.

agent_id

integer

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

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

agent_name

string

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

Имя агента. Необязательно, если указано command.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

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

process_id

integer

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

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

schedule

dictionary

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

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

cron_expression

string

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

Выражение cron, совместимое с Quartz. Обязательно, если command.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. Обязательно, если command.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 a specific system command exist
  pcg.alpaca_operator.alpaca_command:
    system:
      system_name: system01
    command:
      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
    api_connection:
      host: "{{ ALPACA_Operator_API_Host }}"
      protocol: "{{ ALPACA_Operator_API_Protocol }}"
      port: "{{ ALPACA_Operator_API_Port }}"
      username: "{{ ALPACA_Operator_API_Username }}"
      password: "{{ ALPACA_Operator_API_Password }}"
      tls_verify: "{{ ALPACA_Operator_API_Validate_Certs }}"

- name: Delete a specific command
  pcg.alpaca_operator.alpaca_command:
  system:
      system_name: system01
  command:
      name: "BKP: DB log sync"
      agent_name: agent01
      state: absent
  api_connection:
      host: "{{ ALPACA_Operator_API_Host }}"
      protocol: "{{ ALPACA_Operator_API_Protocol }}"
      port: "{{ ALPACA_Operator_API_Port }}"
      username: "{{ ALPACA_Operator_API_Username }}"
      password: "{{ ALPACA_Operator_API_Password }}"
      tls_verify: "{{ ALPACA_Operator_API_Validate_Certs }}"

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

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

Ключ

Описание

changed

boolean

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

Были ли внесены изменения

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

changes

dictionary

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

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

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

escalation

dictionary

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

Изменённый раздел эскалации (если есть)

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

Пример: {"min_failure_count": {"current": 0, "desired": 1}}

parameters

dictionary

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

Изменённые параметры команды (если есть)

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

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

schedule

dictionary

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

Изменённый раздел расписания (если есть)

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

Пример: {"period": {"current": "manually", "desired": "every_minute"}}

command

dictionary

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

Информация об удалённой команде

Возвращается: если state=absent и команда была удалена

Пример: {"agentHostname": "agent-01", "id": 123, "name": "Backup Job"}

msg

string

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

Сообщение о состоянии, описывающее действия модуля

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

Пример: "Command updated in system 42."

payload

dictionary

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

Полные данные, которые будут отправлены в API (в режиме check_mode) или были отправлены (при наличии изменений)

Возвращается: если state имеет значение present и изменения произошли или должны произойти

Авторы

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

Spec-Zone.ru

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