summaryrefslogtreecommitdiffstats
path: root/commands/storage/lmi/scripts/storage/fs_cmd.py
blob: 7623bd514b60158b7c064bc40ab0680409a26a78 (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
# Storage Management Providers
#
# Copyright (C) 2013-2014 Red Hat, 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:
#
# 1. Redistributions of source code must retain the above copyright notice,
#    this list of conditions and the following disclaimer.
# 2. 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.
#
# 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 OWNER 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.
#
# The views and conclusions contained in the software and documentation are
# those of the authors and should not be interpreted as representing official
# policies, either expressed or implied, of the FreeBSD Project.
#
# Authors: Jan Safranek <jsafrane@redhat.com>
#

"""
Filesystem and other data format management.

Usage:
    %(cmd)s list [--all] [ <device> ...]
    %(cmd)s create [ --label=<label> ] <fstype>  <device> ...
    %(cmd)s delete <device> ...
    %(cmd)s list-supported

Commands:
    list        List filesystems and and other data formats (RAID metadata, ...)
                on given devices.
                If no devices are provided, all filesystems are listed.
                If --all option is set, all filesystem, including system ones
                like tmpfs, cgroups, procfs, sysfs etc are listed.

    create      Format device(s) with given filesystem.
                If more devices are given, the filesystem will span
                over these devices (currently supported only by btrfs).

                For list of available filesystem types, see output of
                %(cmd)s list-supported.

    delete      Delete given filesystem or data format (like partition table,
                RAID metadata, LUKS, physical volume metadata etc)
                on given devices.

    list-supported
                List supported filesystems, which can be used as
                %(cmd)s create <fstype> option.
"""

from lmi.scripts.common import command
from lmi.scripts.storage import fs

class Lister(command.LmiLister):
    COLUMNS = ('Device', 'Name', "ElementName", "Type")

    def transform_options(self, options):
        """
        Rename 'device' option to 'devices' parameter name for better
        readability.
        """
        options['<devices>'] = options.pop('<device>')

    def execute(self, ns, devices=None, _all=False):
        """
        Implementation of 'fs list' command.
        """
        for fmt in fs.get_formats(ns, devices, fs.FORMAT_ALL, _all):
            device = fmt.first_associator(AssocClass="CIM_ResidesOnExtent")
            if device:
                devname = device.DeviceID
            else:
                devname = "(none)"
            name = fmt.Name
            label = fmt.ElementName
            if "FileSystemType" in fmt.properties():
                # it's CIM_LocalFileSystem
                # TODO: add filesystem size and free space
                fstype = fmt.FileSystemType
            else:
                # it must be LMI_DataFormat
                fstype = fmt.FormatTypeDescription
            # TODO: add free space when OpenLMI provides it
            yield (devname, name, label, fstype)


class ListSupported(command.LmiLister):
    COLUMNS = ('Filesystem',)

    def execute(self, ns):
        """
        Implementation of 'fs list-supported' command.
        """
        caps = ns.LMI_FileSystemConfigurationCapabilities.first_instance()
        cls = ns.LMI_FileSystemConfigurationCapabilities
        for fstype in caps.SupportedActualFileSystemTypes:
            fsname = cls.SupportedActualFileSystemTypesValues.value_name(fstype)
            yield [fsname.lower()]


class Create(command.LmiCheckResult):
    EXPECT = None

    def transform_options(self, options):
        """
        Rename 'device' option to 'devices' parameter name for better
        readability.
        """
        options['<devices>'] = options.pop('<device>')

    def execute(self, ns, devices, fstype, _label=None):
        """
        Implementation of 'fs create' command.
        """
        fs.create_fs(ns, devices, fstype, _label)


class Delete(command.LmiCheckResult):
    EXPECT = None

    def transform_options(self, options):
        """
        Rename 'device' option to 'devices' parameter name for better
        readability.
        """
        options['<devices>'] = options.pop('<device>')

    def execute(self, ns, devices):
        """
        Implementation of 'fs delete' command.
        """
        for dev in devices:
            fs.delete_format(ns, dev)


Fs = command.register_subcommands(
        'fs', __doc__,
        { 'list'    : Lister ,
          'create'  : Create,
          'delete'  : Delete,
          'list-supported': ListSupported,
        },
    )