Модуль ieisystem.inmanage.collect_blackbox — Сбор журнала черного ящика

Примечание

Этот модуль входит в состав коллекции ieisystem.inmanage (версия 2.0.0).

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

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

Чтобы использовать его в книге задач, укажите: ieisystem.inmanage.collect_blackbox.

Новинка в ieisystem.inmanage 1.0.0

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

Обзор

Сбор журнала черного ящика на сервере ieisystem.

Требования

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

Python 3.7+
inManage

Параметры

Параметр	Комментарии
file_url строка / обязательно	Путь к файлу для скачивания.
host строка	Указывает имя хоста DNS или адрес для подключения к удалённому устройству через указанный транспорт. Значение параметра host используется в качестве адреса назначения для транспорта.
password строка	Указывает пароль для аутентификации подключения к удалённому устройству. Если значение не указано в задаче, вместо него используется значение переменной окружения `ANSIBLE_NET_PASSWORD`.
provider словарь	Объект словаря, содержащий данные подключения.
host строка	Указывает имя хоста DNS или адрес для подключения к удалённому устройству через указанный транспорт. Значение параметра host используется в качестве адреса назначения для транспорта.
password строка	Указывает пароль для аутентификации подключения к удалённому устройству. Если значение не указано в задаче, вместо него используется значение переменной окружения `ANSIBLE_NET_PASSWORD`.
username строка	Настраивает имя пользователя для аутентификации подключения к удалённому устройству. Если значение не указано в задаче, вместо него используется значение переменной окружения `ANSIBLE_NET_USERNAME`.
username строка	Настраивает имя пользователя для аутентификации подключения к удалённому устройству. Если значение не указано в задаче, вместо него используется значение переменной окружения `ANSIBLE_NET_USERNAME`.

Примечания

Примечание

Не поддерживает check_mode.

Примеры

- name: Collect blackbox test
  hosts: inmanage
  connection: local
  gather_facts: false
  vars:
    inmanage:
      host: "{{ ansible_ssh_host }}"
      username: "{{ username }}"
      password: "{{ password }}"

  tasks:

  - name: "Collect blackbox log"
    ieisystem.inmanage.collect_blackbox:
      file_url: "/home/wbs/wbs.log"
      provider: "{{ inmanage }}"

Возвращаемые значения

Общие возвращаемые значения описаны здесь, следующие — поля, уникальные для этого модуля:

Ключ	Описание
changed логическое	Проверка, были ли внесены изменения на устройстве. Возвращаемое значение: всегда
message строка	Сообщения, возвращаемые после выполнения модуля. Возвращаемое значение: всегда
state строка	Состояние после выполнения модуля. Возвращаемое значение: всегда

Авторы

WangBaoshan (@ieisystem)

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

© 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/ieisystem/inmanage/collect_blackbox_module.html