def _create_fs(self, job, device_strings, fmt, label, goal):
"""
Create a filesystem on given devices. This method is called
from JobManager worker thread!
"""
devices = []
# convert strings back to devices
for devname in device_strings:
device = self.storage.devicetree.getDeviceByPath(devname)
if not device:
raise pywbem.CIMError(pywbem.CIM_ERR_FAILED, "One of the devices disappeared: " + devname)
devices.append(device)
# Check the devices are unused
storage.assert_unused(self.storage, devices)
if fmt.type == "btrfs":
# BTRFS is different beast, we must create BTRFSVolumeDevice
for device in devices:
device.format = blivet.formats.getFormat("btrfs")
volume = self.storage.newBTRFS(fmt_args={"label": label}, parents=devices)
action = blivet.ActionCreateDevice(volume)
else:
# create simple CreateFormat action
action = blivet.ActionCreateFormat(devices[0], format=fmt)
openlmi.storage.util.storage.do_storage_action(self.storage, [action])
# We must locate the format manually, the storage was reset
# TODO: remove when reset() is not necessary
device = self.storage.devicetree.getDeviceByPath(devices[0].path)
if device:
fmt = device.format
else:
raise pywbem.CIMError(pywbem.CIM_ERR_FAILED, "Cannot locate new format, was it removed?")
fmtprovider = self.provider_manager.get_provider_for_format(device, fmt)
format_name = fmtprovider.get_name_for_format(device, fmt)
outparams = {"theelement": format_name}
ret = self.Values.LMI_CreateFileSystem.Job_Completed_with_No_Error
job.finish_method(
Job.STATE_FINISHED_OK,
return_value=ret,
return_type=Job.ReturnValueType.Uint32,
output_arguments=outparams,
affected_elements=[format_name],
error=None,
)
def cim_method_lmi_deletepartition(self, env, object_name,
param_partition=None):
"""
Implements LMI_DiskPartitionConfigurationService.LMI_DeletePartition()
Delete partition.
"""
self.check_instance(object_name)
# remember input parameters for Job
input_arguments = {
'Partition' : pywbem.CIMProperty(name='Partition',
type='reference',
value=param_partition),
}
# check parameters
if not param_partition:
raise pywbem.CIMError(pywbem.CIM_ERR_INVALID_PARAMETER,
"Parameter Partition must be specified.")
device = self._parse_partition(param_partition)
# Check the device is unused
storage.assert_unused(self.storage, [device])
# prepare job
job = Job(
job_manager=self.job_manager,
job_name="DELETE PARTITION %s" % (device.path,),
input_arguments=input_arguments,
method_name='LMI_DeletePartition',
affected_elements=[param_partition],
owning_element=self._get_instance_name())
job.set_execute_action(self._delete_partition,
job, param_partition)
outparams = [ pywbem.CIMParameter(
name='job',
type='reference',
value=job.get_name())]
ret = self.Values.LMI_DeletePartition\
.Method_Parameters_Checked___Job_Started
# enqueue the job
self.job_manager.add_job(job)
return (ret, outparams)
def _delete_fs(self, job, param_thefilesystem):
"""
Delete a filesystem This method is called from JobManager worker
thread.
"""
provider = self.provider_manager.get_provider_for_format_name(param_thefilesystem)
if not provider:
raise pywbem.CIMError(pywbem.CIM_ERR_NOT_FOUND, "Unknown TheFileSystem class.")
(device, fmt) = provider.get_format_for_name(param_thefilesystem)
if not fmt:
raise pywbem.CIMError(
pywbem.CIM_ERR_NOT_FOUND,
"Unknown TheFileSystem instance, the filesystem is " " probably already deleted.",
)
# Check the device is unused
storage.assert_unused(self.storage, [device])
actions = []
if isinstance(device, blivet.devices.BTRFSVolumeDevice):
# delete the volume device first
actions.append(blivet.ActionDestroyDevice(device))
for parent in device.parents:
# and destroy all formats
actions.append(blivet.ActionDestroyFormat(parent))
else:
actions.append(blivet.ActionDestroyFormat(device))
openlmi.storage.util.storage.do_storage_action(self.storage, actions)
ret = self.Values.DeleteFileSystem.Job_Completed_with_No_Error
job.finish_method(
Job.STATE_FINISHED_OK,
return_value=ret,
return_type=Job.ReturnValueType.Uint32,
output_arguments=[],
affected_elements=[],
error=None,
)
def _delete_partition(self, job, devicename):
"""
Delete given partition.
This method is called from JobManager worker thread!
"""
device = self.provider_manager.get_device_for_name(devicename)
if not device:
raise pywbem.CIMError(pywbem.CIM_ERR_FAILED,
"The devices disappeared: " + devicename)
# Check the device is unused
storage.assert_unused(self.storage, [device])
action = blivet.ActionDestroyDevice(device)
storage.do_storage_action(self.storage, [action])
ret = self.Values.LMI_DeletePartition.Job_Completed_with_No_Error
job.finish_method(
Job.STATE_FINISHED_OK,
return_value=ret,
return_type=Job.ReturnValueType.Uint32,
output_arguments=[],
affected_elements=[],
error=None)
def cim_method_setpartitionstyle(self, env, object_name,
param_extent=None,
param_partitionstyle=None):
"""
Implements LMI_DiskPartitionConfigurationService.SetPartitionStyle()
This method installs a partition table on an extent of the
specified partition style; creating an association between the
extent and that capabilities instances referenced as method
parameters. As a side effect, the consumable block size of the
underlying extent is reduced by the block size of the metadata
reserved by the partition table and associated metadata. This size
is in the PartitionTableSize property of the associated
DiskPartitionConfigurationCapabilities instance.
"""
# check parameters here, the real work is done in _setpartitionstyle
self.check_instance(object_name)
if not param_extent:
raise pywbem.CIMError(pywbem.CIM_ERR_INVALID_PARAMETER,
"Parameter Extent is mandatory.")
# check the device
device = self.provider_manager.get_device_for_name(param_extent)
if not device:
raise pywbem.CIMError(pywbem.CIM_ERR_FAILED,
"Cannot find the Extent.")
if isinstance(device, blivet.devices.PartitionDevice):
raise pywbem.CIMError(pywbem.CIM_ERR_NOT_SUPPORTED,
"Creation of extended partitions is not supported.")
# Check the device is unused
storage.assert_unused(self.storage, [device])
# check the capabilities
mgr = self.provider_manager
capabilities_provider = mgr.get_capabilities_provider_for_class(
'LMI_DiskPartitionConfigurationCapabilities')
if not capabilities_provider:
raise pywbem.CIMError(pywbem.CIM_ERR_FAILED,
"Cannot find capabilities provider.")
if param_partitionstyle:
capabilities = capabilities_provider.get_capabilities_for_id(
param_partitionstyle['InstanceID'])
if not capabilities:
raise pywbem.CIMError(pywbem.CIM_ERR_INVALID_PARAMETER,
"Cannot find capabilities for given PartitionStyle.")
else:
# find the default capabilities
capabilities = capabilities_provider.get_default_capabilities()
if not capabilities:
raise pywbem.CIMError(pywbem.CIM_ERR_INVALID_PARAMETER,
"Parameter PartitionStyle is mandatory, there is no"\
" default PartitionStyle.")
part_styles = capabilities_provider.Values.PartitionStyle
if capabilities['PartitionStyle'] == part_styles.EMBR:
raise pywbem.CIMError(pywbem.CIM_ERR_NOT_SUPPORTED,
"Creation of extended partitions is not supported.")
retval = self._setpartitionstyle(
device, capabilities, capabilities_provider)
return (retval, [])
def cim_method_lmi_createfilesystem(
self, env, object_name, param_elementname=None, param_goal=None, param_filesystemtype=None, param_inextents=None
):
"""Implements LMI_FileSystemConfigurationService.LMI_CreateFileSystem()
Start a job to create a FileSystem on StorageExtents. If the
operation completes successfully and did not require a
long-running ConcreteJob, it will return 0. If 4096/0x1000 is
returned, a ConcreteJob will be started to create the element. A
Reference to the ConcreteJob will be returned in the output
parameter Job. If any other value is returned, the job will not be
started, and no action will be taken. \nThe parameter TheElement
will contain a Reference to the FileSystem if this operation
completed successfully. \nThe StorageExtents to use is specified
by the InExtents parameter.\nThe desired settings for the
FileSystem are specified by the Goal parameter. Goal is an element
of class CIM_FileSystemSetting, or a derived class. Unlike CIM
standard CreateFileSystem, the parameter is reference to
CIM_FileSystemSetting stored on the CIMOM.\nA ResidesOnExtent
association is created between the created FileSystem and the
StorageExtents used for it.
Keyword arguments:
env -- Provider Environment (pycimmb.ProviderEnvironment)
object_name -- A pywbem.CIMInstanceName or pywbem.CIMCLassName
specifying the object on which the method LMI_CreateFileSystem()
should be invoked.
param_elementname -- The input parameter ElementName (type unicode)
Label of the filesystem being created. If NULL, a
system-supplied default name can be used. The value will be
stored in the \'ElementName\' property for the created
element.
param_goal -- The input parameter Goal (type REF (pywbem.CIMInstanceName(classname='CIM_FileSystemSetting', ...))
The requirements for the FileSystem element to maintain. This
is an element of class CIM_FileSystemSetting, or a derived
class. This allows the client to specify the properties
desired for the file system. If NULL, the
FileSystemConfigurationService will create default filesystem.
param_filesystemtype -- The input parameter FileSystemType (type pywbem.Uint16 self.Values.LMI_CreateFileSystem.FileSystemType)
Type of file system to create. When NULL, file system type is
retrieved from Goal parameter, which cannot be NULL.
param_inextents -- The input parameter InExtents (type REF (pywbem.CIMInstanceName(classname='CIM_StorageExtent', ...))
The StorageExtents on which the created FileSystem will reside.
At least one extent must be provided. If the filesystem being
created supports more than one storage extent (e.g. btrfs),
more extents can be provided. The filesystem will then reside
on all of them.
Returns a two-tuple containing the return value (type pywbem.Uint32 self.Values.LMI_CreateFileSystem)
and a list of CIMParameter objects representing the output parameters
Output parameters:
Job -- (type REF (pywbem.CIMInstanceName(classname='CIM_ConcreteJob', ...))
Reference to the job (may be null if job completed).
TheElement -- (type REF (pywbem.CIMInstanceName(classname='CIM_FileSystem', ...))
The newly created FileSystem.
Possible Errors:
CIM_ERR_ACCESS_DENIED
CIM_ERR_INVALID_PARAMETER (including missing, duplicate,
unrecognized or otherwise incorrect parameters)
CIM_ERR_NOT_FOUND (the target CIM Class or instance does not
exist in the specified namespace)
CIM_ERR_METHOD_NOT_AVAILABLE (the CIM Server is unable to honor
the invocation request)
CIM_ERR_FAILED (some other unspecified error occurred)
"""
self.check_instance(object_name)
# remember input parameters for Job
input_arguments = {
"ElementName": pywbem.CIMProperty(name="ElementName", type="string", value=param_elementname),
"Goal": pywbem.CIMProperty(name="goal", type="reference", value=param_goal),
"FileSystemType": pywbem.CIMProperty(name="FileSystemType", type="uint16", value=param_filesystemtype),
"InExtents": pywbem.CIMProperty(
name="FileSystemType", type="reference", is_array=True, value=param_inextents
),
}
if not param_inextents:
raise pywbem.CIMError(pywbem.CIM_ERR_INVALID_PARAMETER, "Parameter InExtents must be specified.")
devices = []
for extent in param_inextents:
device = self.provider_manager.get_device_for_name(extent)
if not device:
raise pywbem.CIMError(
pywbem.CIM_ERR_INVALID_PARAMETER, "Cannot find block device for InExtent" + extent["DeviceID"]
)
devices.append(device)
if len(devices) > 1:
if param_filesystemtype != self.Values.LMI_CreateFileSystem.FileSystemType.BTRFS:
raise pywbem.CIMError(pywbem.CIM_ERR_INVALID_PARAMETER, "Selected filesystem supports only one device.")
if len(devices) < 1:
raise pywbem.CIMError(pywbem.CIM_ERR_INVALID_PARAMETER, "At least one InExtent must be specified")
# Check the devices are unused
storage.assert_unused(self.storage, devices)
# Convert devices to strings, so we can survive if some of them
# disappears or is changed while the job is queued.
device_strings = [device.path for device in devices]
goal = self._parse_goal(param_goal, "LMI_FileSystemSetting")
# TODO: check that goal has supported values
if not goal and not param_filesystemtype:
raise pywbem.CIMError(
pywbem.CIM_ERR_INVALID_PARAMETER, "Either Goal or FileSystemType parameter must be specified"
)
if not param_filesystemtype:
# retrieve fs type from the goal
param_filesystemtype = int(goal["ActualFileSystemType"])
# convert fstype to Blivet FS
types = self.Values.LMI_CreateFileSystem.FileSystemType
fstypes = {
types.FAT: "vfat",
types.FAT16: "vfat",
types.FAT32: "vfat",
types.XFS: "xfs",
types.EXT2: "ext2",
types.EXT3: "ext3",
types.EXT4: "ext4",
types.BTRFS: "btrfs",
types.VFAT: "vfat",
}
fsname = fstypes.get(param_filesystemtype, "None")
if not fsname:
raise pywbem.CIMError(pywbem.CIM_ERR_NOT_SUPPORTED, "Creation of requested filesystem is not supported.")
# create the format
fmt = blivet.formats.getFormat(fsname)
if not fmt:
raise pywbem.CIMError(pywbem.CIM_ERR_NOT_SUPPORTED, "Creation of requested filesystem is not supported.")
# prepare job
job = Job(
job_manager=self.job_manager,
job_name="CREATE FS " + fsname + " ON " + device.path,
input_arguments=input_arguments,
method_name="LMI_CreateFileSystem",
affected_elements=param_inextents,
owning_element=self._get_instance_name(),
)
job.set_execute_action(self._create_fs, job, device_strings, fmt, param_elementname, goal)
# prepare output arguments
outparams = [pywbem.CIMParameter(name="job", type="reference", value=job.get_name())]
retvals = self.Values.LMI_CreateFileSystem
# enqueue the job
self.job_manager.add_job(job)
return (retvals.Method_Parameters_Checked___Job_Started, outparams)
def cim_method_deletefilesystem(
self, env, object_name, param_waittime=None, param_thefilesystem=None, param_inuseoptions=None
):
"""Implements LMI_FileSystemConfigurationService.DeleteFileSystem()
Start a job to delete a FileSystem. If the FileSystem cannot be
deleted, no action will be taken, and the Return Value will be
4097/0x1001. If the method completed successfully and did not
require a long-running ConcreteJob, it will return 0. If
4096/0x1000 is returned, a ConcreteJob will be started to delete
the FileSystem. A Reference to the ConcreteJob will be returned in
the output parameter Job.
Keyword arguments:
env -- Provider Environment (pycimmb.ProviderEnvironment)
object_name -- A pywbem.CIMInstanceName or pywbem.CIMCLassName
specifying the object on which the method DeleteFileSystem()
should be invoked.
param_waittime -- The input parameter WaitTime (type pywbem.Uint32)
An integer that indicates the time (in seconds) that the
provider must wait before deleting this FileSystem. If
WaitTime is not zero, the method will create a job, if
supported by the provider, and return immediately. If the
provider does not support asynchronous jobs, there is a
possibility that the client could time-out before the job is
completed. The combination of InUseOptions = '4' and WaitTime
='0' (the default) is interpreted as 'Wait (forever) until
Quiescence, then Delete Filesystem' and will be performed
asynchronously if possible.
param_thefilesystem -- The input parameter TheFileSystem (type REF (pywbem.CIMInstanceName(classname='CIM_ManagedElement', ...))
An element or association that uniquely identifies the
FileSystem to be deleted.
param_inuseoptions -- The input parameter InUseOptions (type pywbem.Uint16 self.Values.DeleteFileSystem.InUseOptions)
An enumerated integer that specifies the action to take if the
FileSystem is still in use when this request is made.
Returns a two-tuple containing the return value (type pywbem.Uint32 self.Values.DeleteFileSystem)
and a list of CIMParameter objects representing the output parameters
Output parameters:
Job -- (type REF (pywbem.CIMInstanceName(classname='CIM_ConcreteJob', ...))
Reference to the job (may be null if job completed).
Possible Errors:
CIM_ERR_ACCESS_DENIED
CIM_ERR_INVALID_PARAMETER (including missing, duplicate,
unrecognized or otherwise incorrect parameters)
CIM_ERR_NOT_FOUND (the target CIM Class or instance does not
exist in the specified namespace)
CIM_ERR_METHOD_NOT_AVAILABLE (the CIM Server is unable to honor
the invocation request)
CIM_ERR_FAILED (some other unspecified error occurred)
"""
self.check_instance(object_name)
# remember input parameters for Job
input_arguments = {
"WaitTime": pywbem.CIMProperty(name="WaitTime", type="uint32", value=param_waittime),
"TheFileSystem": pywbem.CIMProperty(name="TheFileSystem", type="reference", value=param_thefilesystem),
"InUseOptions": pywbem.CIMProperty(name="InUseOptions", type="uint16", value=param_inuseoptions),
}
if param_waittime is not None:
raise pywbem.CIMError(pywbem.CIM_ERR_NOT_SUPPORTED, "Parameter WaitTime is not supported.")
if param_inuseoptions is not None:
raise pywbem.CIMError(pywbem.CIM_ERR_NOT_SUPPORTED, "Parameter InUseOptions is not supported.")
if param_thefilesystem is None:
raise pywbem.CIMError(pywbem.CIM_ERR_FAILED, "Parameter TheFileSystem must be specified.")
provider = self.provider_manager.get_provider_for_format_name(param_thefilesystem)
if not provider:
raise pywbem.CIMError(pywbem.CIM_ERR_NOT_FOUND, "Unknown TheFileSystem class.")
(device, fmt) = provider.get_format_for_name(param_thefilesystem)
if not fmt:
raise pywbem.CIMError(pywbem.CIM_ERR_NOT_FOUND, "Unknown TheFileSystem instance.")
# Check the device is unused
storage.assert_unused(self.storage, [device])
# prepare job
job = Job(
job_manager=self.job_manager,
job_name="DELETE FS " + fmt.type + " ON " + fmt.device,
input_arguments=input_arguments,
method_name="DeleteFileSystem",
affected_elements=param_thefilesystem,
owning_element=self._get_instance_name(),
)
job.set_execute_action(self._delete_fs, job, param_thefilesystem)
# prepare output arguments
outparams = [pywbem.CIMParameter(name="job", type="reference", value=job.get_name())]
retvals = self.Values.LMI_CreateFileSystem
# enqueue the job
self.job_manager.add_job(job)
return (retvals.Method_Parameters_Checked___Job_Started, outparams)
