Модуль community.network.avi_backupconfiguration – Модуль для настройки объекта BackupConfiguration Avi RESTful
Примечание
Этот модуль является частью коллекции community.network (версия 5.0.3).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install community.network. Для использования этого модуля необходимы дополнительные требования, см. Требования для подробностей.
Чтобы использовать его в книге задач, укажите: community.network.avi_backupconfiguration.
Обзор
- Этот модуль используется для настройки объекта BackupConfiguration
- Дополнительные примеры см. на странице https://github.com/avinetworks/devops
Псевдонимы: network.avi.avi_backupconfiguration
Требования
Ниже приведены требования, необходимые на хосте, который выполняет этот модуль.
- avisdk
Параметры
Параметр | Комментарии |
|---|---|
api_context словарь | Контекст API Avi, включающий текущий идентификатор сессии и маркер CSRF. Это позволяет пользователю выполнить однократный вход и повторно использовать сессию. |
api_version строка | Версия API Avi для использования с API Avi и объектами. По умолчанию: |
avi_api_patch_op строка | Операция обновления для использования при использовании avi_api_update_method как patch. Варианты:
|
avi_api_update_method строка | Метод обновления объекта по умолчанию — HTTP PUT. Установление в patch переопределит это поведение, чтобы использовать HTTP PATCH. Варианты:
|
avi_credentials словарь | Словарь учетных данных Avi, который можно использовать вместо перечисления данных входа в контроллер Avi. |
|
api_version строка |
Версия контроллера Avi По умолчанию: |
|
controller строка |
IP-адрес или SQDN контроллера Avi |
|
csrftoken строка |
Маркер CSRF API контроллера Avi для повторного использования существующей сессии с идентификатором сессии По умолчанию: |
|
password строка |
Пароль контроллера Avi |
|
port строка |
Порт контроллера Avi |
|
session_id строка |
Идентификатор сессии API контроллера Avi для повторного использования существующей сессии с csrftoken По умолчанию: |
|
tenant строка |
Тенент контроллера Avi По умолчанию: |
|
tenant_uuid строка |
UUID тенента контроллера Avi По умолчанию: |
|
timeout строка |
Таймаут запроса контроллера Avi По умолчанию: |
|
token строка |
Токен API контроллера Avi По умолчанию: |
|
username строка |
Имя пользователя контроллера Avi |
avi_disable_session_cache_as_fact логическое | Отключает кеширование информации о сессии Avi в качестве факта. Варианты:
|
aws_access_key строка | Идентификатор ключа доступа AWS. Поле введено в 18.2.3. |
aws_bucket_id строка | Ведро AWS. Поле введено в 18.2.3. |
aws_secret_access строка | Секретный ключ доступа AWS. Поле введено в 18.2.3. |
backup_file_prefix строка | Префикс экспортированного файла конфигурации. Поле введено в 17.1.1. |
backup_passphrase строка | Пароль резервной копии конфигурации. |
controller string | IP-адрес или имя хоста контроллера. Значение по умолчанию — переменная окружения |
maximum_backups_stored string | Вращение файлов резервных копий на основе этого значения. Допустимые значения: 1-20. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 4. |
name string / обязательно | Имя конфигурации резервного копирования. |
password string | Пароль пользователя Avi в контроллере Avi. Значение по умолчанию — переменная окружения |
remote_directory string | Директория в удалённом пункте назначения с правом записи для пользователя ssh. |
remote_hostname string | Удаленное место назначения. |
save_local boolean | Локальное резервное копирование. Варианты:
|
ssh_user_ref string | Реквизиты доступа к удалённому пункту назначения. Это ссылка на объект типа cloudconnectoruser. |
state string | Состояние, которое должно быть применено к сущности. Варианты:
|
tenant string | Имя клиента, используемого для всех вызовов API Avi и контекста объекта. По умолчанию: |
tenant_ref string | Ссылка на объект типа клиент. |
tenant_uuid string | UUID клиента, используемого для всех вызовов API Avi и контекста объекта. По умолчанию: |
upload_to_remote_host boolean | Удаленное резервное копирование. Варианты:
|
upload_to_s3 boolean | Резервное копирование в облаке. Поле введено в 18.2.3. Варианты:
|
url string | URL контроллера Avi для объекта. |
username string | Имя пользователя для доступа к контроллеру Avi. Значение по умолчанию — переменная окружения |
uuid string | Уникальный идентификатор объекта. |
Примечания
Примечание
- Дополнительную информацию об использовании Ansible для управления устройствами Avi Network см. на странице https://www.ansible.com/ansible-avi-networks.
Примеры
- name: Example to create BackupConfiguration object
community.network.avi_backupconfiguration:
controller: 10.10.25.42
username: admin
password: something
state: present
name: sample_backupconfiguration
Значения возврата
Общие значения возврата описаны в этом разделе, следующие поля уникальны для данного модуля:
Ключ | Описание |
|---|---|
obj словарь | Объект BackupConfiguration (api/backupconfiguration) Возвращаемое значение: успех, изменение |
Ссылки на коллекции
© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/network/avi_backupconfiguration_module.html
