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

Примечание

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

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

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

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

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

Описание

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

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

Требования

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

avisdk

Параметры

Параметр	Комментарии
api_context словарь	Контекст Avi API, включающий текущий идентификатор сессии и маркер CSRF. Это позволяет пользователю выполнить единый вход и повторно использовать сессию.
api_version строка	Версия Avi API для использования с Avi API и объектами. По умолчанию: `"16.4.4"`
avi_api_patch_op строка	Операция обновления для использования при использовании avi_api_update_method как patch. Варианты: `"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 контроллера Avi
csrftoken строка	Маркер CSRF API контроллера Avi для повторного использования существующей сессии с идентификатором сессии По умолчанию: `""`
password строка	Пароль контроллера 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`
bgp_profile строка	Информация о локальном и peer BGP.
cloud_ref строка	Ссылка на объект типа cloud.
controller строка	IP-адрес или имя хоста контроллера. Значение по умолчанию — переменная среды `AVI_CONTROLLER`
debugvrfcontext строка	Настройка флагов отладки для vrf. Поле введено в версии 17.1.1.
description строка	Определяемая пользователем описание объекта.
gateway_mon строка	Настройка проверки ping heartbeat для шлюза в движках сервисов vrf.

END_OF_DOCUMENT_MARKER

internal_gateway_monitor string	Настройка проверки работоспособности по протоколу ping для всех шлюзов по умолчанию в сервисных движках VR. Поле добавлено в 17.1.1.
name string / обязательно	Имя объекта.
password string	Пароль пользователя Avi в контроллере Avi. Значение по умолчанию — переменная окружения `AVI_PASSWORD`.
state string	Состояние, которое должно быть применено к сущности. Варианты: `"absent"` `"present"` ← (по умолчанию)
static_routes string	Список статических маршрутов.
system_default boolean	Флаг boolean для установки system_default. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как False. Варианты: `false` `true`
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	Уникальный идентификатор объекта.

Примечания

Примечание

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

Примеры

- name: Example to create VrfContext object
  community.network.avi_vrfcontext:
    controller: 10.10.25.42
    username: admin
    password: something
    state: present
    name: sample_vrfcontext

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

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

Ключ	Описание
obj словарь	Объект VrfContext (api/vrfcontext) Возвращаемое значение: 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_vrfcontext_module.html