summaryrefslogtreecommitdiffstats
path: root/commands/storage/lmi/scripts/storage/partitiontable_cmd.py
blob: 33ea3f82dd7c10bd91d5696d2cb301339fe41448 (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
158
159
160
161
162
163
164
165
166
167
168
169
# 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>
#

"""
Partition table management.

Usage:
    %(cmd)s list [ <device> ...]
    %(cmd)s create [ --gpt | --msdos ] <device> ...
    %(cmd)s show  [ <device> ...]

Commands:
    list        List partition tables on given device.
                If no devices are provided, all partition tables are listed.

    create      Create a partition table on given devices. The devices must be
                empty, i.e. must not have any partitions on them. GPT partition
                table is created by default.

    show        Show detailed information about partition table on given
                devices. If no devices are provided, all of them are displayed.

Options:
    device      Identifier of the device. Either one of:

                * DeviceID of appropriate CIM_StorageExtent object. This is
                  internal OpenLMI ID of the device and it should be stable
                  across system reboots.

                * Device name directly in /dev directory, such as '/dev/sda'.
                  This device name is available as Name property of
                  CIM_StorageExtent object.

                * Name of MD RAID or logical volume. This method cannot be used
                  when the name is not unique, for example when there are two
                  logical volumes with the same name, allocated from different
                  volume groups. This name is available as ElementName
                  property of CIM_StorageExtent object.

    --gpt       Create GPT partition table (default).
    --msdos     Create MS-DOS partition table.
"""

from lmi.scripts.common import command
from lmi.scripts.storage import partition, show
from lmi.scripts.storage.common import size2str, str2device
from lmi.scripts.common import formatter
from lmi.scripts.common.formatter import command as fcmd
from lmi.scripts.common import get_logger
LOG = get_logger(__name__)

class Lister(command.LmiLister):
    COLUMNS = ('DeviceID', 'Name', 'ElementName', 'Type', 'Largest free region')

    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):
        """
        Implementation of 'partition-table list' command.
        """
        cls = ns.LMI_DiskPartitionConfigurationCapabilities
        for (device, table) in partition.get_partition_tables(ns, devices):
            LOG().debug("Examining %s", device.Name)
            largest_size = partition.get_largest_partition_size(ns, device)
            largest_size = size2str(largest_size,
                    self.app.config.human_friendly)

            if table.PartitionStyle == cls.PartitionStyleValues.MBR:
                table_type = "MS-DOS"
            else:
                table_type = cls.PartitionStyleValues.value_name(
                        table.PartitionStyle)

            yield (device.DeviceID,
                    device.Name,
                    device.ElementName,
                    table_type,
                    largest_size
                    )


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, _gpt, _msdos):
        """
        Implementation of 'partition-table create' command.
        """
        if _msdos:
            ptype = partition.PARTITION_TABLE_TYPE_MSDOS
        else:
            ptype = partition.PARTITION_TABLE_TYPE_GPT
        for device in devices:
            partition.create_partition_table(ns, device, ptype)


class Show(command.LmiLister):
    COLUMNS = ('Name', 'Value')

    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):
        """
        Implementation of 'partition-table show' command.
        """
        if not devices:
            ret = partition.get_partition_tables(ns)
            devices = [i[0] for i in ret]
        for device in devices:
            device = str2device(ns, device)
            cmd = fcmd.NewTableCommand(title=device.DeviceID)
            yield cmd
            for line in show.partition_table_show(
                    ns, device, self.app.config.human_friendly):
                yield line

PartitionTable = command.register_subcommands(
        'PartitionTable', __doc__,
        { 'list'    : Lister ,
          'create'  : Create,
          'show'    : Show,
        },
    )