kaytus.ksmanage.event_log_info module – Get event log information

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.event_log_info.

New in kaytus.ksmanage 1.0.0

Synopsis 

Get event log information on kaytus Server.

Requirements 

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

Python 3.7+
inManage

Parameters 

Parameter	Comments
count integer	Get the most recent log of a specified number.
event_file string	Store logs to a file.
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.
log_time string	Get logs after the specified date, time should be YYYY-MM-DDTHH:MM+HH:MM, like 2019-06-27T12:30+08:00.
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

Supports check_mode.

Examples 

- name: Event log info test
  hosts: ksmanage
  connection: local
  gather_facts: false
  vars:
    ksmanage:
      host: "{{ ansible_ssh_host }}"
      username: "{{ username }}"
      password: "{{ password }}"

  tasks:

  - name: "Get event log information"
    kaytus.ksmanage.event_log_info:
      log_time: "2020-06-01T12:30+08:00"
      provider: "{{ ksmanage }}"

  - name: "Get event log information"
    kaytus.ksmanage.event_log_info:
      count: 30
      provider: "{{ ksmanage }}"

  - name: "Get event log information"
    kaytus.ksmanage.event_log_info:
      event_file: "/home/wbs/wbs.log"
      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.event_log_info module – Get event log information

Synopsis

Requirements

Parameters

Notes

Examples

Return Values