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

Примечание

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

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

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

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

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

Описание

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

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

Требования

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

avisdk

END_OF_DOCUMENT_MARKER

Параметры

Параметр	Комментарии
api_context словарь	Контекст API Avi, включающий текущий идентификатор сессии и CSRF-токен. Это позволяет пользователю выполнить однократный вход и повторно использовать сессию.
api_version строка	Версия API Avi для использования с Avi API и объектами. По умолчанию: `"16.4.4"`
avi_api_patch_op строка	Операция исправления для использования при использовании avi_api_update_method как исправление. Выбираемые значения: `"add"` `"replace"` `"delete"`
avi_api_update_method строка	Метод обновления объекта по умолчанию — HTTP PUT. Установка в исправление переопределит это поведение для использования HTTP PATCH. Выбираемые значения: `"put"` ← (по умолчанию) `"patch"`
avi_credentials словарь	Словарь Avi Credentials, который можно использовать вместо перечисления данных входа в Avi Controller.
api_version строка	Версия контроллера Avi По умолчанию: `"16.4.4"`
controller строка	IP-адрес или SQDN контроллера
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`
backup_config_ref строка	Информация о конфигурации резервного копирования. Это ссылка на объект типа backupconfiguration.
controller строка	IP-адрес или имя хоста контроллера. Значение по умолчанию — переменная среды `AVI_CONTROLLER`
file_name строка / обязательно	Имя файла резервной копии.
local_file_url строка	URL для скачивания файла резервной копии.
password строка	Пароль пользователя Avi в контроллере Avi. Значение по умолчанию — переменная среды `AVI_PASSWORD`
remote_file_url строка	URL для скачивания файла резервной копии.

END_OF_DOCUMENT_MARKER

scheduler_ref string	Информация о планировщике. Это ссылка на объект типа планировщик.
state string	Состояние, которое должно быть применено к объекту. Варианты: `"absent"` `"present"` ← (по умолчанию)
tenant string	Имя используемого для всех вызовов API Avi и контекста объекта арендатора. По умолчанию: `"admin"`
tenant_ref string	Ссылка на объект типа арендатор.
tenant_uuid string	UUID арендатора, используемого для всех вызовов API Avi и контекста объекта. По умолчанию: `""`
timestamp string	Маркер времени (Unix timestamp) создания файла резервной копии.
url string	URL контроллера Avi для объекта.
username string	Имя пользователя для доступа к контроллеру Avi. Значение по умолчанию — переменная окружения `AVI_USERNAME`.
uuid string	Уникальный идентификатор объекта.

Примечания

Примечание

Дополнительную информацию об использовании Ansible для управления устройствами сети Avi см. на странице 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) Возвращаемое значение: 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_backup_module.html