Spec-Zone.ru › Ansible

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

Примечание

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

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

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

Для использования его в playbook, укажите: cisco.mso.mso_remote_location.

  • Обзор
  • Требования
  • Параметры
  • Примечания
  • Примеры

Обзор

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

Требования

Ниже перечислены требования к хосту, на котором выполняется этот модуль.

  • Multi Site Orchestrator v2.1 или более поздней версии
END_OF_DOCUMENT_MARKER

Параметры

Параметр

Комментарии

authentication_type

string

Метод аутентификации, используемый для подключения к удаленному серверу.

Варианты:

  • "password"
  • "ssh"

description

string

Описание удаленного местоположения.

host

aliases: hostname

string

IP-адрес или имя хоста узла ACI Multi Site Orchestrator.

Если значение не указано в задаче, вместо него будет использовано значение переменной среды MSO_HOST.

login_domain

string

Имя домена входа, используемое для аутентификации.

Значение по умолчанию — Local.

Если значение не указано в задаче, вместо него будет использовано значение переменной среды MSO_LOGIN_DOMAIN.

При использовании подключаемого модуля HTTPAPI будет использоваться переменная инвентаризации ansible_httpapi_login_domain, если этот атрибут не указан.

output_level

string

Влияет на вывод этого модуля MSO.

normal означает стандартный вывод, включая current dict

info добавляет информационный вывод, включая previous, proposed и sent dict

debug добавляет отладочный вывод, включая filter_string, method, response, status и url информацию

Если значение не указано в задаче, вместо него будет использовано значение переменной среды MSO_OUTPUT_LEVEL.

Варианты:

  • "debug"
  • "info"
  • "normal" ← (по умолчанию)

password

string

Пароль, используемый для аутентификации.

Если значение не указано в задаче, вместо него будет использовано значение переменных среды MSO_PASSWORD или ANSIBLE_NET_PASSWORD.

port

integer

Номер порта, который будет использоваться для подключения REST.

Значение по умолчанию зависит от параметра `use_ssl`.

Если значение не указано в задаче, вместо него будет использовано значение переменной среды MSO_PORT.

remote_host

string

Имя хоста или IP-адрес удаленного сервера.

remote_location

aliases: name

string

Имя удаленного местоположения.

remote_password

string

Пароль, используемый для входа на удаленный сервер.

remote_path

string

Полный путь к каталогу на удаленном сервере, где сохраняются резервные копии.

Путь должен начинаться со слэша (/) и не должен содержать точек (.) или обратных слэшей (\).

Каталог должен уже существовать на сервере.

remote_port

integer

Порт, используемый для подключения к удаленному серверу.

По умолчанию: 22

remote_protocol

string

Протокол, используемый для экспорта на удаленный сервер.

Если удаленное местоположение является сервером Windows, необходимо использовать протокол sftp.

Варианты:

  • "scp"
  • "sftp"

remote_ssh_key

string

Закрытый SSH-ключ, используемый для входа на удаленный сервер.

Закрытый SSH-ключ должен быть предоставлен в формате PEM.

Закрытый SSH-ключ должен быть строкой в одну строку с разрывами строк, представленными как «\n».

remote_ssh_passphrase

string

Пароль закрытого SSH-ключа, используемый для входа на удаленный сервер.

remote_username

string

Имя пользователя, используемое для входа на удаленный сервер.

state

string

Используйте present или absent для добавления или удаления.

Используйте query для перечисления одного объекта или нескольких объектов.

Варианты:

  • "absent"
  • "present" ← (по умолчанию)
  • "query"

timeout

integer

Тайм-аут на уровне сокета в секундах.

Значение по умолчанию — 30 секунд.

Если значение не указано в задаче, вместо него будет использовано значение переменной среды MSO_TIMEOUT.

use_proxy

boolean

Если false, прокси не будет использоваться, даже если он определён в переменной среды на целевых хостах.

Если значение не указано в задании, вместо него будет использовано значение переменной среды MSO_USE_PROXY.

По умолчанию true.

Выбор:

  • false
  • true

use_ssl

boolean

Если false, вместо стандартного HTTPS-соединения будет использовано HTTP-соединение.

Если значение не указано в задании, вместо него будет использовано значение переменной среды MSO_USE_SSL.

При использовании плагина подключения HTTPAPI переменная инвентаризации ansible_httpapi_use_ssl будет использована, если этот атрибут не указан.

По умолчанию false при использовании плагина подключения HTTPAPI (mso или nd) и true при использовании метода подключения legacy (только для mso).

Выбор:

  • false
  • true

username

string

Имя пользователя для аутентификации.

Если значение не указано в задании, вместо него будут использованы значения переменных среды MSO_USERNAME или ANSIBLE_NET_USERNAME.

validate_certs

boolean

Если false, сертификаты SSL не будут проверены.

Это следует устанавливать в false только при работе с сайтами, контролируемыми лично, использующими самоподписанные сертификаты.

Если значение не указано в задании, вместо него будет использовано значение переменной среды MSO_VALIDATE_CERTS.

По умолчанию true.

Выбор:

  • false
  • true

Примечания

Примечание

  • Этот модуль был написан для поддержки Multi Site Orchestrator v2.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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/cisco/mso/mso_remote_location_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API