community.network.avi_customipamdnsprofile модуль — Модуль для настройки объекта CustomIpamDnsProfile Avi RESTful
Примечание
Этот модуль входит в коллекцию community.network (версия 5.0.3).
У вас, возможно, уже установлена эта коллекция, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install community.network. Для использования этого модуля необходимы дополнительные требования, см. Требования для получения подробностей.
Чтобы использовать его в playbook, укажите: community.network.avi_customipamdnsprofile.
Описание
- Этот модуль используется для конфигурации объекта CustomIpamDnsProfile
- Дополнительные примеры см. на https://github.com/avinetworks/devops
Псевдонимы: network.avi.avi_customipamdnsprofile
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- avisdk
Параметры
Параметр | Комментарии |
|---|---|
api_context словарь | Контекст API Avi, включающий текущий идентификатор сессии и маркер CSRF. Это позволяет пользователю выполнить единый вход и повторно использовать сессию. |
api_version строка | Версия API Avi для использования с Avi API и объектами. Значение по умолчанию: |
avi_api_patch_op строка | Операция обновления (патча) для использования при использовании avi_api_update_method как patch. Варианты:
|
avi_api_update_method строка | Метод обновления объекта по умолчанию — HTTP PUT. Установление значения в patch переопределит это поведение на использование HTTP PATCH. Варианты:
|
avi_credentials словарь | Словарь учетных данных Avi, который может использоваться вместо указания данных входа в контроллер Avi. |
|
api_version строка |
Версия контроллера Avi Значение по умолчанию: |
|
controller строка |
IP-адрес или SQDN контроллера |
|
csrftoken строка |
Маркер csrftoken API контроллера Avi для повторного использования существующей сессии с идентификатором сессии Значение по умолчанию: |
|
password строка |
Пароль пользователя Avi в контроллере Avi |
|
port строка |
Порт контроллера Avi |
|
session_id строка |
Идентификатор сессии API контроллера Avi для повторного использования существующей сессии с csrftoken Значение по умолчанию: |
|
tenant строка |
Тенент контроллера Avi Значение по умолчанию: |
|
tenant_uuid строка |
UUID тенента контроллера Avi Значение по умолчанию: |
|
timeout строка |
Таймаут запроса контроллера Avi Значение по умолчанию: |
|
token строка |
Токен API контроллера Avi Значение по умолчанию: |
|
username строка |
Имя пользователя контроллера Avi |
avi_disable_session_cache_as_fact булево | Отключает кэширование информации о сессии Avi в качестве факта. Варианты:
|
controller строка | IP-адрес или имя хоста контроллера. Значение по умолчанию — переменная среды |
name строка / обязательно | Имя пользовательского профиля ipam dns. Поле введено в 17.1.1. |
password строка | Пароль пользователя Avi в контроллере Avi. Значение по умолчанию — переменная среды |
script_params строка | Параметры, которые всегда передаются скрипту ipam/dns. Поле введено в 17.1.1. |
script_uri строка / обязательно | URI скрипта в формате контроллер //ipamdnsscripts/<имя_файла>. Поле введено в 17.1.1. |
состояние строка | Состояние, которое должно быть применено к объекту. Варианты:
|
арендатор строка | Имя арендатора, используемого для всех вызовов API Avi и контекста объекта. По умолчанию: |
ссылка_арендатора строка | Ссылка на объект типа арендатор. Поле добавлено в 17.1.1. |
uuid_арендатора строка | UUID арендатора, используемого для всех вызовов API Avi и контекста объекта. По умолчанию: |
url строка | URL контроллера Avi для объекта. |
имя_пользователя строка | Имя пользователя для доступа к контроллеру Avi. Значение по умолчанию — переменная среды |
uuid строка | Поле добавлено в 17.1.1. |
Примечания
Примечание
- Дополнительную информацию об использовании Ansible для управления устройствами сети Avi см. на https://www.ansible.com/ansible-avi-networks.
Примеры
- name: Example to create CustomIpamDnsProfile object
community.network.avi_customipamdnsprofile:
controller: 10.10.25.42
username: admin
password: something
state: present
name: sample_customipamdnsprofile
Возвращаемые значения
Общие значения возвращаемых данных описаны здесь, следующие поля уникальны для данного модуля:
Ключ | Описание |
|---|---|
obj словарь | Объект CustomIpamDnsProfile (api/customipamdnsprofile) Возвращается: success, changed |
Ссылки на коллекции
© 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_customipamdnsprofile_module.html