summaryrefslogtreecommitdiffstats
path: root/ansible_collections/inspur/sm/plugins/modules/system_log_info.py
blob: 52d659c8be3c82e0b4ae11501ba6d8b3378041fb (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
#!/usr/bin/python
# -*- coding:utf-8 -*-

# Copyright (C) 2020 Inspur Inc. All Rights Reserved.
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)

from __future__ import (absolute_import, division, print_function)

__metaclass__ = type

DOCUMENTATION = '''
---
module: system_log_info
version_added: "0.1.0"
author:
    - WangBaoshan (@ISIB-group)
short_description: Get BMC system log information.
description:
   - Get BMC system log information on Inspur server.
options:
    level:
        description:
            - Log level.
        default: alert
        choices: ['alert', 'critical', 'error', 'notice', 'warning', 'debug', 'emergency', 'info']
        type: str
    log_time:
        description:
            - Get logs after the specified date, time should be YYYY-MM-DDTHH:MM+HH:MM, like 2019-06-27T12:30+08:00.
        type: str
    count:
        description:
            - Get the most recent log of a specified number.
        type: int
    system_file:
        description:
            - Store logs to a file.
        type: str
extends_documentation_fragment:
    - inspur.sm.ism
'''

EXAMPLES = '''
- name: Bmc system log info test
  hosts: ism
  connection: local
  gather_facts: no
  vars:
    ism:
      host: "{{ ansible_ssh_host }}"
      username: "{{ username }}"
      password: "{{ password }}"

  tasks:

  - name: "Get bmc system log information"
    inspur.sm.system_log_info:
      level: "alert"
      log_time: "2020-06-01T12:30+08:00"
      provider: "{{ ism }}"

  - name: "Get bmc system log information"
    inspur.sm.system_log_info:
      count: 30
      provider: "{{ ism }}"

  - name: "Get bmc system log information"
    inspur.sm.system_log_info:
      system_file: "/home/wbs/wbs.log"
      provider: "{{ ism }}"
'''

RETURN = '''
message:
    description: Messages returned after module execution.
    returned: always
    type: str
state:
    description: Status after module execution.
    returned: always
    type: str
changed:
    description: Check to see if a change was made on the device.
    returned: always
    type: bool
'''

from ansible.module_utils.basic import AnsibleModule
from ansible_collections.inspur.sm.plugins.module_utils.ism import (ism_argument_spec, get_connection)


class SystemLog(object):
    def __init__(self, argument_spec):
        self.spec = argument_spec
        self.module = None
        self.init_module()
        self.results = dict()

    def init_module(self):
        """Init module object"""

        self.module = AnsibleModule(
            argument_spec=self.spec, supports_check_mode=True)

    def run_command(self):
        self.module.params['subcommand'] = 'getsystemlog'
        self.results = get_connection(self.module)

    def show_result(self):
        """Show result"""
        self.module.exit_json(**self.results)

    def work(self):
        """Worker"""
        self.run_command()
        self.show_result()


def main():
    argument_spec = dict(
        level=dict(type='str', default='alert', choices=['alert', 'critical', 'error', 'notice', 'warning', 'debug', 'emergency', 'info']),
        log_time=dict(type='str', required=False),
        count=dict(type='int', required=False),
        system_file=dict(type='str', required=False),
    )
    argument_spec.update(ism_argument_spec)
    log_obj = SystemLog(argument_spec)
    log_obj.work()


if __name__ == '__main__':
    main()