e789619b34
This patch brings some of the physical and virtual drive attributes as
`custom_fields` to the disks inventory.
The goal is to have this information present to ease disks maintenance
when a drive becomes unavailable and its attributes can't be read anymore
from the RAID controller.
It also helps to standardize the extended disk attributes across the
different manufacturers.
As the disk physical identifers were not available under the correct
format (hexadecimal format using the `xml` output as opposed as `X:Y:Z` format
using the default `list` format), the command line parser has been
refactored to read the `list` format, rather than `xml` one in the
`omreport` raid controller parser.
As the custom fields have to be created prior being able to register
the disks extended attributes, this feature is only activated using the
`--process-virtual-drives` command line parameter, or by setting
`process_virtual_drives` to `true` in the configuration file.
The custom fields to create as `DCIM > inventory item` `Text` are described
below.
NAME LABEL DESCRIPTION
mount_point Mount point Device mount point(s)
pd_identifier Physical disk identifier Physical disk identifier in the RAID controller
vd_array Virtual drive array Virtual drive array the disk is member of
vd_consistency Virtual drive consistency Virtual disk array consistency
vd_device Virtual drive device Virtual drive system device
vd_raid_type Virtual drive RAID Virtual drive array RAID type
vd_size Virtual drive size Virtual drive array size
In the current implementation, the disks attributes ore not updated: if
a disk with the correct serial number is found, it's sufficient to
consider it as up to date.
To force the reprocessing of the disks extended attributes, the
`--force-disk-refresh` command line option can be used: it removes all
existing disks to before populating them with the correct parsing.
Unless this option is specified, the extended attributes won't be
modified unless a disk is replaced.
It is possible to dump the physical/virtual disks map on the filesystem under
the JSON notation to ease or automate disks management. The file path has to
be provided using the `--dump-disks-map` command line parameter.
123 lines
4 KiB
Python
123 lines
4 KiB
Python
from netbox_agent.raid.base import Raid, RaidController
|
|
from netbox_agent.misc import get_vendor, get_mount_points
|
|
from netbox_agent.config import config
|
|
import subprocess
|
|
import logging
|
|
import re
|
|
|
|
|
|
def omreport(sub_command):
|
|
command = 'omreport {}'.format(sub_command)
|
|
output = subprocess.getoutput(command)
|
|
res = {}
|
|
section_re = re.compile('^[A-Z]')
|
|
current_section = None
|
|
current_obj = None
|
|
|
|
for line in output.split('\n'):
|
|
if ': ' in line:
|
|
attr, value = line.split(': ', 1)
|
|
attr = attr.strip()
|
|
value = value.strip()
|
|
if attr == 'ID':
|
|
obj = {}
|
|
res.setdefault(current_section, []).append(obj)
|
|
current_obj = obj
|
|
current_obj[attr] = value
|
|
elif section_re.search(line) is not None:
|
|
current_section = line.strip()
|
|
return res
|
|
|
|
|
|
class OmreportController(RaidController):
|
|
def __init__(self, controller_index, data):
|
|
self.data = data
|
|
self.controller_index = controller_index
|
|
|
|
def get_product_name(self):
|
|
return self.data['Name']
|
|
|
|
def get_manufacturer(self):
|
|
return None
|
|
|
|
def get_serial_number(self):
|
|
return self.data.get('DeviceSerialNumber')
|
|
|
|
def get_firmware_version(self):
|
|
return self.data.get('Firmware Version')
|
|
|
|
def _get_physical_disks(self):
|
|
pds = {}
|
|
res = omreport('storage pdisk controller={}'.format(
|
|
self.controller_index
|
|
))
|
|
for pdisk in [d for d in list(res.values())[0]]:
|
|
disk_id = pdisk['ID']
|
|
size = re.sub('B .*$', 'B', pdisk['Capacity'])
|
|
pds[disk_id] = {
|
|
'Vendor': get_vendor(pdisk['Vendor ID']),
|
|
'Model': pdisk['Product ID'],
|
|
'SN': pdisk['Serial No.'],
|
|
'Size': size,
|
|
'Type': pdisk['Media'],
|
|
'_src': self.__class__.__name__,
|
|
}
|
|
return pds
|
|
|
|
def _get_virtual_drives_map(self):
|
|
pds = {}
|
|
res = omreport('storage vdisk controller={}'.format(
|
|
self.controller_index
|
|
))
|
|
for vdisk in [d for d in list(res.values())[0]]:
|
|
vdisk_id = vdisk['ID']
|
|
device = vdisk['Device Name']
|
|
mount_points = get_mount_points()
|
|
mp = mount_points.get(device, 'n/a')
|
|
size = re.sub('B .*$', 'B', vdisk['Size'])
|
|
vd = {
|
|
'vd_array': vdisk_id,
|
|
'vd_size': size,
|
|
'vd_consistency': vdisk['State'],
|
|
'vd_raid_type': vdisk['Layout'],
|
|
'vd_device': vdisk['Device Name'],
|
|
'mount_point': ', '.join(sorted(mp)),
|
|
}
|
|
drives_res = omreport(
|
|
'storage pdisk controller={} vdisk={}'.format(
|
|
self.controller_index, vdisk_id
|
|
))
|
|
for pdisk in [d for d in list(drives_res.values())[0]]:
|
|
pds[pdisk['ID']] = vd
|
|
return pds
|
|
|
|
def get_physical_disks(self):
|
|
pds = self._get_physical_disks()
|
|
vds = self._get_virtual_drives_map()
|
|
for pd_identifier, vd in vds.items():
|
|
if pd_identifier not in pds:
|
|
logging.error(
|
|
'Physical drive {} listed in virtual drive {} not '
|
|
'found in drives list'.format(
|
|
pd_identifier, vd['vd_array']
|
|
)
|
|
)
|
|
continue
|
|
pds[pd_identifier].setdefault('custom_fields', {}).update(vd)
|
|
pds[pd_identifier]['custom_fields']['pd_identifier'] = pd_identifier
|
|
return list(pds.values())
|
|
|
|
|
|
class OmreportRaid(Raid):
|
|
def __init__(self):
|
|
self.controllers = []
|
|
res = omreport('storage controller')
|
|
|
|
for controller in res['Controller']:
|
|
ctrl_index = controller['ID']
|
|
self.controllers.append(
|
|
OmreportController(ctrl_index, controller)
|
|
)
|
|
|
|
def get_controllers(self):
|
|
return self.controllers
|