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

Примечание

Этот модуль входит в коллекцию kaytus.ksmanage (версия 2.0.0).

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

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

Чтобы использовать модуль в плейбуке, укажите: kaytus.ksmanage.collect_blackbox.

Добавлен в kaytus.ksmanage 1.0.0

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

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

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

Требования

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

Python 3.7+
inManage

Параметры

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

Примечания

Примечание

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

Примеры

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

  tasks:

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

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

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

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

Авторы

WangBaoshan (@ieisystem)

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

© 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/kaytus/ksmanage/collect_blackbox_module.html