avi_backupconfiguration – Модуль для настройки объекта Avi RESTful BackupConfiguration
Новое в версии 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 Controller. | |
| backup_file_prefix - | Префикс экспортируемого файла конфигурации. Поле добавлено в 17.1.1. | |
| backup_passphrase - | Пароль резервной копии конфигурации. | |
| controller строка | Значение по умолчанию: "" | IP-адрес или имя хоста контроллера. Значение по умолчанию - переменная среды AVI_CONTROLLER. |
| maximum_backups_stored - | Производить ротацию файлов резервной копии на основе этого количества. Допустимые значения: 1-20. Значение по умолчанию, если не указано в API или модуле, интерпретируется Avi Controller как 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 булево |
| Резервное копирование на удаленный узел. |
| url - | URL контроллера Avi объекта. | |
| username строка | Значение по умолчанию: "" | Имя пользователя, используемое для доступа к контроллеру Avi. Значение по умолчанию - переменная среды AVI_USERNAME. |
| uuid - | Уникальный идентификатор объекта. |
Примечания
Примечание
- Дополнительную информацию об использовании Ansible для управления устройствами Avi Network см. на 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. [community]
Авторы
- 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.8/modules/avi_backupconfiguration_module.html
