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) |
| Операция патча для использования при использовании avi_api_update_method как patch. |
| avi_api_update_method (добавлено в 2.5) |
| Метод по умолчанию для обновления объекта — HTTP PUT. Установка на patch переопределит это поведение, чтобы использовать HTTP PATCH. |
| avi_credentials (добавлено в 2.5) | Словарь учетных данных Avi, который можно использовать вместо перечисления данных входа в контроллер Avi. | |
| 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 bool |
| Резервное копирование на локальном диске. |
| ssh_user_ref | Реквизиты доступа к удаленному пункту назначения. Это ссылка на объект типа cloudconnectoruser. | |
| state |
| Состояние, которое должно быть применено к сущности. |
| tenant | Значение по умолчанию: "admin" | Имя клиента, используемого для всех вызовов API Avi и контекста объекта. |
| tenant_ref | Это ссылка на объект типа tenant. | |
| tenant_uuid | Значение по умолчанию: "" | UUID клиента, используемого для всех вызовов API Avi и контекста объекта. |
| upload_to_remote_host bool |
| Резервное копирование на удаленный хост. |
| 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 dict | успех, изменено | Объект BackupConfiguration (api/backupconfiguration) |
Статус
Этот модуль помечен как предварительный, что означает, что он не гарантирует обратную совместимость интерфейса.
Техническое обслуживание
Этот модуль помечен как сообщество, что означает, что его поддерживает сообщество Ansible. Дополнительную информацию см. в разделе Техническое обслуживание и поддержка модулей.
Список других модулей, также поддерживаемых сообществом Ansible, см. здесь.
Автор
- Gaurav Rastogi (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.6/modules/avi_backupconfiguration_module.html
