community.network.avi_backupconfiguration – Модуль для настройки объекта BackupConfiguration Avi RESTful
Примечание
Этот плагин является частью коллекции community.network (версия 1.3.0).
Для его установки используйте: ansible-galaxy collection install community.network.
Для использования в книге задач укажите: community.network.avi_backupconfiguration.
Обзор
- Этот модуль используется для конфигурирования объекта BackupConfiguration.
- Дополнительные примеры на https://github.com/avinetworks/devops
Требования
Ниже перечислены требования к хосту, на котором будет выполняться этот модуль.
- avisdk
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| api_context словарь | Контекст API Avi, включающий текущий идентификатор сессии и маркер CSRF. Это позволяет пользователю выполнить единый вход и повторно использовать сессию. | ||
| api_version строка | По умолчанию: "16.4.4" | Версия API Avi для использования с API Avi и объектами. | |
| avi_api_patch_op строка |
| Операция изменения при использовании avi_api_update_method в режиме patch. | |
| avi_api_update_method строка |
| Метод обновления объекта по умолчанию — HTTP PUT. Установка в режим patch переопределит это поведение на использование HTTP PATCH. | |
| avi_credentials словарь | Словарь учетных данных Avi, который можно использовать вместо перечисления данных входа в контроллер Avi. | ||
| api_version строка | По умолчанию: "16.4.4" | Версия контроллера Avi | |
| controller строка | IP-адрес или SQDN контроллера | ||
| csrftoken строка | CSRF-токен API контроллера Avi для повторного использования существующей сессии с идентификатором сессии | ||
| password строка | Пароль контроллера 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 в качестве факта. | |
| aws_access_key строка | Идентификатор ключа доступа AWS. Поле добавлено в 18.2.3. | ||
| aws_bucket_id строка | Ведро AWS. Поле добавлено в 18.2.3. | ||
| aws_secret_access строка | Секретный ключ доступа AWS. Поле добавлено в 18.2.3. | ||
| backup_file_prefix строка | Префикс экспортированного файла конфигурации. Поле добавлено в 17.1.1. | ||
| backup_passphrase строка | Пароль резервной копии конфигурации. | ||
| controller строка | По умолчанию: "" | IP-адрес или имя хоста контроллера. Значение по умолчанию — переменная окружения AVI_CONTROLLER. | |
| maximum_backups_stored строка | Производится ротация файлов резервных копий на основе этого количества. Допустимые значения — от 1 до 20. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 4. | ||
| name строка / обязательно | Название резервной копии конфигурации. | ||
| password строка | По умолчанию: "" | Пароль пользователя Avi в контроллере Avi. Значение по умолчанию — переменная окружения AVI_PASSWORD. | |
| remote_directory строка | Директория в удаленном пункте назначения с правами записи для пользователя ssh. | ||
| remote_hostname строка | Удаленное место назначения. | ||
| save_local логическое значение |
| Локальная резервная копия. | |
| ssh_user_ref строка | Данные доступа к удаленному пункту назначения. Это ссылка на объект типа cloudconnectoruser. | ||
| state строка |
| Состояние, которое должно быть применено к сущности. | |
| tenant строка | По умолчанию: "admin" | Имя тенента, используемого для всех вызовов API Avi и контекста объекта. | |
| tenant_ref строка | Это ссылка на объект типа tenant. | ||
| tenant_uuid строка | По умолчанию: "" | UUID тенента, используемого для всех вызовов API Avi и контекста объекта. | |
| upload_to_remote_host логическое значение |
| Удаленная резервная копия. | |
| upload_to_s3 логическое значение |
| Резервная копия в облаке. Поле добавлено в 18.2.3. | |
| url строка | URL контроллера Avi для объекта. | ||
| username строка | По умолчанию: "" | Имя пользователя для доступа к контроллеру Avi. Значение по умолчанию — переменная окружения AVI_USERNAME. | |
| uuid строка | Уникальный идентификатор объекта. | ||
Примечания
Примечание
- Дополнительную информацию об использовании Ansible для управления устройствами сети Avi см. на https://www.ansible.com/ansible-avi-networks.
Примеры
- name: Example to create BackupConfiguration object
community.network.avi_backupconfiguration:
controller: 10.10.25.42
username: admin
password: something
state: present
name: sample_backupconfiguration
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| obj словарь | успех, изменение | Объект BackupConfiguration (api/backupconfiguration) |
Авторы
- 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_backupconfiguration_module.html
