summaryrefslogtreecommitdiff
path: root/pyipmi/commands/bmc.py
blob: 3a91569c1a0ca9385447195b1ae67465df6e28fd (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
# Copyright (c) 2012, Calxeda Inc.
#
# All rights reserved.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are
# met:
#
# * Redistributions of source code must retain the above copyright
# notice, this list of conditions and the following disclaimer.
# * Redistributions in binary form must reproduce the above copyright
# notice, this list of conditions and the following disclaimer in the
# documentation and/or other materials provided with the distribution.
# * Neither the name of Calxeda Inc. nor the names of its contributors
# may be used to endorse or promote products derived from this software
# without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
# FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
# COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
# INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
# BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
# OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
# ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR
# TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
# THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
# DAMAGE.


"""BMC related commands"""

from .. import Command
from .. bmc import BMCInfo, BMCGuid, BMCEnables, BMCResult, BMCResetResult
from pyipmi.tools.responseparser import ResponseParserMixIn, str2bool

class GetDeviceIdCommand(Command, ResponseParserMixIn):
    """Describes the get_device_id IPMI command

    This is "bmc info" to ipmitool
    """
    name = "Get Device ID"
    result_type = BMCInfo

    response_fields = {
        "Device ID" : {},
        "Device Revision" : {},
        "Firmware Revision" : {},
        "IPMI Version" : {},
        "Manufacturer ID" : {},
        "Product ID" : { "parser" : lambda s: s.split(' ')[0] },
        "Device Available" : { "parser" : str2bool }
    }

    ipmitool_args = ["bmc", "info"]


class BMCSelfTestCommand(Command, ResponseParserMixIn):
    """Describes the get self test results IPMI command

    This is "bmc selftest" to ipmitool
    """
    name = "BMC Self Test"
    result_type = BMCResult

    response_fields = {
        "Selftest" : { }
    }

    ipmitool_args = ["bmc", "selftest"]


class GetSystemGuidCommand(Command, ResponseParserMixIn):
    """Describes the get_system_guid IPMI command

    This is "bmc guid" to ipmitool
    """
    name = "Get System GUID"
    result_type = BMCGuid

    response_fields = {
        "System GUID" : {}
    }

    ipmitool_args = ["bmc", "guid"]

class GetCommandEnables(Command, ResponseParserMixIn):
    """The Get Command Enables command
    
    In ipmitool world, this is "bmc getenables"
    """
    name = 'Get Command Enables'
    result_type = BMCEnables

    response_fields = {
        'Receive Message Queue Interrupt' : {
                'attr' : 'recv_msg_intr',
                'parser' : str2bool
        },
        'Event Message Buffer Full Interrupt' : {
                'attr' : 'event_msg_intr',
                'parser' : str2bool
        },
        'Event Message Buffer' : {
                'attr' : 'event_msg',
                'parser' : str2bool
        },
        'System Event Logging' : {
                'attr' : 'system_event_log',
                'parser' : str2bool
        },
        'OEM 0' : {
                'attr' : 'oem0',
                'parser' : str2bool
        },
        'OEM 1' : {
                'attr' : 'oem1',
                'parser' : str2bool
        },
        'OEM 2' : {
                'attr' : 'oem2',
                'parser' : str2bool
        }
    }

    ipmitool_args = ['bmc', 'getenables']


class BMCResetCommand(Command, ResponseParserMixIn):
    """The Get Command Enables command
    
    In ipmitool world, this is "bmc reset [warm|cold]"
    """
    name = 'BMC Reset'
    result_type = BMCResetResult

    response_fields = {
    }

    @property
    def ipmitool_args(self):
        return ['bmc', 'reset', self._params['type']]


bmc_commands = {
    'get_device_id' : GetDeviceIdCommand,
    'get_system_guid' : GetSystemGuidCommand,
    'get_command_enables' : GetCommandEnables,
    'selftest' : BMCSelfTestCommand,
    'bmc_reset' : BMCResetCommand
}