kaytus.ksmanage.edit_m6_log_setting module – Set bmc system and audit log setting

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

New in kaytus.ksmanage 1.0.0

Synopsis

  • Set bmc system and audit log setting on kaytus Server.

  • Only the M6 models support this feature.

Requirements

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

  • Python 3.7+

  • inManage

Parameters

Parameter

Comments

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.

host_tag

string

System log host tag, set when status=enable.

Choices:

  • "HostName"

  • "SerialNum"

  • "AssertTag"

level

string

Events Level, set when status=enable.

Choices:

  • "Critical"

  • "Warning"

  • "Info"

log_type

string

Remote Log Type, set when server_id is not none.

Choices:

  • "idl"

  • "audit"

  • "both"

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.

protocol_type

string

Protocol Type, set when status=enable.

Choices:

  • "UDP"

  • "TCP"

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.

server_addr

string

Server Address, set when server_id is not none.

server_id

integer

Syslog Server ID, set when status=enable.

Choices:

  • 0

  • 1

  • 2

  • 3

server_port

integer

Server Address, set when server_id is not none.

status

string

System Log Status.

Choices:

  • "enable"

  • "disable"

test

boolean

Test remote log settings, set when server_id is not none.

Choices:

  • false ← (default)

  • true

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: Edit log setting test
  hosts: ksmanage
  connection: local
  gather_facts: false
  vars:
    ksmanage:
      host: "{{ ansible_ssh_host }}"
      username: "{{ username }}"
      password: "{{ password }}"

  tasks:

  - name: "Edit bmc system log setting"
    kaytus.ksmanage.edit_m6_log_setting:
      status: "disable"
      provider: "{{ ksmanage }}"

  - name: "Edit bmc audit log setting"
    kaytus.ksmanage.edit_m6_log_setting:
      status: "enable"
      host_tag: "HostName"
      level: "Info"
      protocol_type: "TCP"
      server_id: 0
      server_addr: "100.2.126.11"
      server_port: 514
      log_type: "both"
      provider: "{{ ksmanage }}"

  - name: "test bmc audit log"
    kaytus.ksmanage.edit_m6_log_setting:
      server_id: 0
      test: True
      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)