Модуль cisco.mso.mso_remote_location — управление удалёнными расположениями

Примечание

Этот модуль входит в коллекцию cisco.mso (версия 2.13.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в состав ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install cisco.mso. Для использования этого модуля требуются дополнительные компоненты; подробности см. в разделе Требования.

Чтобы использовать модуль в плейбуке, укажите: cisco.mso.mso_remote_location.

Краткое описание
Требования
Параметры
Примечания
Примеры

Краткое описание

Управление удалёнными расположениями в Cisco ACI Multi-Site.

Требования

На узле, выполняющем этот модуль, должны быть установлены следующие компоненты.

Multi Site Orchestrator версии 2.1 или новее

Параметры

Параметр	Комментарии
authentication_type строка	Метод аутентификации для подключения к удалённому серверу. Варианты: `"password"` `"ssh"`
description строка	Описание удалённого расположения.
host псевдонимы: hostname строка	IP-адрес или имя узла ACI Multi Site Orchestrator. Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения `MSO_HOST`.
login_domain строка	Имя домена входа, используемого для аутентификации. Значение по умолчанию — Local. Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения `MSO_LOGIN_DOMAIN`. При использовании плагина подключения HTTPAPI, если этот атрибут не указан, будет использоваться переменная инвентаря `ansible_httpapi_login_domain`.
output_level строка	Настройка вывода этого модуля MSO. `normal` означает стандартный вывод, включая словарь `current` `info` добавляет информационный вывод, включая словари `previous`, `proposed` и `sent` `debug` добавляет отладочный вывод, включая сведения `filter_string`, `method`, `response`, `status` и `url` Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения `MSO_OUTPUT_LEVEL`. Варианты: `"debug"` `"info"` `"normal"` ← (по умолчанию)
password строка	Пароль для аутентификации. Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения `MSO_PASSWORD` или `ANSIBLE_NET_PASSWORD`.
port целое число	Номер порта для REST-подключения. Значение по умолчанию зависит от параметра `use_ssl`. Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения `MSO_PORT`.
remote_host строка	Имя узла или IP-адрес удалённого сервера.
remote_location псевдонимы: name строка	Имя удалённого расположения.
remote_password строка	Пароль для входа на удалённый сервер.
remote_path строка	Полный путь к каталогу на удалённом сервере, в котором сохраняются резервные копии. Путь должен начинаться с символа косой черты (/) и не должен содержать точки (.) или обратные косые черты (\). Каталог должен уже существовать на сервере.
remote_port целое число	Порт для подключения к удалённому серверу. По умолчанию: `22`
remote_protocol строка	Протокол для экспорта данных на удалённый сервер. Если удалённое расположение находится на сервере Windows, необходимо использовать протокол `sftp`. Варианты: `"scp"` `"sftp"`
remote_ssh_key строка	Закрытый ключ SSH для входа на удалённый сервер. Закрытый ключ SSH необходимо предоставить в формате PEM. Закрытый ключ SSH должен быть одной строкой, а переводы строк должны быть представлены как “\n”.
remote_ssh_passphrase строка	Парольная фраза закрытого ключа SSH для входа на удалённый сервер.
remote_username строка	Имя пользователя для входа на удалённый сервер.
state строка	Используйте `present` или `absent` для добавления или удаления. Используйте `query` для вывода одного или нескольких объектов. Варианты: `"absent"` `"present"` ← (по умолчанию) `"query"`
timeout целое число	Тайм-аут на уровне сокета в секундах. Значение по умолчанию — 30 секунд. Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения `MSO_TIMEOUT`.
use_proxy логическое значение	Если `false`, прокси использоваться не будет, даже если он задан в переменной окружения на целевых узлах. Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения `MSO_USE_PROXY`. Значение по умолчанию — `true`. Варианты: `false` `true`
use_ssl логическое значение	Если `false`, вместо HTTPS-подключения, используемого по умолчанию, будет использоваться HTTP-подключение. Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения `MSO_USE_SSL`. При использовании плагина подключения HTTPAPI, если этот атрибут не указан, будет использоваться переменная инвентаря `ansible_httpapi_use_ssl`. Значение по умолчанию — `false` при использовании плагина подключения HTTPAPI (mso или nd) и `true` при использовании устаревшего метода подключения (только для mso). Варианты: `false` `true`
username строка	Имя пользователя для аутентификации. Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения `MSO_USERNAME` или `ANSIBLE_NET_USERNAME`.
validate_certs логическое значение	Если `false`, сертификаты SSL проверяться не будут. Устанавливайте значение `false` только на сайтах под вашим личным контролем, использующих самоподписанные сертификаты. Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения `MSO_VALIDATE_CERTS`. Значение по умолчанию — `true`. Варианты: `false` `true`

Примечания

Примечание

Этот модуль создан для поддержки Multi Site Orchestrator версии 2.1 или новее. Часть функций или все функции могут не работать в более ранних версиях.

Примеры

- name: Query all remote locations
  cisco.mso.mso_remote_location:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    state: query
  register: backups

- name: Query a remote location
  cisco.mso.mso_remote_location:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    remote_location: ansible_test
    state: query
  register: query_result

- name: Configure a remote location
  cisco.mso.mso_remote_location:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    remote_location: ansible_test
    remote_protocol: scp
    remote_host: 10.0.0.1
    remote_path: /username/backup
    remote_authentication_type: password
    remote_username: username
    remote_password: password
    state: present

- name: Delete a remote location
  cisco.mso.mso_remote_location:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    remote_location: ansible_test
    state: absent

Авторы

Akini Ross (@akinross)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/cisco/mso/mso_remote_location_module.html