ieisystem.inmanage.edit_m6_log_setting – Set bmc system and audit log setting

Note

This plugin is part of the ieisystem.inmanage collection.

To install it use: ansible-galaxy collection install ieisystem.inmanage.

To use it in a playbook, specify: ieisystem.inmanage.edit_m6_log_setting.

New in version 1.0.0: of ieisystem.inmanage

Synopsis

  • Set bmc system and audit log setting on ieisystem 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 Choices/Defaults 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
    Choices:
  • HostName
  • SerialNum
  • AssertTag
System log host tag,set when status=enable.
level
string
    Choices:
  • Critical
  • Warning
  • Info
Events Level,set when status=enable.
log_type
string
    Choices:
  • idl
  • audit
  • both
Remote Log Type,set when server_id is not none.
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 status=enable.
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
    Choices:
  • 0
  • 1
  • 2
  • 3
Syslog Server ID,set when status=enable.
server_port
integer
Server Address,set when server_id is not none.
status
string
    Choices:
  • enable
  • disable
System Log Status.
test
boolean
    Choices:
  • no ←
  • yes
Test remote log settings,set when server_id is not none.
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: inmanage
  connection: local
  gather_facts: no
  vars:
    inmanage:
      host: "{{ ansible_ssh_host }}"
      username: "{{ username }}"
      password: "{{ password }}"

  tasks:

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

  - name: "Edit bmc audit log setting"
    ieisystem.inmanage.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: "{{ inmanage }}"

  - name: "test bmc audit log"
    ieisystem.inmanage.edit_m6_log_setting:
      server_id: 0
      test: True
      provider: "{{ inmanage }}"

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)