Модуль kaytus.ksmanage.collect_log – Сбор журналов

Примечание

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

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

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

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

Новая функция в kaytus.ksmanage 1.0.0

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

Описание

Сбор журналов на сервере kaytus, занимает около 5 минут.

Требования

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

Python 3.7+
inManage

Параметры

Параметр	Комментарии
file_url строка / обязательно	Путь к загружаемому файлу или путь с именем файла, например filepath/filename.tar.
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 test
  hosts: ksmanage
  connection: local
  gather_facts: false
  vars:
    ksmanage:
      host: "{{ ansible_ssh_host }}"
      username: "{{ username }}"
      password: "{{ password }}"

  tasks:

  - name: "Collect logs"
    kaytus.ksmanage.collect_log:
      file_url: "/home/wbs/test.tar"
      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_log_module.html