kaytus.ksmanage.edit_log_setting – Set bmc system and audit log setting

Note

This plugin is part of the kaytus.ksmanage collection.

To install it use: ansible-galaxy collection install kaytus.ksmanage.

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

New in version 1.0.0: of kaytus.ksmanage

Synopsis

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

  • Only the M5 models support this feature.

Requirements

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

  • Python 3.7+

  • inManage

Parameters

Parameter Choices/Defaults Comments
audit_status
string
    Choices:
  • enable
  • disable
Audit Log Status.
audit_type
string
    Choices:
  • local
  • remote
  • both
Audit log type.
file_size
integer
File Size(3-65535bytes), set when type is local(default 30000).
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.
protocol_type
string
    Choices:
  • UDP
  • TCP
Protocol Type, set when type is remote.
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.
rotate_count
integer
    Choices:
  • 0
  • 1
Rotate Count, set when type is local, 0-delete old files(default), 1-bak old files.
server_addr
string
Server Address, set when type is remote.
server_port
integer
Server Port(0-65535), set when type is remote.
status
string
    Choices:
  • enable
  • disable
System Log Status.
type
string
    Choices:
  • local
  • remote
  • both
System log type.
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: no
  vars:
    ksmanage:
      host: "{{ ansible_ssh_host }}"
      username: "{{ username }}"
      password: "{{ password }}"

  tasks:

  - name: "Edit bmc system log setting"
    kaytus.ksmanage.edit_log_setting:
      status: "enable"
      type: "both"
      provider: "{{ ksmanage }}"

  - name: "Edit bmc audit log setting"
    kaytus.ksmanage.edit_log_setting:
      audit_status: "enable"
      audit_type: "remote"
      server_addr: "100.2.126.11"
      server_port: "514"
      provider: "{{ ksmanage }}"

Return Values

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

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


Authors

  • WangBaoshan (@ieisystem)