kaytus.ksmanage.collect_log module – Collect logs

Note

This module is part of the kaytus.ksmanage collection (version 2.0.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install kaytus.ksmanage. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: kaytus.ksmanage.collect_log.

New in kaytus.ksmanage 1.0.0

Synopsis 

Collect logs on kaytus Server, it takes about 5 minutes.

Requirements 

The below requirements are needed on the host that executes this module.

Python 3.7+
inManage

Parameters 

Parameter	Comments
file_url string / required	File download path or path with filename, for example filepath/filename.tar.
host string	Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
password string	Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead.
provider dictionary	A dict object containing connection details.
host string	Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
password string	Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead.
username string	Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead.
username string	Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead.

Notes 

Note

Does not support check_mode.

Examples 

- 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 }}"

Return Values 

Common return values are documented here, the following are the fields unique to this module:

Key	Description
changed boolean	Check to see if a change was made on the device. Returned: always
message string	Messages returned after module execution. Returned: always
state string	Status after module execution. Returned: always

Authors

WangBaoshan (@ieisystem)

kaytus.ksmanage.collect_log module – Collect logs

Synopsis

Requirements

Parameters

Notes

Examples

Return Values