summaryrefslogtreecommitdiffstats
path: root/ansible_collections/inspur/ispim/plugins/modules/edit_log_setting.py
blob: c46f2b275edec85ccdf20b47b6030bda59cc03cc (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
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
#!/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: edit_log_setting
version_added: "1.0.0"
author:
    - WangBaoshan (@ispim)
short_description: Set bmc system and audit log setting
description:
   - Set bmc system and audit log setting on Inspur server.
   - Only the M5 models support this feature.
notes:
   - Does not support C(check_mode).
options:
    status:
        description:
            - System Log Status.
        choices: ['enable', 'disable']
        type: str
    type:
        description:
            - System log type.
        choices: ['local', 'remote', 'both']
        type: str
    file_size:
        description:
            - File Size(3-65535bytes), set when type is local(default 30000).
        type: int
    audit_status:
        description:
            - Audit Log Status.
        choices: ['enable', 'disable']
        type: str
    audit_type:
        description:
            - Audit log type.
        choices: ['local', 'remote', 'both']
        type: str
    rotate_count:
        description:
            - Rotate Count, set when type is local, 0-delete old files(default), 1-bak old files.
        choices: [0, 1]
        type: int
    server_addr:
        description:
            - Server Address, set when type is remote.
        type: str
    server_port:
        description:
            - Server Port(0-65535), set when type is remote.
        type: int
    protocol_type:
        description:
            - Protocol Type, set when type is remote.
        choices: ['UDP', 'TCP']
        type: str
extends_documentation_fragment:
    - inspur.ispim.ism
'''

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

  tasks:

  - name: "Edit bmc system log setting"
    inspur.ispim.edit_log_setting:
      status: "enable"
      type: "both"
      provider: "{{ ism }}"

  - name: "Edit bmc audit log setting"
    inspur.ispim.edit_log_setting:
      audit_status: "enable"
      audit_type: "remote"
      server_addr: "100.2.126.11"
      server_port: "514"
      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.ispim.plugins.module_utils.ism import (ism_argument_spec, get_connection)


class LogSetting(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=False)

    def run_command(self):
        self.module.params['subcommand'] = 'setbmclogsettings'
        self.results = get_connection(self.module)
        if self.results['State'] == 'Success':
            self.results['changed'] = True

    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(
        status=dict(type='str', required=False, choices=['enable', 'disable']),
        type=dict(type='str', required=False, choices=['local', 'remote', 'both']),
        file_size=dict(type='int', required=False),
        audit_status=dict(type='str', required=False, choices=['enable', 'disable']),
        audit_type=dict(type='str', required=False, choices=['local', 'remote', 'both']),
        rotate_count=dict(type='int', required=False, choices=[0, 1]),
        server_addr=dict(type='str', required=False),
        server_port=dict(type='int', required=False),
        protocol_type=dict(type='str', required=False, choices=['UDP', 'TCP']),
    )
    argument_spec.update(ism_argument_spec)
    log_obj = LogSetting(argument_spec)
    log_obj.work()


if __name__ == '__main__':
    main()