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

Примечание

Этот плагин входит в коллекцию community.network (версия 2.0.1).

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

Чтобы использовать его в книге задач, укажите: community.network.avi_backup.

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

Обзор

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

Требования

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

avisdk

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
api_context словарь			Контекст API Avi, включающий текущий идентификатор сессии и маркер CSRF. Это позволяет пользователю выполнить однократный вход и повторно использовать сессию.
api_version строка		Значение по умолчанию: "16.4.4"	Версия API Avi, используемая для Avi API и объектов.
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 для повторного использования существующей сессии с маркером csrf
	tenant строка	Значение по умолчанию: "admin"	Тенд контроллера Avi
	tenant_uuid строка		UUID арендатора контроллера Avi
	timeout строка	Значение по умолчанию: 300	Таймаут запроса контроллера Avi
	token строка		Токен API контроллера Avi
	username строка		Имя пользователя контроллера Avi
avi_disable_session_cache_as_fact логическое значение		Варианты: нет ← да	Отключает кеширование информации о сессии avi в качестве факта.
backup_config_ref строка			Информация о конфигурации резервной копии. Это ссылка на объект типа backupconfiguration.
controller строка		Значение по умолчанию: ""	IP-адрес или имя хоста контроллера. Значение по умолчанию — переменная среды `AVI_CONTROLLER`.
file_name строка / обязательно			Имя файла резервной копии.
local_file_url строка			URL для загрузки файла резервной копии.
password строка		Значение по умолчанию: ""	Пароль пользователя Avi в контроллере Avi. Значение по умолчанию — переменная среды `AVI_PASSWORD`.
remote_file_url строка			URL для загрузки файла резервной копии.
scheduler_ref строка			Информация о планировщике. Это ссылка на объект типа scheduler.
state строка		Варианты: absent present ←	Состояние, которое должно быть применено к сущности.
tenant строка		Значение по умолчанию: "admin"	Имя арендатора, используемого для всех вызовов API Avi и контекста объекта.
tenant_ref строка			Это ссылка на объект типа tenant.
tenant_uuid строка		Значение по умолчанию: ""	UUID арендатора, используемого для всех вызовов API Avi и контекста объекта.
timestamp строка			Unix-временная метка создания файла резервной копии.
url строка			URL контроллера Avi объекта.
username строка		Значение по умолчанию: ""	Имя пользователя, используемое для доступа к контроллеру Avi. Значение по умолчанию — переменная среды `AVI_USERNAME`.
uuid строка			Уникальный идентификатор объекта.

Примечания

Примечание

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

Примеры

- name: Example to create Backup object
  community.network.avi_backup:
    controller: 10.10.25.42
    username: admin
    password: something
    state: present
    name: sample_backup

Значения возврата

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

Ключ	Возвращаемое значение	Описание
obj словарь	успех, изменено	Объект резервной копии (api/backup)

Авторы

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

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