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

Примечание

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

Эта коллекция может быть уже установлена, если вы используете пакет 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 строка / обязательно	Путь загрузки файла.
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: 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 булево	Проверка, были ли внесены изменения на устройстве. Возвращается: всегда
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/kaytus/ksmanage/collect_blackbox_module.html