avi_backupconfiguration - Модуль для настройки объекта Avi RESTful BackupConfiguration
Новый в версии 2.4.
Обзор
- Этот модуль используется для настройки объекта BackupConfiguration.
- Дополнительные примеры см. на странице https://github.com/avinetworks/devops
Требования (к хосту, на котором выполняется модуль)
- avisdk
Параметры
| параметр | обязательный | значение по умолчанию | допустимые значения | комментарии |
|---|---|---|---|---|
| api_version | нет | Версия API Avi, используемая для взаимодействия с API 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 | нет | Локальная резервная копия. | ||
| ssh_user_ref | нет | Учетные данные для доступа к удаленному узлу. Это ссылка на объект типа cloudconnectoruser. | ||
| state | нет | present |
| Состояние, которое должно быть применено к объекту. |
| tenant | нет | admin | Имя домена, используемого для всех вызовов API Avi и контекста объекта. | |
| tenant_ref | нет | Это ссылка на объект типа tenant. | ||
| tenant_uuid | нет | UUID домена, используемого для всех вызовов API Avi и контекста объекта. | ||
| upload_to_remote_host | нет | Удаленная резервная копия. | ||
| url | нет | URL контроллера Avi объекта. | ||
| username | нет | Имя пользователя для доступа к контроллеру Avi. Значение по умолчанию — переменная среды AVI_USERNAME. | ||
| uuid | нет | Уникальный идентификатор объекта. |
Примеры
- 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) | успех, изменение | dict |
Статус
Этот модуль помечен как превью, что означает, что он не гарантирует обратную совместимость интерфейса.
Чтобы помочь в разработке модулей, ознакомьтесь с Справочной информацией по сообществу и участию в разработке, Тестирование Ansible и Разработка модулей.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/avi_backupconfiguration_module.html