/usr/lib/python2.7/dist-packages/provisioningserver/power_schema.py is in python-maas-provisioningserver 1.5.4+bzr2294-0ubuntu1.2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 | # Copyright 2012-2014 Canonical Ltd. This software is licensed under the
# GNU Affero General Public License version 3 (see the file LICENSE).
"""Define json schema for power parameters."""
from __future__ import (
absolute_import,
print_function,
unicode_literals,
)
str = None
__metaclass__ = type
__all__ = [
"JSON_POWER_TYPE_PARAMETERS",
"JSON_POWER_TYPE_SCHEMA",
"POWER_TYPE_PARAMETER_FIELD_SCHEMA",
]
from jsonschema import validate
# We specifically declare this here so that a node not knowing its own
# powertype won't fail to enlist. However, we don't want it in the list
# of power types since setting a node's power type to "I don't know"
# from another type doens't make any sense.
UNKNOWN_POWER_TYPE = ''
class IPMI_DRIVER:
DEFAULT = ''
LAN = 'LAN'
LAN_2_0 = 'LAN_2_0'
IPMI_DRIVER_CHOICES = [
[IPMI_DRIVER.LAN, "LAN [IPMI 1.5]"],
[IPMI_DRIVER.LAN_2_0, "LAN_2_0 [IPMI 2.0]"],
]
# Represent the Django choices format as JSON; an array of 2-item
# arrays.
CHOICE_FIELD_SCHEMA = {
'type': 'array',
'items': {
'title': "Power type paramter field choice",
'type': 'array',
'minItems': 2,
'maxItems': 2,
'uniqueItems': True,
'items': {
'type': 'string',
}
},
}
POWER_TYPE_PARAMETER_FIELD_SCHEMA = {
'title': "Power type parameter field",
'type': 'object',
'properties': {
'name': {
'type': 'string',
},
'field_type': {
'type': 'string',
},
'label': {
'type': 'string',
},
'required': {
'type': 'boolean',
},
'choices': CHOICE_FIELD_SCHEMA,
'default': {
'type': 'string',
},
},
'required': ['field_type', 'label', 'required'],
}
# A basic JSON schema for what power type parameters should look like.
JSON_POWER_TYPE_SCHEMA = {
'title': "Power parameters set",
'type': 'array',
'items': {
'title': "Power type parameters",
'type': 'object',
'properties': {
'name': {
'type': 'string',
},
'description': {
'type': 'string',
},
'fields': {
'type': 'array',
'items': POWER_TYPE_PARAMETER_FIELD_SCHEMA,
},
},
'required': ['name', 'description', 'fields'],
},
}
# Power control choices for sm15k power type
SM15K_POWER_CONTROL_CHOICES = [
["ipmi", "IPMI"],
["restapi", "REST API v0.9"],
["restapi2", "REST API v2.0"],
]
def make_json_field(
name, label, field_type=None, choices=None, default=None,
required=False):
"""Helper function for building a JSON power type parameters field.
:param name: The name of the field.
:type name: string
:param label: The label to be presented to the user for this field.
:type label: string
:param field_type: The type of field to create. Can be one of
(string, choice, mac_address). Defaults to string.
:type field_type: string.
:param choices: The collection of choices to present to the user.
Needs to be structured as a list of lists, otherwise
make_json_field() will raise a ValidationError.
:type list:
:param default: The default value for the field.
:type default: string
:param required: Whether or not a value for the field is required.
:type required: boolean
"""
if field_type not in ('string', 'mac_address', 'choice'):
field_type = 'string'
if choices is None:
choices = []
validate(choices, CHOICE_FIELD_SCHEMA)
if default is None:
default = ""
field = {
'name': name,
'label': label,
'required': required,
'field_type': field_type,
'choices': choices,
'default': default,
}
return field
JSON_POWER_TYPE_PARAMETERS = [
{
'name': 'ether_wake',
'description': 'Wake-on-LAN',
'fields': [
make_json_field(
'mac_address', "MAC Address", field_type='mac_address'),
],
},
{
'name': 'virsh',
'description': 'virsh (virtual systems)',
'fields': [
make_json_field('power_address', "Power address"),
make_json_field('power_id', "Power ID"),
make_json_field(
'power_pass', "Power password (optional)",
required=False),
],
},
{
'name': 'fence_cdu',
'description': 'Sentry Switch CDU',
'fields': [
make_json_field('power_address', "Power address"),
make_json_field('power_id', "Power ID"),
make_json_field('power_user', "Power user"),
make_json_field('power_pass', "Power password"),
],
},
{
'name': 'ipmi',
'description': 'IPMI',
'fields': [
make_json_field(
'power_driver', "Power driver", field_type='choice',
choices=IPMI_DRIVER_CHOICES, default=IPMI_DRIVER.LAN_2_0),
make_json_field('power_address', "IP address"),
make_json_field('power_user', "Power user"),
make_json_field('power_pass', "Power password"),
make_json_field(
'mac_address',
"MAC address - the IP is looked up with ARP and is used if "
"IP address is empty. This is better when the BMC uses DHCP."),
],
},
{
'name': 'moonshot',
'description': 'iLO4 Moonshot Chassis',
'fields': [
make_json_field('power_address', "Power address"),
make_json_field('power_user', "Power user"),
make_json_field('power_pass', "Power password"),
make_json_field('power_hwaddress', "Power hardware address"),
],
},
{
'name': 'sm15k',
'description': 'SeaMicro 15000',
'fields': [
make_json_field('system_id', "System ID"),
make_json_field('power_address', "Power address"),
make_json_field('power_user', "Power user"),
make_json_field('power_pass', "Power password"),
make_json_field(
'power_control', "Power control type", field_type='choice',
choices=SM15K_POWER_CONTROL_CHOICES, default='ipmi'),
],
},
{
'name': 'amt',
'description': 'Intel AMT',
'fields': [
make_json_field(
'mac_address', "MAC Address", field_type='mac_address'),
make_json_field('power_pass', "Power password"),
make_json_field(
'power_address',
"An IP address to use instead of the node's primary NIC's IP "
"(i.e. the IP of the MAC above, looked up with ARP)."),
],
},
{
'name': 'dli',
'description': 'Digital Loggers, Inc. PDU',
'fields': [
make_json_field('system_id', "Outlet ID"),
make_json_field('power_address', "Power address"),
make_json_field('power_user', "Power user"),
make_json_field('power_pass', "Power password"),
],
},
{
'name': 'ucsm',
'description': "Cisco UCS Manager",
'fields': [
make_json_field('uuid', "Server UUID"),
make_json_field('power_address', "URL for XML API"),
make_json_field('power_user', "API user"),
make_json_field('power_pass', "API password"),
],
},
{
'name': 'mscm',
'description': "Moonshot HP iLO Chassis Manager",
'fields': [
make_json_field('power_address', "IP for MSCM CLI API"),
make_json_field('power_user', "MSCM CLI API user"),
make_json_field('power_pass', "MSCM CLI API password"),
make_json_field(
'node_id',
"Node ID - Must adhere to cXnY format "
"(X=cartridge number, Y=node number)."),
],
},
]
|