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

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

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

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

Этот модуль позволяет создавать, обновлять и удалять системы ALPACA Operator с помощью REST API. Помимо общих свойств системы, он поддерживает назначение агентов и переменных. Для обмена данными используется аутентификация на основе токенов.

Требования

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

ALPACA Operator >= 5.6.0

Параметры

Параметр	Комментарии
agents list / elements=dictionary добавлено в pcg.alpaca_operator 1.0.0	Список агентов, назначаемых системе. Каждая запись должна содержать: - `name` (строка): имя агента.
name string / обязательный добавлено в pcg.alpaca_operator 1.0.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.
checks_disabled boolean добавлено в pcg.alpaca_operator 2.0.0	Отключить автоматическую проверку работоспособности системы. Варианты: `false` `true`
description string добавлено в pcg.alpaca_operator 1.0.0	Описание системы.
group_id integer добавлено в pcg.alpaca_operator 2.0.0	Идентификатор группы (используется, если `group_name` не задан).
group_name string добавлено в pcg.alpaca_operator 2.0.0	Имя группы, к которой должна принадлежать система.
magic_number integer добавлено в pcg.alpaca_operator 2.0.0	Пользовательское числовое поле со значением от 0 до 59. Может использоваться для произвольной логики в вашей конфигурации. Варианты: `0` `1` `2` `3` `4` `5` `6` `7` `8` `9` `10` `11` `12` `13` `14` `15` `16` `17` `18` `19` `20` `21` `22` `23` `24` `25` `26` `27` `28` `29` `30` `31` `32` `33` `34` `35` `36` `37` `38` `39` `40` `41` `42` `43` `44` `45` `46` `47` `48` `49` `50` `51` `52` `53` `54` `55` `56` `57` `58` `59`
name string / обязательный добавлено в pcg.alpaca_operator 1.0.0	Уникальное имя (имя хоста) системы.
new_name string добавлено в pcg.alpaca_operator 1.0.0	Необязательное новое имя системы. Если система, указанная в `name`, существует, она будет переименована в это значение. Если система не существует, будет создана новая система с этим именем.
rfc_connection dictionary добавлено в pcg.alpaca_operator 2.0.0	Параметры подключения для доступа к API ALPACA Operator.
client string добавлено в pcg.alpaca_operator 1.0.0	Клиент для RFC-подключения.
host string добавлено в pcg.alpaca_operator 1.0.0	Имя хоста или IP-адрес целевой системы RFC.
instance_number integer добавлено в pcg.alpaca_operator 2.0.0	Номер экземпляра RFC-подключения. Варианты: `0` `1` `2` `3` `4` `5` `6` `7` `8` `9` `10` `11` `12` `13` `14` `15` `16` `17` `18` `19` `20` `21` `22` `23` `24` `25` `26` `27` `28` `29` `30` `31` `32` `33` `34` `35` `36` `37` `38` `39` `40` `41` `42` `43` `44` `45` `46` `47` `48` `49` `50` `51` `52` `53` `54` `55` `56` `57` `58` `59` `60` `61` `62` `63` `64` `65` `66` `67` `68` `69` `70` `71` `72` `73` `74` `75` `76` `77` `78` `79` `80` `81` `82` `83` `84` `85` `86` `87` `88` `89` `90` `91` `92` `93` `94` `95` `96` `97` `98` `99`
logon_group string добавлено в pcg.alpaca_operator 2.0.0	Группа входа (используется с типом `messageServer`).
password string добавлено в pcg.alpaca_operator 1.0.0	Пароль для RFC-подключения. ВАЖНО: если указать пароль в плейбуке, модуль БУДЕТ сообщать об изменении (changed=true) при каждом запуске, даже если ничего не изменилось. Это происходит потому, что API из соображений безопасности не возвращает текущий пароль, поэтому сравнить заданный пароль с текущим невозможно. Модуль не может определить, нужно ли обновить пароль. Чтобы обеспечить идемпотентность, закомментируйте или удалите параметр `rfc_connection.password` после первоначальной настройки и раскомментируйте его только тогда, когда действительно потребуется изменить пароль.
sap_router_string string добавлено в pcg.alpaca_operator 2.0.0	Строка SAProuter, используемая для установки RFC-подключения.
sid string добавлено в pcg.alpaca_operator 1.0.0	Идентификатор системы SAP (SID), состоящий из 3 заглавных буквенно-цифровых символов (A-Z, 0-9).
snc_enabled boolean добавлено в pcg.alpaca_operator 2.0.0	Включить или отключить SNC. Варианты: `false` `true`
type string добавлено в pcg.alpaca_operator 1.0.0	Тип RFC-подключения. Допустимые значения: `none`, `instance` или `messageServer`. Варианты: `"none"` `"instance"` `"messageServer"`
username string добавлено в pcg.alpaca_operator 1.0.0	Имя пользователя для RFC-подключения.
state string добавлено в pcg.alpaca_operator 1.0.0	Требуемое состояние системы. Варианты: `"present"` ← (по умолчанию) `"absent"`
variables list / elements=dictionary добавлено в pcg.alpaca_operator 1.0.0	Список переменных, назначаемых системе. Каждая запись должна содержать: - `name` (строка): имя переменной. - `value` (строка): значение, присваиваемое переменной.
name string / обязательный добавлено в pcg.alpaca_operator 1.0.0	Имя переменной.
value any / обязательный добавлено в pcg.alpaca_operator 1.0.0	Значение переменной.
variables_mode string добавлено в pcg.alpaca_operator 1.0.0	Определяет способ обработки переменных при обновлении системы. `update`: добавлять отсутствующие переменные и обновлять существующие. `replace`: добавлять отсутствующие переменные, обновлять существующие и удалять переменные, не указанные в плейбуке. Варианты: `"update"` ← (по умолчанию) `"replace"`

Атрибуты

Атрибут	Поддержка	Описание
check_mode	Поддержка: полная	Модуль можно запускать в режиме check_mode: он прогнозирует статус изменений, не изменяя целевую систему. Примечание: если указан `rfc_connection.password`, модуль всегда сообщает changed=true, даже в режиме проверки, поскольку получить текущий пароль для сравнения невозможно.

Примеры

- name: Ensure system exists
  pcg.alpaca_operator.alpaca_system:
    name: system01
    description: My Test System
    magic_number: 42
    checks_disabled: false
    group_name: test-group
    rfc_connection:
      type: instance
      host: test-host
      instance_number: 30
      sid: ABC
      logon_group: my-logon-group
      username: rfc_myUser
      password: rfc_myPasswd
      client: 123
      sap_router_string: rfc_SAPRouter
      snc_enabled: false
    agents:
      - name: localhost
      - name: testjan01-agent
    variables:
      - name: "<BKP_DATA_CLEANUP_INT>"
        value: "19"
      - name: "<BKP_DATA_CLEANUP_INT2>"
        value: "this is a string"
      - name: "<BKP_DATA_DEST2>"
        value: "11"
    state: present
    api_connection:
      host: localhost
      port: 8443
      protocol: https
      username: secret
      password: secret
      tls_verify: false

- name: Ensure system is absent
  pcg.alpaca_operator.alpaca_system:
    name: system01
    state: absent
    api_connection:
      host: localhost
      port: 8443
      protocol: https
      username: secret
      password: secret
      tls_verify: false

- name: Rename an existing system
  pcg.alpaca_operator.alpaca_system:
    name: system01
    new_name: system_renamed
    api_connection:
      host: localhost
      port: 8443
      protocol: https
      username: secret
      password: secret
      tls_verify: false

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

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

Ключ	Описание
changed boolean добавлено в pcg.alpaca_operator 1.0.0	Были ли внесены изменения Возвращается: всегда
msg string добавлено в pcg.alpaca_operator 1.0.0	Сообщение о состоянии Возвращается: всегда
system dictionary добавлено в pcg.alpaca_operator 1.0.0	Сведения о системе Возвращается: если состояние — 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_system_module.html