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 как исправления. |
| 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 boolean |
| Локальная резервная копия. |
| ssh_user_ref - | Учетные данные доступа для удаленного узла назначения. Это ссылка на объект типа cloudconnectoruser. | |
| state - |
| Состояние, которое должно быть применено к сущности. |
| tenant - | По умолчанию: "admin" | Имя домена, используемого для всех вызовов API Avi и контекста объекта. |
| tenant_ref - | Это ссылка на объект типа tenant. | |
| tenant_uuid - | По умолчанию: "" | UUID домена, используемого для всех вызовов API Avi и контекста объекта. |
| upload_to_remote_host boolean |
| Удаленная резервная копия. |
| 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. [community]
Авторы
- 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.7/modules/avi_backupconfiguration_module.html