avi_backupconfiguration – Модуль для настройки объекта BackupConfiguration Avi RESTful
Новый в версии 2.4.
Обзор
- Этот модуль используется для настройки объекта BackupConfiguration
- больше примеров на https://github.com/avinetworks/devops
Требования
Ниже приведены требования к хосту, на котором выполняется этот модуль.
- avisdk
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| api_context словарь добавлен в 2.5 | Контекст API Avi, включающий текущий идентификатор сессии и маркер CSRF. Это позволяет пользователю выполнить единый вход и повторно использовать сессию. | ||
| api_version строка | По умолчанию: "16.4.4" | Версия API Avi для использования с API Avi и объектами. | |
| avi_api_patch_op - добавлен в 2.5 |
| Операция исправления (patch), используемая при использовании avi_api_update_method как patch. | |
| avi_api_update_method - добавлен в 2.5 |
| Метод по умолчанию для обновления объекта — HTTP PUT. Установка в patch переопределит это поведение, чтобы использовать HTTP PATCH. | |
| avi_credentials словарь добавлен в 2.5 | Словарь учетных данных Avi, который можно использовать вместо перечисления данных входа в систему контроллера Avi. | ||
| api_version - | По умолчанию: "16.4.4" | Версия контроллера Avi | |
| controller - | IP-адрес или SQDN контроллера Avi | ||
| 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 логический добавлен в 2.6 |
| Отключает кеширование информации о сессии Avi в качестве факта. | |
| aws_access_key - добавлен в 2.9 | Идентификатор ключа доступа AWS. Поле добавлено в 18.2.3. | ||
| aws_bucket_id - добавлен в 2.9 | Ведро AWS. Поле добавлено в 18.2.3. | ||
| aws_secret_access - добавлен в 2.9 | Секретный ключ доступа 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 логический добавлен в 2.9 |
| Резервное копирование в облаке. Поле добавлено в 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
avi_backupconfiguration:
controller: 10.10.25.42
username: admin
password: something
state: present
name: sample_backupconfiguration
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| obj словарь | успех, изменение | Объект BackupConfiguration (api/backupconfiguration) |
Статус
- Гарантия обратной совместимости для данного модуля не предоставляется. [превью]
- Данный модуль поддерживается сообществом Ansible. [сообщество]
Авторы
- 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.9/modules/avi_backupconfiguration_module.html
