Spec-Zone.ru › Ansible 2.10

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

Примечание

Этот плагин является частью коллекции community.network (версия 1.3.0).

Для его установки используйте: ansible-galaxy collection install community.network

Для использования в книге задач укажите: community.network.avi_role

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

Обзор

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

Требования

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

  • avisdk

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
api_context
словарь
Контекст API Avi, включающий текущий идентификатор сеанса и токен CSRF.
Это позволяет пользователю выполнить единый вход и повторно использовать сеанс.
api_version
строка
Значение по умолчанию:
"16.4.4"
Версия API Avi для использования с API Avi и объектами.
avi_api_patch_op
строка
    Варианты:
  • add
  • replace
  • delete
Операция исправления, используемая при использовании avi_api_update_method как patch.
avi_api_update_method
строка
    Варианты:
  • put ←
  • patch
Метод по умолчанию для обновления объекта — HTTP PUT.
Установка в patch переопределит это поведение, чтобы использовать HTTP PATCH.
avi_credentials
словарь
Словарь учетных данных Avi, который можно использовать вместо перечисления данных входа в контроллер Avi.
api_version
строка
Значение по умолчанию:
"16.4.4"
Версия контроллера Avi
controller
строка
IP-адрес или SQDN контроллера
csrftoken
строка
Токен csrf контроллера 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
логическое
    Варианты:
  • нет ←
  • да
Отключает кеширование информации о сеансе 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
  community.network.avi_role:
    controller: 10.10.25.42
    username: admin
    password: something
    state: present
    name: sample_role

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

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

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



Авторы

  • 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.10/collections/community/network/avi_role_module.html

Spec-Zone.ru

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