Модуль pcg.alpaca_operator.alpaca_group — управление группами 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_group.

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

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

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

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

Требования

Перечисленные ниже требования должны быть выполнены на хосте, где выполняется этот модуль.

ALPACA Operator >= 5.6.0

Параметры

Параметр	Комментарии
api_connection словарь / обязательный добавлено в pcg.alpaca_operator 2.0.0	Параметры подключения к API ALPACA Operator.
host строка добавлено в pcg.alpaca_operator 1.0.0	Имя хоста сервера ALPACA Operator. По умолчанию: `"localhost"`
password строка / обязательный добавлено в pcg.alpaca_operator 1.0.0	Пароль для аутентификации в API ALPACA Operator.
port целое число добавлено в pcg.alpaca_operator 1.0.0	Порт API ALPACA Operator. По умолчанию: `8443`
protocol строка добавлено в pcg.alpaca_operator 1.0.0	Используемый протокол. Допустимые значения: `http` или `https`. Варианты: `"http"` `"https"` ← (по умолчанию)
tls_verify логическое значение добавлено в pcg.alpaca_operator 1.0.0	Проверять сертификаты SSL. Варианты: `false` `true` ← (по умолчанию)
username строка / обязательный добавлено в pcg.alpaca_operator 1.0.0	Имя пользователя для аутентификации в API ALPACA Operator.
name строка / обязательный добавлено в pcg.alpaca_operator 1.0.0	Имя группы.
new_name строка добавлено в pcg.alpaca_operator 1.0.0	Новое имя группы (необязательный параметр). Если группа, указанная в `name`, существует, она будет переименована в это значение. Если группа не существует, будет создана новая группа с этим именем.
state строка добавлено в pcg.alpaca_operator 1.0.0	Требуемое состояние группы. Варианты: `"present"` ← (по умолчанию) `"absent"`

Атрибуты

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

Примеры

- name: Ensure group exists
  pcg.alpaca_operator.alpaca_group:
    name: testgroup01
    state: present
    api_connection:
      host: localhost
      port: 8443
      protocol: https
      username: secret
      password: secret
      tls_verify: false

- name: Ensure group is absent
  pcg.alpaca_operator.alpaca_group:
    name: testgroup01
    state: absent
    api_connection:
      host: localhost
      port: 8443
      protocol: https
      username: secret
      password: secret
      tls_verify: false

- name: Rename an existing group
  pcg.alpaca_operator.alpaca_group:
    name: testgroup01
    new_name: testgroup_renamed
    state: present
    api_connection:
      host: localhost
      port: 8443
      protocol: https
      username: secret
      password: secret
      tls_verify: false

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

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

Ключ	Описание
changed логическое значение добавлено в pcg.alpaca_operator 1.0.0	Указывает, были ли внесены какие-либо изменения в группу Возвращается: всегда Пример: `true`
id целое число добавлено в pcg.alpaca_operator 1.0.0	Числовой идентификатор группы (если известен или группа только что создана) Возвращается: если state имеет значение present или absent и группа существует Пример: `42`
msg строка добавлено в pcg.alpaca_operator 1.0.0	Понятное пользователю сообщение с описанием результата Возвращается: всегда Пример: `"Group created"`
name строка добавлено в pcg.alpaca_operator 1.0.0	Имя группы (новой или существующей) Возвращается: всегда Пример: `"testgroup01"`

Авторы

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_group_module.html