avi_role – Модуль для настройки RESTful-объекта Роли Avi

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

Описание

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

Требования

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

avisdk

Параметры

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

Примечания

Примечание

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

Примеры

- name: Example to create Role object
  avi_role:
    controller: 10.10.25.42
    username: admin
    password: something
    state: present
    name: sample_role

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

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

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

Статус

Гарантируется, что у этого модуля не будет обратной совместимости. [превью]
Этот модуль поддерживается сообществом Ansible. [community]

Авторы

Gaurav Rastogi (@grastogi23) <grastogi@avinetworks.com>

Подсказка

Если вы заметите какие-либо проблемы в этой документации, вы можете изменить этот документ, чтобы улучшить его.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/avi_role_module.html