community.network.avi_hardwaresecuritymodulegroup модуль – Модуль для настройки объекта HardwareSecurityModuleGroup Avi RESTful

Примечание

Этот модуль входит в коллекцию community.network (версия 5.0.3).

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

Для установки используйте: ansible-galaxy collection install community.network. Для использования этого модуля потребуются дополнительные требования, см. Требования для получения подробной информации.

Для использования в playbook укажите: community.network.avi_hardwaresecuritymodulegroup.

Обзор
Требования
Параметры
Примечания
Примеры
Возвращаемые значения

Обзор

Этот модуль используется для настройки объекта HardwareSecurityModuleGroup
Дополнительные примеры на https://github.com/avinetworks/devops

Псевдонимы: network.avi.avi_hardwaresecuritymodulegroup

Требования

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

avisdk

Параметры

Параметр	Комментарии
api_context словарь	Контекст API Avi, включающий текущий идентификатор сеанса и маркер CSRF. Это позволяет пользователю выполнить единый вход и повторно использовать сеанс.
api_version строка	Версия API Avi для использования в Avi API и объектах. По умолчанию: `"16.4.4"`
avi_api_patch_op строка	Операция исправления, используемая при использовании avi_api_update_method как исправление. Варианты: `"add"` `"replace"` `"delete"`
avi_api_update_method строка	Метод по умолчанию для обновления объекта — HTTP PUT. Установка в patch переопределит это поведение на использование HTTP PATCH. Варианты: `"put"` ← (по умолчанию) `"patch"`
avi_credentials словарь	Словарь учетных данных Avi, который можно использовать вместо перечисления данных входа в контроллер Avi.
api_version строка	Версия контроллера Avi По умолчанию: `"16.4.4"`
controller строка	IP-адрес или SQDN контроллера
csrftoken строка	Маркер CSRF API контроллера Avi для повторного использования существующего сеанса с идентификатором сеанса По умолчанию: `""`
password строка	Пароль пользователя Avi в контроллере Avi
port строка	Порт контроллера Avi
session_id строка	Идентификатор сеанса API контроллера Avi для повторного использования существующего сеанса с csrftoken По умолчанию: `""`
tenant строка	Тенент контроллера Avi По умолчанию: `"admin"`
tenant_uuid строка	UUID тенента контроллера Avi По умолчанию: `""`
timeout строка	Таймаут запроса контроллера Avi По умолчанию: `300`
token строка	Токен API контроллера Avi По умолчанию: `""`
username строка	Имя пользователя контроллера Avi
avi_disable_session_cache_as_fact логическое	Отключает кэширование информации о сеансе avi как факта. Варианты: `false` ← (по умолчанию) `true`
controller строка	IP-адрес или имя хоста контроллера. Значение по умолчанию — переменная окружения `AVI_CONTROLLER`.
hsm строка / обязательно	Настройка модуля аппаратной безопасности.
name строка / обязательно	Имя объекта конфигурации группы модулей аппаратной безопасности.
password строка	Пароль пользователя Avi в контроллере Avi. Значение по умолчанию — переменная окружения `AVI_PASSWORD`.

state string	Состояние, которое должно быть применено к сущности. Варианты: `"absent"` `"present"` ← (по умолчанию)
tenant string	Имя арендатора, используемого для всех вызовов API Avi и контекста объекта. По умолчанию: `"admin"`
tenant_ref string	Ссылка на объект типа арендатор.
tenant_uuid string	UUID арендатора, используемого для всех вызовов API Avi и контекста объекта. По умолчанию: `""`
url string	URL контроллера Avi для объекта.
username string	Имя пользователя, используемого для доступа к контроллеру Avi. Значение по умолчанию — переменная окружения `AVI_USERNAME`.
uuid string	Uuid конфигурации группы hsm.

Примечания

Примечание

Дополнительную информацию об использовании Ansible для управления устройствами сети Avi см. на странице https://www.ansible.com/ansible-avi-networks.

Примеры

- name: Example to create HardwareSecurityModuleGroup object
  community.network.avi_hardwaresecuritymodulegroup:
    controller: 10.10.25.42
    username: admin
    password: something
    state: present
    name: sample_hardwaresecuritymodulegroup

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

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

Ключ	Описание
obj словарь	Объект HardwareSecurityModuleGroup (api/hardwaresecuritymodulegroup) Возвращается: success, changed

Авторы

Gaurav Rastogi (@grastogi23)

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

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/network/avi_hardwaresecuritymodulegroup_module.html