lvm

Provides Puppet types and providers to manage Logical Volume Manager (LVM) features.

Project URL RSS Feed Report issues

Module Stats

3,428,213 downloads

152 latest version

5.0 quality score

Version information

released Dec 16th 2024

Passed malware scan

This version is compatible with:

Puppet Enterprise 2023.8.x, 2023.7.x, 2023.6.x, 2023.5.x, 2023.4.x, 2023.3.x, 2023.2.x, 2023.1.x, 2023.0.x, 2021.7.x, 2021.6.x, 2021.5.x, 2021.4.x, 2021.3.x, 2021.2.x, 2021.1.x, 2021.0.x
Puppet >= 7.0.0 < 9.0.0
, , , ,

Tasks:

ensure_fs

ensure_lv

ensure_pv

ensure_vg

extend_lv

extend_vg

mount_lv

Plans:

expand

Start using this module

Installation method

Add this module to your Puppetfile:

mod 'puppetlabs-lvm', '3.0.0'

Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add puppetlabs-lvm

Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install puppetlabs-lvm --version 3.0.0

Tags: storage, hdd, filesystem, volume, lvm, logical-volume, volume-group, physical-volume

Documentation

puppetlabs/lvm — version 3.0.0 Dec 16th 2024

Puppet LVM Module

Provides Logical Volume Manager (LVM) types and providers for Puppet.

Usage Examples

This module provides four resource types (and associated providers): volume_group, logical_volume, physical_volume, and filesystem.

The basic dependency graph needed to define a working logical volume looks something like:

filesystem -> logical_volume -> volume_group -> physical_volume(s)

Here's a simple working example:

physical_volume { '/dev/hdc':
  ensure => present,
}

volume_group { 'myvg':
  ensure           => present,
  physical_volumes => '/dev/hdc',
}

logical_volume { 'mylv':
  ensure       => present,
  volume_group => 'myvg',
  size         => '20G',
}

filesystem { '/dev/myvg/mylv':
  ensure  => present,
  fs_type => 'ext3',
  options => '-b 4096 -E stride=32,stripe-width=64',
}

This simple 1 physical volume, 1 volume group, 1 logical volume case is provided as a simple volume definition, as well. The above could be shortened to be:

lvm::volume { 'mylv':
  ensure => present,
  vg     => 'myvg',
  pv     => '/dev/hdc',
  fstype => 'ext3',
  size   => '20G',
}

You can also describe your Volume Group like this:

class { 'lvm':
  volume_groups    => {
    'myvg' => {
      physical_volumes => [ '/dev/sda2', '/dev/sda3', ],
      logical_volumes  => {
        'opt'    => {'size' => '20G'},
        'tmp'    => {'size' => '1G' },
        'usr'    => {'size' => '3G' },
        'var'    => {'size' => '15G'},
        'home'   => {'size' => '5G' },
        'backup' => {
          'size'              => '5G',
          'mountpath'         => '/var/backups',
          'mountpath_require' => true,
        },
      },
    },
  },
}

This could be really convenient when used with hiera:

include lvm

and

---
lvm::volume_groups:
  myvg:
    physical_volumes:
      - /dev/sda2
      - /dev/sda3
    logical_volumes:
      opt:
        size: 20G
      tmp:
        size: 1G
      usr:
        size: 3G
      var:
        size: 15G
      home:
        size: 5G
      backup:
        size: 5G
        mountpath: /var/backups
        mountpath_require: true

or to just build the VG if it does not exist

---
lvm::volume_groups:
  myvg:
    createonly: true
    physical_volumes:
      /dev/sda2:
        unless_vg: 'myvg'
      /dev/sda3:
        unless_vg: 'myvg'
    logical_volumes:
      opt:
        size: 20G
      tmp:
        size: 1G
      usr:
        size: 3G
      var:
        size: 15G
      home:
        size: 5G
      backup:
        size: 5G
        mountpath: /var/backups
        mountpath_require: true

Except that in the latter case you cannot specify create options. If you want to omit the file system type, but still specify the size of the logical volume, i.e. in the case if you are planning on using this logical volume as a swap partition or a block device for a virtual machine image, you need to use a hash to pass the parameters to the definition.

If you need a more complex configuration, you'll need to build the resources out yourself.

Optional Values

The unless_vg (physical_volume) and createonly (volume_group) will check to see if "myvg" exists. If "myvg" does exist then they will not modify the physical volume or volume_group. This is useful if your environment is built with certain disks but they change while the server grows, shrinks or moves.

Example:

physical_volume { "/dev/hdc":
  ensure    => present,
  unless_vg => "myvg",
}

volume_group { "myvg":
  ensure           => present,
  physical_volumes => "/dev/hdc",
  createonly       => true,
}

Tasks

See tasks reference

Plans

See plans reference

Limitations

Namespacing

Due to puppet's lack of composite keys for resources, you currently cannot define two logical_volume resources with the same name but a different volume_group.

Removing Physical Volumes

You should not remove a physical_volume from a volume_group without ensuring the physical volume is no longer in use by a logical volume (and possibly doing a data migration with the pvmove executable).

Removing a physical_volume from a volume_group resource will cause the pvreduce to be executed -- no attempt is made to ensure pvreduce does not attempt to remove a physical volume in-use.

Resizing Logical Volumes

Logical volume size can be extended, but not reduced -- this is for safety, as manual intervention is probably required for data migration, etc.

Deprecation Notice

Some facts reported by this module are being deprecated in favor of upcoming structured facts. The following facts are being deprecated:

lvm_vg_*
lvm_vg_*_pvs
lvm_pv_*

License

This codebase is licensed under the GPL 2.0, however due to the nature of the codebase the open source dependencies may also use a combination of AGPL, BSD-2, BSD-3, GPL2.0, LGPL, MIT and MPL.

Contributors

Bruce Williams bruce@codefluency.com

Daniel Kerwin github@reductivelabs.com

Luke Kanies luke@reductivelabs.com

Matthaus Litteken matthaus@puppetlabs.com

Michael Stahnke stahnma@puppetlabs.com

Mikael Fridh frimik@gmail.com

Tim Hawes github@reductivelabs.com

Yury V. Zaytsev yury@shurup.com

csschwe csschwe@gmail.com

windowsrefund windowsrefund@gmail.com

Adam Gibbins github@adamgibbins.com

Steffen Zieger github@saz.sh

Jason A. Smith smithj4@bnl.gov

Mathieu Bornoz mathieu.bornoz@camptocamp.com

Cédric Jeanneret cedric.jeanneret@camptocamp.com

Raphaël Pinson raphael.pinson@camptocamp.com

Garrett Honeycutt code@garretthoneycutt.com

More Contributors

Reference

Classes

lvm: Manage LVM

Defined types

lvm::logical_volume: Manage a logical volume.
lvm::physical_volume: Manage a physical volume
lvm::volume: Manage a logical_volume.
lvm::volume_group: Manage a volume group.

Resource types

filesystem: The filesystem type
logical_volume: Logical volume resource type
physical_volume: Physical volume resource type
volume_group: Volume group resource type

Functions

lvm::bytes_to_size: Convert a number of bytes to a size format that LVM can understand
lvm::size_to_bytes: Convert an LVM size to bytes, the opposite of lvm::bytes_to_size

Tasks

ensure_fs: Ensures settings on a filesystem using the type & provider
ensure_lv: Ensures settings on a logical volume using the type & provider
ensure_pv: Ensures settings on a physical volumes using the type & provider
ensure_vg: Ensures settings on a volume group using the type & provider
extend_lv: Extends a logical volume
extend_vg: Adds physical volumes to a volume group
mount_lv: Mounts a logical volume

Plans

lvm::expand: An opinionated method for expanding storage on machines that use LVM. If this doesn't fit your needs, simply tie the tasks together in some way that does.

Classes

`lvm`

Manage LVM

Parameters

The following parameters are available in the lvm class:

package_ensure
manage_pkg
volume_groups

`package_ensure`

Data type: Enum['installed', 'present', 'latest', 'absent']

Ensure value for the lvm2 package.

Default value: 'installed'

`manage_pkg`

Data type: Boolean

Whether to manage the lvm2 package.

Default value: false

`volume_groups`

Data type: Hash

Hash of lvm::volume_group resources to create.

Default value: {}

Defined types

`lvm::logical_volume`

This will automatically set this volume group as a dependency, but it must be defined elsewhere using the volume_group resource type.

the partition size.

(if the LV found is larger then the size requests this is just logged not causing a FAIL)

are in sync. Cannot be changed on already mirrored volume. Take your mirror size in terabytes and round up that number to the next power of 2, using that number as the -R argument

Parameters

The following parameters are available in the lvm::logical_volume defined type:

volume_group
size
initial_size
ensure
options
pass
dump
fs_type
mkfs_options
mountpath
mountpath_require
mounted
createfs
extents
stripes
stripesize
readahead
range
size_is_minsize
type
thinpool
poolmetadatasize
mirror
mirrorlog
no_sync
region_size
alloc
yes_flag

`volume_group`

Data type: String[1]

The volume group name associated with this logical volume.

`size`

Data type: Optional[String[1]]

Configures the size of the filesystem. Supports filesystem resizing. The size will be rounded up to the nearest multiple of

Default value: undef

`initial_size`

Data type: Optional[String[1]]

The initial size of the logical volume. This will only apply to newly-created volumes

Default value: undef

`ensure`

Data type: Enum['absent', 'present']

Default value: present

`options`

Data type: String[1]

Params for the mkfs command

Default value: 'defaults'

`pass`

Data type: Variant[String[1], Integer]

Default value: '2'

`dump`

Data type: Variant[String[1], Integer]

Default value: '0'

`fs_type`

Data type: String[1]

The file system type. eg. ext3.

Default value: 'ext4'

`mkfs_options`

Data type: Optional[String[1]]

Default value: undef

`mountpath`

Data type: Stdlib::Absolutepath

Default value: "/${name}"

`mountpath_require`

Data type: Boolean

Default value: false

`mounted`

Data type: Boolean

If puppet should mount the volume. This only affects what puppet will do, and not what will be mounted at boot-time.

Default value: true

`createfs`

Data type: Boolean

Default value: true

`extents`

Data type: Optional[String[1]]

The number of logical extents to allocate for the new logical volume. Set to undef to use all available space

Default value: undef

`stripes`

Data type: Optional[Variant[String[1], Integer]]

The number of stripes to allocate for the new logical volume.

Default value: undef

`stripesize`

Data type: Optional[Variant[String[1], Integer]]

The stripesize to use for the new logical volume.

Default value: undef

`readahead`

Data type: Optional[Variant[String[1], Integer]]

The readahead count to use for the new logical volume.

Default value: undef

`range`

Data type: Optional[Enum['maximum', 'minimum']]

Set to true if the ‘size’ parameter specified, is just the minimum size you need

Default value: undef

`size_is_minsize`

Data type: Optional[Boolean]

Lists strings for access control for connection method, users, databases, IPv4 addresses;

Default value: undef

`type`

Data type: Optional[String[1]]

Configures the logical volume type. AIX only

Default value: undef

`thinpool`

Data type: Variant[Boolean, String]

Set to true to create a thin pool or to pool name to create thin volume

Default value: false

`poolmetadatasize`

Data type: Optional[Integer[0, 4]]

Set the initial size of the logical volume pool metadata on creation

Default value: undef

`mirror`

Data type: Optional[String[1]]

The number of mirrors of the volume.

Default value: undef

`mirrorlog`

Data type: Optional[Enum['core', 'disk', 'mirrored']]

How to store the mirror log (Allowed values: core, disk, mirrored).

Default value: undef

`no_sync`

Data type: Optional[Boolean]

An optimization in lvcreate, at least on Linux.

Default value: undef

`region_size`

Data type: Optional[Variant[String[1], Integer]]

A mirror is divided into regions of this size (in MB), the mirror log uses this granularity to track which regions

Default value: undef

`alloc`

Data type: Optional[Enum['anywhere', 'contiguous', 'cling', 'inherit', 'normal']]

The allocation policy when a command needs to allocate Physical Extents from the Volume Group.

Default value: undef

`yes_flag`

Data type: Boolean

If set to true, do not prompt for confirmation interactively but always assume the answer yes.

Default value: false

`lvm::physical_volume`

Manage a physical volume

Parameters

The following parameters are available in the lvm::physical_volume defined type:

ensure
force
unless_vg

`ensure`

Data type: Enum['present', 'absent']

ensures phycial volume is present or absent

Default value: present

`force`

Data type: Boolean

Whether to force the creation without any confirmation.

Default value: false

`unless_vg`

Data type: Optional[String[1]]

Do not do anything if the VG already exists. The value should be the name of the volume group to check for.

Default value: undef

`lvm::volume`

Ensures a physical_volume, volume_group, and filesystem resource have been created on the block device supplied in the pv parameter.

physical_volume, volume_group, logical_volume, and filesystem resources are present for the volume. A value of cleaned will ensure that all of the resources are absent. Warning: this has a high potential for unexpected harm, so use it with caution. A value of absent will remove only the logical_volume resource from the system.

volume.

Set to undef to use all available space

This will only apply to newly-created volumes

Examples

Basic usage


lvm::volume { 'lv_example0':
  vg     => 'vg_example0',
  pv     => '/dev/sdd1',
  fstype => 'ext4',
  size   => '100GB',
}

Parameters

The following parameters are available in the lvm::volume defined type:

ensure
fstype
pv
vg
size
extents
initial_size

`ensure`

Data type: Enum['present', 'absent', 'cleaned']

Can only be set to cleaned, absent or present. A value of present will ensure that the

`fstype`

Data type: Optional[String[1]]

The type of filesystem to create on the logical

Default value: undef

`pv`

Data type: Stdlib::Absolutepath

path to physcial volume

`vg`

Data type: String[1]

value of volume group

`size`

Data type: Optional[String[1]]

The size the logical_voluem should be.

Default value: undef

`extents`

Data type: Optional[Variant[String[1], Integer]]

The number of logical extents to allocate for the new logical volume.

Default value: undef

`initial_size`

Data type: Optional[String[1]]

The initial size of the logical volume.

Default value: undef

`lvm::volume_group`

Manage a volume group.

Parameters

The following parameters are available in the lvm::volume_group defined type:

physical_volumes
createonly
ensure
logical_volumes
followsymlinks

`physical_volumes`

Data type: Variant[Hash, Array, String]

The list of physical volumes to be included in the volume group. This will automatically set these as dependencies, but they must be defined elsewhere using the physical_volume resource type.

`createonly`

Data type: Boolean

If true, the volume group will be created if it does not exist. If the volume group does exist, no action will be taken.

Default value: false

`ensure`

Data type: Enum['present', 'absent']

Whether this volume group should be present or absent.

Default value: present

`logical_volumes`

Data type: Hash

A hash of lvm::logical_volume resources to create in this volume group.

Default value: {}

`followsymlinks`

Data type: Boolean

If true, all current and wanted values of the physical_volumes property will be followed to their real files on disk if they are in fact symlinks. This is useful to have Puppet determine what the actual PV device is if the property value is a symlink, like /dev/disk/by-path/xxxx -> ../../sda.

Default value: false

Resource types

`filesystem`

The filesystem type

Properties

The following properties are available in the filesystem type.

`ensure`

Valid values: present, absent

The basic property that the resource should be in.

Default value: present

`size`

Configures the size of the filesystem. Supports filesystem resizing. The size will be rounded up to the nearest multiple of the partition size. AIX only.

Parameters

The following parameters are available in the filesystem type.

accounting
ag_size
agblksize
atboot
compress
device
encrypted
extended_attributes
frag
fs_type
initial_size
isnapshot
large_files
log_partitions
logname
logsize
maxext
mkfs_cmd
mount_options
mountgroup
mountguard
name
nbpi
nodename
options
perms
provider
vix
volume_group

`accounting`

Valid values: true, false

Specify accounting subsystem support, AIX only

`ag_size`

Valid values: %r{\d+}

Specify the allocation group size in megabytes, AIX only.

`agblksize`

Valid values: %r{\d+}

JFS2 block size in bytes, AIX only.

`atboot`

Valid values: true, false

Specify whether the file system is mounted at boot time, AIX only

`compress`

Valid values: LG, no

Data compression, LZ or no. AIX only

`device`

Device to create the filesystem on, this can be a device or a logical volume. AIX only

`encrypted`

Valid values: true, false

Specify and encrypted filesystem. AIX only

`extended_attributes`

Valid values: v1, v2

Format to be used to store extended attributes. AIX only

`frag`

Valid values: %r{\d+}

JFS fragment size in bytes. AIX only

`fs_type`

The file system type. eg. ext3.

`initial_size`

Initial size of the filesystem, Used only for resource creation, when using this option Puppet will not manage or maintain the size. To resize filesystems see the size property. AIX only.

`isnapshot`

Valid values: true, false

Specify whether the filesystem supports internal snapshots, AIX only

`large_files`

Valid values: true, false

Large file enabled file system. AIX only

`log_partitions`

Specify the size of the log logical volume as number of logical partitions, AIX only

`logname`

Configure the log logical volume. AIX only

`logsize`

Valid values: %r{\d+}

Size for an inline log in MB, AIX only

`maxext`

Valid values: %r{\d+}

Size of a file extent in file system blocks, AIX only

`mkfs_cmd`

Command to use to create the file system. Defaults to mkswap for fs_type=swap, otherwise mkfs.{{fs_type}}

`mount_options`

Specify the options to be passed to the mount command. AIX only

`mountgroup`

Mount group for the filesystem, AIX only

`mountguard`

Valid values: true, false

Enable the mountguard. AIX only

`name`

namevar

Resource name

`nbpi`

Valid values: %r{\d+}

Bytes per inode. AIX only

`nodename`

Specify the remote host where the filesystem resides. AIX only

`options`

Params for the mkfs command. eg. -l internal,agcount=x

`perms`

Valid values: ro, rw

Permissions for the filesystem, AIX only

`provider`

The specific backend to use for this filesystem resource. You will seldom need to specify this --- Puppet will usually discover the appropriate provider for your platform.

`vix`

Valid values: true, false

Specify that the file system can allocate inode extents smaller than the default, AIX only

`volume_group`

Volume group that the file system should be created on. AIX only.

`logical_volume`

Logical volume resource type

Properties

The following properties are available in the logical_volume type.

`ensure`

Valid values: present, absent

The basic property that the resource should be in.

Default value: present

`mirror`

The number of mirrors of the volume.

`mirrorlog`

Valid values: core, disk, mirrored

How to store the mirror log (core, disk, mirrored).

`size`

The size of the logical volume. Set to undef to use all available space

`stripes`

The number of stripes to allocate for the new logical volume.

`volume_group`

The volume group name associated with this logical volume. This will automatically set this volume group as a dependency, but it must be defined elsewhere using the volume_group resource type.

Parameters

The following parameters are available in the logical_volume type.

alloc
extents
initial_size
minor
name
no_sync
persistent
poolmetadatasize
provider
range
readahead
region_size
resize_fs
size_is_minsize
stripesize
thinpool
type
yes_flag

`alloc`

Valid values: anywhere, contiguous, cling, inherit, normal

Selects the allocation policy when a command needs to allocate Physical Extents from the Volume Group.

`extents`

The number of logical extents to allocate for the new logical volume. Set to undef to use all available space

`initial_size`

The initial size of the logical volume. This will only apply to newly-created volumes

`minor`

Set the minor number

`name`

namevar

The name of the logical volume. This is the unqualified name and will be automatically added to the volume group's device path (e.g., '/dev/$vg/$lv').

`no_sync`

An optimization in lvcreate, at least on Linux.

`persistent`

Set to true to make the block device persistent

`poolmetadatasize`

Change the size of logical volume pool metadata

`provider`

The specific backend to use for this logical_volume resource. You will seldom need to specify this --- Puppet will usually discover the appropriate provider for your platform.

`range`

Sets the inter-physical volume allocation policy. AIX only

`readahead`

The readahead count to use for the new logical volume.

`region_size`

A mirror is divided into regions of this size (in MB), the mirror log uses this granularity to track which regions are in sync. CAN NOT BE CHANGED on already mirrored volume. Take your mirror size in terabytes and round up that number to the next power of 2, using that number as the -R argument.

`resize_fs`

Whether or not to resize the underlying filesystem when resizing the logical volume.

Default value: true

`size_is_minsize`

Set to true if the 'size' parameter specified, is just the minimum size you need (if the LV found is larger then the size requests this is just logged not causing a FAIL)

Default value: false

`stripesize`

The stripesize to use for the new logical volume.

`thinpool`

Set to true to create a thin pool or to pool name to create thin volume

Default value: false

`type`

Configures the logical volume type.

`yes_flag`

If set to true, do not prompt for confirmation interactively but always assume the answer yes.

Default value: false

`physical_volume`

Physical volume resource type

Properties

The following properties are available in the physical_volume type.

`ensure`

Valid values: present, absent

The basic property that the resource should be in.

Default value: present

Parameters

The following parameters are available in the physical_volume type.

force
name
provider
unless_vg

`force`

Valid values: true, false

Force the creation without any confirmation.

Default value: false

`name`

namevar

Resource name

`provider`

The specific backend to use for this physical_volume resource. You will seldom need to specify this --- Puppet will usually discover the appropriate provider for your platform.

`unless_vg`

Do not do anything if the VG already exists. The value should be the name of the volume group to check for.

`volume_group`

Volume group resource type

Properties

The following properties are available in the volume_group type.

`ensure`

Valid values: present, absent

The basic property that the resource should be in.

Default value: present

`physical_volumes`

The list of physical volumes to be included in the volume group; this will automatically set these as dependencies, but they must be defined elsewhere using the physical_volume resource type.

Parameters

The following parameters are available in the volume_group type.

createonly
extent_size
followsymlinks
name
provider

`createonly`

Valid values: true, false, yes, no

Aliases: "yes"=>"true", "no"=>"false"

If set to true the volume group will be created if it does not exist. If the volume group does exist no action will be taken. Defaults to false.

Default value: false

`extent_size`

The physical extent size. Uses OS default if not provided. Only applicable on Linux.

`followsymlinks`

Valid values: true, false, yes, no

Aliases: "yes"=>"true", "no"=>"false"

If set to true all current and wanted values of the physical_volumes property will be followed to their real files on disk if they are in fact symlinks. This is useful to have Puppet determine what the actual PV device is if the property value is a symlink, like '/dev/disk/by-path/xxxx -> ../../sda'. Defaults to False.

Default value: false

`name`

namevar

The name of the volume group.

`provider`

The specific backend to use for this volume_group resource. You will seldom need to specify this --- Puppet will usually discover the appropriate provider for your platform.

Functions

`lvm::bytes_to_size`

Type: Puppet Language

Convert a number of bytes to a size format that LVM can understand

Examples

Return `200g`


lvm::bytes_to_size(214748364800)

`lvm::bytes_to_size(Numeric $size)`

The lvm::bytes_to_size function.

Returns: Any LVM-formatted size

Examples

Return `200g`


lvm::bytes_to_size(214748364800)

`size`

Data type: Numeric

`lvm::size_to_bytes`

Type: Puppet Language

Convert an LVM size to bytes, the opposite of lvm::bytes_to_size

`lvm::size_to_bytes(String $size)`

The lvm::size_to_bytes function.

Returns: Any byte value of LVM-formatted size

`size`

Data type: String

Tasks

`ensure_fs`

Ensures settings on a filesystem using the type & provider

Supports noop? false

Parameters

`fs_type`

Data type: String

The file system type. eg. ext3.

`name`

Data type: String

Fully qualified name

`mkfs_cmd`

Data type: Optional[String]

Command to use to create the file system. Defaults to mkswap for fs_type=swap, otherwise mkfs.{{fs_type}}

`options`

Data type: Optional[String]

Params for the mkfs command. eg. -l internal,agcount=x

`initial_size`

Data type: Optional[String]

Initial size of the filesystem, Used only for resource creation, when using this option Puppet will not manage or maintain the size. To resize filesystems see the size property. AIX only.

`size`

Data type: Optional[String]

Configures the size of the filesystem. Supports filesystem resizing. The size will be rounded up to the nearest multiple of the partition size. AIX only.

`ag_size`

Data type: Optional[Integer]

Specify the allocation group size in megabytes, AIX only.

`large_files`

Data type: Optional[Boolean]

Large file enabled file system. AIX only

`compress`

Data type: Optional[Enum[LG,no]]

Data compression, LZ or no. AIX only

`frag`

Data type: Optional[Integer]

JFS fragment size in bytes. AIX only

`nbpi`

Data type: Optional[Integer]

Bytes per inode. AIX only

`logname`

Data type: Optional[String]

Configure the log logical volume. AIX only

`logsize`

Data type: Optional[Integer]

Size for an inline log in MB, AIX only

`maxext`

Data type: Optional[Integer]

Size of a file extent in file system blocks, AIX only

`mountguard`

Data type: Optional[Boolean]

Enable the mountguard. AIX only

`agblksize`

Data type: Optional[Integer]

JFS2 block size in bytes, AIX only

`extended_attributes`

Data type: Optional[Enum[v1,v2]]

Format to be used to store extended attributes. AIX only

`encrypted`

Data type: Optional[Boolean]

Specify and encrypted filesystem. AIX only

`isnapshot`

Data type: Optional[Boolean]

Specify whether the filesystem supports internal snapshots, AIX only

`mount_options`

Data type: Optional[String]

Specify the options to be passed to the mount command. AIX only

`vix`

Data type: Optional[Boolean]

Specify that the file system can allocate inode extents smaller than the default, AIX only

`log_partitions`

Data type: Optional[String]

Specify the size of the log logical volume as number of logical partitions, AIX only

`nodename`

Data type: Optional[String]

Specify the remote host where the filesystem resides. AIX only

`accounting`

Data type: Optional[Boolean]

Specify accounting subsystem support, AIX only

`mountgroup`

Data type: Optional[String]

Mount group for the filesystem, AIX only

`atboot`

Data type: Optional[Boolean]

Specify whether the file system is mounted at boot time, AIX only

`perms`

Data type: Optional[Enum[ro,rw]]

Permissions for the filesystem, AIX only

`device`

Data type: Optional[String]

Device to create the filesystem on, this can be a device or a logical volume. AIX only

`volume_group`

Data type: Optional[String]

Volume group that the file system should be created on. AIX only.

`ensure_lv`

Ensures settings on a logical volume using the type & provider

Supports noop? false

Parameters

`ensure`

Data type: Enum[present,absent]

Present or absent

`name`

Data type: String[1]

The name of the logical volume. This is the unqualified name and will be automatically added to the volume group's device path (e.g., '/dev/$vg/$lv').

`volume_group`

Data type: Optional[String[1]]

The volume group name associated with this logical volume

`size`

Data type: Optional[Pattern[/^[0-9]+(\.[0-9]+)?[KMGTPEkmgtpe]/]]

The size of the logical volume. Set to undef to use all available space

`extents`

Data type: Optional[Pattern[/^\d+(%(?:vg|pvs|free|origin)?)?$/]]

The number of logical extents to allocate for the new logical volume. Set to undef to use all available space

`persistent`

Data type: Optional[Boolean]

Set to true to make the block device persistent

`thinpool`

Data type: Optional[Boolean]

Set to true to create a thin pool or to pool name to create thin volume

`poolmetadatasize`

Data type: Optional[Pattern[/^[0-9]+(\.[0-9]+)?[KMGTPEkmgtpe]/]]

Change the size of logical volume pool metadata

`minor`

Data type: Optional[Integer[0,255]]

Set the minor number

`type`

Data type: Optional[String[1]]

Configures the logical volume type

`range`

Data type: Optional[Enum[maximum,minimum]]

Sets the inter-physical volume allocation policy. AIX only

`stripes`

Data type: Optional[Integer]

The number of stripes to allocate for the new logical volume

`stripesize`

Data type: Optional[Integer]

The stripesize to use for the new logical volume

`readahead`

Data type: Optional[String]

The readahead count to use for the new logical volume

`resize_fs`

Data type: Optional[Boolean]

Whether or not to resize the underlying filesystem when resizing the logical volume

`mirror`

Data type: Optional[Integer[0,4]]

The number of mirrors of the volume

`mirrorlog`

Data type: Optional[Enum[core,disk,mirrored]]

How to store the mirror log

`alloc`

Data type: Optional[Enum[anywhere,contiguous,cling,inherit,normal]]

Selects the allocation policy when a command needs to allocate Physical Extents from the Volume Group

`no_sync`

Data type: ``

An optimization in lvcreate, at least on Linux

`region_size`

Data type: Optional[Integer]

`yes_flag`

Data type: Boolean

If set to true, do not prompt for confirmation interactively but always assume the answer yes.

`ensure_pv`

Ensures settings on a physical volumes using the type & provider

Supports noop? false

Parameters

`name`

Data type: String[1]

The name of the physical volume

`ensure`

Data type: Enum[present,absent]

Present or absent

`unless_vg`

Data type: Optional[String]

Do not do anything if the VG already exists. The value should be the name of the volume group to check for.

`force`

Data type: Optional[Boolean]

Force the creation without any confirmation

`ensure_vg`

Ensures settings on a volume group using the type & provider

Supports noop? false

Parameters

`name`

Data type: String[1]

The name of the volume group

`ensure`

Data type: Enum[present,absent]

Present or absent

`createonly`

Data type: Optional[Boolean]

If set to true the volume group will be created if it does not exist. If the volume group does exist no action will be taken

`followsymlinks`

Data type: Optional[Boolean]

`physical_volumes`

Data type: Array[String]

The list of physical volumes to be included in the volume group

`extend_lv`

Extends a logical volume

Supports noop? false

Parameters

`size`

Data type: String[1]

Intended size or 'full'

`logical_volume`

Data type: String[1]

Name of the logical volume to extend

`volume_group`

Data type: String[1]

Name of the volume group on which the logical volume resides

`extend_vg`

Adds physical volumes to a volume group

Supports noop? false

Parameters

`volume_group`

Data type: String[1]

The name of the volume group

`physical_volumes`

Data type: Array[String]

The list of physical volumes to be included in the volume group

`mount_lv`

Mounts a logical volume

Supports noop? false

Parameters

`volume_group`

Data type: String[1]

The name of the volume group

`logical_volume`

Data type: String[1]

The name of the logical_volume to mount

`mountpoint`

Data type: String[1]

Where to mount the logical volume

`fstype`

Data type: String

The mount type. Valid values depend on the operating system. This is a required option.

`options`

Data type: Optional[String]

A single string containing options for the mount, as they would appear in fstab on Linux. For many platforms this is a comma-delimited string

`atboot`

Data type: Optional[Boolean]

Whether to mount the mount at boot. Not all platforms support this.

`owner`

Data type: Optional[String]

Owner for the mountpoint

`group`

Data type: Optional[String]

Group for the mountpoint

`mode`

Data type: Optional[String]

Permissions for the mountpoint

Plans

`lvm::expand`

An opinionated method for expanding storage on machines that use LVM. If this doesn't fit your needs, simply tie the tasks together in some way that does.

Parameters

The following parameters are available in the lvm::expand plan:

server
volume_group
logical_volume
additional_size
disks
resize_fs

`server`

Data type: String

The target for the plan

`volume_group`

Data type: String

The volume group to which the logical volume belongs

`logical_volume`

Data type: String

The logical volume which is to be expanded

`additional_size`

Data type: String

How much size to add to the LV. This should be specified in LVM format i.e. "200m" or "2.5g"

`disks`

Data type: Array[String]

Any physical disks that should be added to the volume group as part of the expand process

Default value: []

`resize_fs`

Data type: Boolean

Wheather or not to resize the filesystem

Default value: true

What are tasks?

Modules can contain tasks that take action outside of a desired state managed by Puppet. It’s perfect for troubleshooting or deploying one-off changes, distributing scripts to run across your infrastructure, or automating changes that need to happen in a particular order as part of an application deployment.

Tasks in this module release

ensure_fs

Ensures settings on a filesystem using the type & provider

Parameters
accounting	Specify accounting subsystem support, AIX only `Optional[Boolean]`
ag_size	Specify the allocation group size in megabytes, AIX only. `Optional[Integer]`
agblksize	JFS2 block size in bytes, AIX only `Optional[Integer]`
atboot	Specify whether the file system is mounted at boot time, AIX only `Optional[Boolean]`
compress	Data compression, LZ or no. AIX only `Optional[Enum[LG,no]]`
device	Device to create the filesystem on, this can be a device or a logical volume. AIX only `Optional[String]`
encrypted	Specify and encrypted filesystem. AIX only `Optional[Boolean]`
extended_attributes	Format to be used to store extended attributes. AIX only `Optional[Enum[v1,v2]]`
frag	JFS fragment size in bytes. AIX only `Optional[Integer]`
fs_type	The file system type. eg. ext3. `String`
initial_size	Initial size of the filesystem, Used only for resource creation, when using this option Puppet will not manage or maintain the size. To resize filesystems see the size property. AIX only. `Optional[String]`
isnapshot	Specify whether the filesystem supports internal snapshots, AIX only `Optional[Boolean]`
large_files	Large file enabled file system. AIX only `Optional[Boolean]`
log_partitions	Specify the size of the log logical volume as number of logical partitions, AIX only `Optional[String]`
logname	Configure the log logical volume. AIX only `Optional[String]`
logsize	Size for an inline log in MB, AIX only `Optional[Integer]`
maxext	Size of a file extent in file system blocks, AIX only `Optional[Integer]`
mkfs_cmd	Command to use to create the file system. Defaults to mkswap for fs_type=swap, otherwise mkfs.{{fs_type}} `Optional[String]`
mount_options	Specify the options to be passed to the mount command. AIX only `Optional[String]`
mountgroup	Mount group for the filesystem, AIX only `Optional[String]`
mountguard	Enable the mountguard. AIX only `Optional[Boolean]`
name	Fully qualified name `String`
nbpi	Bytes per inode. AIX only `Optional[Integer]`
nodename	Specify the remote host where the filesystem resides. AIX only `Optional[String]`
options	Params for the mkfs command. eg. -l internal,agcount=x `Optional[String]`
perms	Permissions for the filesystem, AIX only `Optional[Enum[ro,rw]]`
size	Configures the size of the filesystem. Supports filesystem resizing. The size will be rounded up to the nearest multiple of the partition size. AIX only. `Optional[String]`
vix	Specify that the file system can allocate inode extents smaller than the default, AIX only `Optional[Boolean]`
volume_group	Volume group that the file system should be created on. AIX only. `Optional[String]`

Input method

stdin

ensure_lv

Ensures settings on a logical volume using the type & provider

Parameters
alloc	Selects the allocation policy when a command needs to allocate Physical Extents from the Volume Group `Optional[Enum[anywhere,contiguous,cling,inherit,normal]]`
ensure	Present or absent `Enum[present,absent]`
extents	The number of logical extents to allocate for the new logical volume. Set to undef to use all available space `Optional[Pattern[/^\d+(%(?:vg\|pvs\|free\|origin)?)?$/]]`
minor	Set the minor number `Optional[Integer[0,255]]`
mirror	The number of mirrors of the volume `Optional[Integer[0,4]]`
mirrorlog	How to store the mirror log `Optional[Enum[core,disk,mirrored]]`
name	The name of the logical volume. This is the unqualified name and will be automatically added to the volume group's device path (e.g., '/dev/$vg/$lv'). `String[1]`
no_sync	An optimization in lvcreate, at least on Linux
persistent	Set to true to make the block device persistent `Optional[Boolean]`
poolmetadatasize	Change the size of logical volume pool metadata `Optional[Pattern[/^[0-9]+(\.[0-9]+)?[KMGTPEkmgtpe]/]]`
range	Sets the inter-physical volume allocation policy. AIX only `Optional[Enum[maximum,minimum]]`
readahead	The readahead count to use for the new logical volume `Optional[String]`
region_size	A mirror is divided into regions of this size (in MB), the mirror log uses this granularity to track which regions are in sync. CAN NOT BE CHANGED on already mirrored volume. Take your mirror size in terabytes and round up that number to the next power of 2, using that number as the -R argument. `Optional[Integer]`
resize_fs	Whether or not to resize the underlying filesystem when resizing the logical volume `Optional[Boolean]`
size	The size of the logical volume. Set to undef to use all available space `Optional[Pattern[/^[0-9]+(\.[0-9]+)?[KMGTPEkmgtpe]/]]`
stripes	The number of stripes to allocate for the new logical volume `Optional[Integer]`
stripesize	The stripesize to use for the new logical volume `Optional[Integer]`
thinpool	Set to true to create a thin pool or to pool name to create thin volume `Optional[Boolean]`
type	Configures the logical volume type `Optional[String[1]]`
volume_group	The volume group name associated with this logical volume `Optional[String[1]]`
yes_flag	If set to true, do not prompt for confirmation interactively but always assume the answer yes. `Boolean`

Input method

stdin

ensure_pv

Ensures settings on a physical volumes using the type & provider

Parameters
ensure	Present or absent `Enum[present,absent]`
force	Force the creation without any confirmation `Optional[Boolean]`
name	The name of the physical volume `String[1]`
unless_vg	Do not do anything if the VG already exists. The value should be the name of the volume group to check for. `Optional[String]`

Input method

stdin

ensure_vg

Ensures settings on a volume group using the type & provider

Parameters
createonly	If set to true the volume group will be created if it does not exist. If the volume group does exist no action will be taken `Optional[Boolean]`
ensure	Present or absent `Enum[present,absent]`
followsymlinks	If set to true all current and wanted values of the physical_volumes property will be followed to their real files on disk if they are in fact symlinks. This is useful to have Puppet determine what the actual PV device is if the property value is a symlink, like '/dev/disk/by-path/xxxx -> ../../sda' `Optional[Boolean]`
name	The name of the volume group `String[1]`
physical_volumes	The list of physical volumes to be included in the volume group `Array[String]`

Input method

stdin

extend_lv

Extends a logical volume

Parameters
logical_volume	Name of the logical volume to extend `String[1]`
size	Intended size or 'full' `String[1]`
volume_group	Name of the volume group on which the logical volume resides `String[1]`

Input method

stdin

extend_vg

Adds physical volumes to a volume group

Parameters
physical_volumes	The list of physical volumes to be included in the volume group `Array[String]`
volume_group	The name of the volume group `String[1]`

mount_lv

Mounts a logical volume

Parameters
atboot	Whether to mount the mount at boot. Not all platforms support this. `Optional[Boolean]`
fstype	The mount type. Valid values depend on the operating system. This is a required option. `String`
group	Group for the mountpoint `Optional[String]`
logical_volume	The name of the logical_volume to mount `String[1]`
mode	Permissions for the mountpoint `Optional[String]`
mountpoint	Where to mount the logical volume `String[1]`
options	A single string containing options for the mount, as they would appear in fstab on Linux. For many platforms this is a comma-delimited string `Optional[String]`
owner	Owner for the mountpoint `Optional[String]`
volume_group	The name of the volume group `String[1]`

Input method

stdin

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog and this project adheres to Semantic Versioning.

v3.0.0 - 2024-12-16

Full Changelog

Changed

MAINT : Removing support for centos 7 & 8 #346 (malikparvez)

Added

(CAT-2101) Add support for Debian-12 #353 (skyamgarp)

Fixed

(CAT-2158) Upgrade rexml to address CVE-2024-49761 #359 (amitkarsale)

v2.3.0 - 2024-07-11

Full Changelog

Added

CAT-1912 : Adding new getters and setters for stripes & not allowing change of stripes for an existing lvm #343 (malikparvez)

v2.2.0 - 2024-06-26

Full Changelog

Added

Allow modifying the physical extent size for volume groups #333 (glangloi)

Other

Documentation cleanup #331 (kenyon)
pdk update to version 3.0.1 template-ref heads/main-0-g23c6fff #330 (kenyon)
Documentation fixes #329 (kenyon)
README, metadata: correct name of LVM in summaries #328 (kenyon)

v2.1.0 - 2023-09-21

Full Changelog

Added

Add yes argument when creating/extending a LV #279 (bmlit)

Fixed

fix issues on nodes without lvm #308 (rtib)

v2.0.3 - 2023-07-11

Full Changelog

Fixed

[GH-298] fix lvmvg* facts #301 (rtib)

v2.0.2 - 2023-06-07

Full Changelog

Fixed

(GH-295) - fix vg datatype #296 (jordanbreen28)
(gh-293) - fix typo with ensure #294 (jordanbreen28)

v2.0.1 - 2023-06-06

Full Changelog

Fixed

(gh-290) - fix broken datatype for extents #291 (jordanbreen28)

v2.0.0 - 2023-06-02

Full Changelog

Changed

(maint) - Add puppet 8/Drop puppet 6 #284 (jordanbreen28)

Added

pdksync - (MAINT) - Allow Stdlib 9.x #286 (LukasAud)
(CONT-974) - Add puppet module support #283 (jordanbreen28)

Fixed

(maint) Update Puppet VS Code Extension ID #255 (jpogran)
(RE-12896) use artifactory instead of saturn/pe-releases #245 (sarameisburger)

v1.4.0 - 2020-02-12

Full Changelog

Added

volume_group type does not handle passing of physical_volumes as a hash #219 (dacron)

Fixed

Make lv that is a substring of a vg work #244 (genebean)
Revert "volume_group type does not handle passing of physical_volumes as a hash" #238 (tphoney)

v1.3.0 - 2019-05-31

Full Changelog

Fixed

(MODULES-9004) Resize XFS file system by mount point, not by volume #232 (foofoo-2)

1.2.0 - 2019-01-02

Full Changelog

Added

Added test matrix for Puppet 6 #223 (dylanratcliffe)

Fixed

(maint) - Fix rubygems-update for ruby < 2.3 #225 (david22swan)
(maint) Removed test code that missed review #224 (dylanratcliffe)
Don't execute the lvm commands when not supported. #193 #222 (jograb)
Allow puppetlabs-stdlib versions >= 5.0 #221 (tdevelioglu)

1.1.0 - 2018-11-06

Full Changelog

Added

Add facts, functions, tasks, plans #215 (dylanratcliffe)
Added support for LVM Thin Volumes #210 (glorpen)

Fixed

Confine lvm providers to linux (MODULES-6449) #205 (hpcprofessional)

1.0.1 - 2018-04-26

Full Changelog

Fixed

#puppethack Fix error when creating XFS on top of another Filesystem #200 (stivesso)
Don't execute the lvm commands when not supported. #193 (smithj4)
Added Hash as acceptable type for physical_volumes #189 (stivesso)

1.0.0 - 2017-11-09

Full Changelog

Fixed

(MODULES-4067) Gracefully handle blkid return code 2 #188 (abottchen)
puppethack - MODULES-4753 and MODULES-4964 #187 (dhollinger)
Removing the 'extent size' check in logical_volume provider #185 (lukebigum)
Setting thinpool default to false #182 (missingcharacter)
Update fact to add 30 second timeout; add ifs to restrict lvm commands #158 (esalberg)
Set default mount option for dump to 0 #143 (chrw)

0.9.0 - 2017-01-12

Full Changelog

Added

Added the createonly option for the volumegroup and the possibility t… #147 (ricciocri)

Fixed

[#puppethack] fix syntax error in volume.pp #174 (cjswart)
Cannot add a new volume if the volume group has the same name. Fix: Better regexp for parsing the output of lvs #173 (ruriky)
resolve /dev/disk/by-path/xxxx symlinks to block devices #167 (timhughes)

0.8.0 - 2016-12-01

Full Changelog

Added

Ruby231 #166 (ghoneycutt)
Add support for thin provisioning and setting poolmetadatasize #154 (afalko)
Add missing parameters to manage mirrors for lvm::logical_volume. #148 (GiooDev)

Fixed

Fix parsing size from lvs output #169 (felixb)
(MODULES-3881) in which unit output is corrected and whitespace removed #162 (eputnam)
changed all instances of :true/:false to true/false #161 (crayfishx)
Corrected :false to false #160 (crayfishx)
fixed charset in provider/logical_volume/lvm.rb #155 (devfaz)
fixed: executed command 'swapoff' before unmount swap partion. #152 (MemberIT)
(MODULES-3230) Add flag to Logical_volume to not resize filesystem #151 (ssgelm)
(FM-4969) aix auto tests for physical/logical volume and volume_group on aix #150 (phongdly)

0.7.0 - 2016-03-04

Full Changelog

Added

Added support for volumes not mounted by lvm. #127 (kny78)

Fixed

Fix manage_pkg scope #139 (mcanevet)

0.6.0 - 2015-12-14

Full Changelog

Added

Added support to the resize of a logical volume with swap #136 (ricciocri)
Add the --type argument to lvcreate #129 (ccope)
add force option for physical_volume #120 (timogoebel)
add minor device no and persist options #119 (robinbowes)
Support mkfs_cmd - fixes MODULES-2215 #117 (robinbowes)
(MODULES-2103) Adds RAL For logical volume #114 (petems)
(MODULES-2103) Adds RAL for volume group #113 (petems)
(MODULES-2103) Adds RAL for physical_volume #111 (petems)
Add swap support. #109 (ckoenig)
add a fact that list all pvs in a vg #102 (duritong)

Fixed

Fix issue with using force method as pvcreate argument #135 (walkamongus)
If size_is_minsize is true, consider the size in sync if already larg… #125 (dfairhurst)
(logical_volume) Fix regex on new_size and coerce to float instead of int #123 (tdevelioglu)
Make size_is_minsize usable from lvm::logical_volume #121 (AndreasPfaffeneder)
(maint) Fixes specs for Puppet ~> 2.7.0 #112 (petems)
Fix bad regexp #108 (rabbitt)
Made logical_volume $size an optional parameter #95 (campos-ddc)

0.5.0 - 2015-04-27

Full Changelog

Added

mirrors - rc 3 #96 (mwangel)
Allow different values for pass and dump #94 (esalberg)
Support for readahead count when creating new volumes #90 (JamieCressey)

Fixed

Handle undef value in lvm::logical_volume #105 (riton)
Ordering of resources and removal of some defaults in class lvm #100 (TorLdre)
Fix filesystem type detection #93 (ckaenzig)
Fix unquoted strings in cases #92 (raphink)
escape dashes in lv name for dmsetup remove #81 (jhofeditz)

0.4.0 - 2014-12-02

Full Changelog

Added

Added Parameter 'size_is_minsize' (true|false(default)) #72 (elconas)
Feature/mkfs options and stripes #66 (mcanevet)
Support newer releases of Puppet #65 (ghoneycutt)

Fixed

MODULES-1324 Fix metadata URL and update for 0.3.4 release #83 (cyberious)
volume_group: physical_volumes is an unsorted array #79 (raphink)

0.3.3 - 2014-09-16

Full Changelog

Added

MODULES-1219 Add Compatability for >= 4.1.0 stdlib #73 (cyberious)

Fixed

Make metadata match puppet module build output #75 (underscorgan)
Fix issue where setting initial_size didn't prevent --extents=100%FREE #67 (underscorgan)

0.3.2 - 2014-06-25

Full Changelog

Added

Add autorequire for the volume_group #61 (adamcrews)

Fixed

Fix exec that was missing a path attribute #59 (adamcrews)
Fix a size comparison #58 (tih)

0.3.1 - 2014-04-10

Full Changelog

0.3.0 - 2014-04-10

Full Changelog

Added

Add init class #52 (mcanevet)

0.2.0 - 2014-02-04

Full Changelog

Added

Add AIX support for LVs and Filesystems #43 (crayfishx)
xfs online resizing support #40 (sgzijl)
use ensure_resources to handle multiple physical_volume in a volume_grou... #38 (kjetilho)
Add option for initial_size (rebased, original by @kvisle) #35 (tzachz)
Add lvm_support fact #25 (raphink)

Fixed

Extents doesn't work as a property, no method implemented. Also, add stripes and stripesize. #49 (mcallaway)
Fix issue 16174 (http://projects.puppetlabs.com/issues/16174) #47 (mkrakowitzer)
Suppress facter warnings on systems that don't support LVM. #44 (smithj4)
Make the XFS support optional, not required. #42 (smithj4)
Bug/21826: resize2fs isn't called during resizing on ruby>1.8 #33 (artem-sidorenko)
Allow for physical_volumes and volume_groups that change a system lives #30 (csschwe)
Feature/14718: size 'undef' doesn't work when creating a new logical volume #28 (raskas)
Fix messages with new_size variables in logical_volume/lvm.rb #27 (raphink)

0.1.2 - 2013-03-18

Full Changelog

Added

use 'blkid' instead of 'mount' to check the filesystem type #23 (mbornoz)

Fixed

Fix undefined method: inject for String #20 (robbat2)

0.1.1 - 2012-08-14

Full Changelog

Fixed

Added missing K unit to lv validate test. #7 (smithj4)

v0.1.0 - 2011-09-01

Full Changelog

		    GNU GENERAL PUBLIC LICENSE
		       Version 2, June 1991

 Copyright (C) 1989, 1991 Free Software Foundation, Inc.,
 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 Everyone is permitted to copy and distribute verbatim copies
 of this license document, but changing it is not allowed.

			    Preamble

  The licenses for most software are designed to take away your
freedom to share and change it.  By contrast, the GNU General Public
License is intended to guarantee your freedom to share and change free
software--to make sure the software is free for all its users.  This
General Public License applies to most of the Free Software
Foundation's software and to any other program whose authors commit to
using it.  (Some other Free Software Foundation software is covered by
the GNU Lesser General Public License instead.)  You can apply it to
your programs, too.

  When we speak of free software, we are referring to freedom, not
price.  Our General Public Licenses are designed to make sure that you
have the freedom to distribute copies of free software (and charge for
this service if you wish), that you receive source code or can get it
if you want it, that you can change the software or use pieces of it
in new free programs; and that you know you can do these things.

  To protect your rights, we need to make restrictions that forbid
anyone to deny you these rights or to ask you to surrender the rights.
These restrictions translate to certain responsibilities for you if you
distribute copies of the software, or if you modify it.

  For example, if you distribute copies of such a program, whether
gratis or for a fee, you must give the recipients all the rights that
you have.  You must make sure that they, too, receive or can get the
source code.  And you must show them these terms so they know their
rights.

  We protect your rights with two steps: (1) copyright the software, and
(2) offer you this license which gives you legal permission to copy,
distribute and/or modify the software.

  Also, for each author's protection and ours, we want to make certain
that everyone understands that there is no warranty for this free
software.  If the software is modified by someone else and passed on, we
want its recipients to know that what they have is not the original, so
that any problems introduced by others will not reflect on the original
authors' reputations.

  Finally, any free program is threatened constantly by software
patents.  We wish to avoid the danger that redistributors of a free
program will individually obtain patent licenses, in effect making the
program proprietary.  To prevent this, we have made it clear that any
patent must be licensed for everyone's free use or not licensed at all.

  The precise terms and conditions for copying, distribution and
modification follow.

		    GNU GENERAL PUBLIC LICENSE
   TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION

  0. This License applies to any program or other work which contains
a notice placed by the copyright holder saying it may be distributed
under the terms of this General Public License.  The "Program", below,
refers to any such program or work, and a "work based on the Program"
means either the Program or any derivative work under copyright law:
that is to say, a work containing the Program or a portion of it,
either verbatim or with modifications and/or translated into another
language.  (Hereinafter, translation is included without limitation in
the term "modification".)  Each licensee is addressed as "you".

Activities other than copying, distribution and modification are not
covered by this License; they are outside its scope.  The act of
running the Program is not restricted, and the output from the Program
is covered only if its contents constitute a work based on the
Program (independent of having been made by running the Program).
Whether that is true depends on what the Program does.

  1. You may copy and distribute verbatim copies of the Program's
source code as you receive it, in any medium, provided that you
conspicuously and appropriately publish on each copy an appropriate
copyright notice and disclaimer of warranty; keep intact all the
notices that refer to this License and to the absence of any warranty;
and give any other recipients of the Program a copy of this License
along with the Program.

You may charge a fee for the physical act of transferring a copy, and
you may at your option offer warranty protection in exchange for a fee.

  2. You may modify your copy or copies of the Program or any portion
of it, thus forming a work based on the Program, and copy and
distribute such modifications or work under the terms of Section 1
above, provided that you also meet all of these conditions:

    a) You must cause the modified files to carry prominent notices
    stating that you changed the files and the date of any change.

    b) You must cause any work that you distribute or publish, that in
    whole or in part contains or is derived from the Program or any
    part thereof, to be licensed as a whole at no charge to all third
    parties under the terms of this License.

    c) If the modified program normally reads commands interactively
    when run, you must cause it, when started running for such
    interactive use in the most ordinary way, to print or display an
    announcement including an appropriate copyright notice and a
    notice that there is no warranty (or else, saying that you provide
    a warranty) and that users may redistribute the program under
    these conditions, and telling the user how to view a copy of this
    License.  (Exception: if the Program itself is interactive but
    does not normally print such an announcement, your work based on
    the Program is not required to print an announcement.)

These requirements apply to the modified work as a whole.  If
identifiable sections of that work are not derived from the Program,
and can be reasonably considered independent and separate works in
themselves, then this License, and its terms, do not apply to those
sections when you distribute them as separate works.  But when you
distribute the same sections as part of a whole which is a work based
on the Program, the distribution of the whole must be on the terms of
this License, whose permissions for other licensees extend to the
entire whole, and thus to each and every part regardless of who wrote it.

Thus, it is not the intent of this section to claim rights or contest
your rights to work written entirely by you; rather, the intent is to
exercise the right to control the distribution of derivative or
collective works based on the Program.

In addition, mere aggregation of another work not based on the Program
with the Program (or with a work based on the Program) on a volume of
a storage or distribution medium does not bring the other work under
the scope of this License.

  3. You may copy and distribute the Program (or a work based on it,
under Section 2) in object code or executable form under the terms of
Sections 1 and 2 above provided that you also do one of the following:

    a) Accompany it with the complete corresponding machine-readable
    source code, which must be distributed under the terms of Sections
    1 and 2 above on a medium customarily used for software interchange; or,

    b) Accompany it with a written offer, valid for at least three
    years, to give any third party, for a charge no more than your
    cost of physically performing source distribution, a complete
    machine-readable copy of the corresponding source code, to be
    distributed under the terms of Sections 1 and 2 above on a medium
    customarily used for software interchange; or,

    c) Accompany it with the information you received as to the offer
    to distribute corresponding source code.  (This alternative is
    allowed only for noncommercial distribution and only if you
    received the program in object code or executable form with such
    an offer, in accord with Subsection b above.)

The source code for a work means the preferred form of the work for
making modifications to it.  For an executable work, complete source
code means all the source code for all modules it contains, plus any
associated interface definition files, plus the scripts used to
control compilation and installation of the executable.  However, as a
special exception, the source code distributed need not include
anything that is normally distributed (in either source or binary
form) with the major components (compiler, kernel, and so on) of the
operating system on which the executable runs, unless that component
itself accompanies the executable.

If distribution of executable or object code is made by offering
access to copy from a designated place, then offering equivalent
access to copy the source code from the same place counts as
distribution of the source code, even though third parties are not
compelled to copy the source along with the object code.

  4. You may not copy, modify, sublicense, or distribute the Program
except as expressly provided under this License.  Any attempt
otherwise to copy, modify, sublicense or distribute the Program is
void, and will automatically terminate your rights under this License.
However, parties who have received copies, or rights, from you under
this License will not have their licenses terminated so long as such
parties remain in full compliance.

  5. You are not required to accept this License, since you have not
signed it.  However, nothing else grants you permission to modify or
distribute the Program or its derivative works.  These actions are
prohibited by law if you do not accept this License.  Therefore, by
modifying or distributing the Program (or any work based on the
Program), you indicate your acceptance of this License to do so, and
all its terms and conditions for copying, distributing or modifying
the Program or works based on it.

  6. Each time you redistribute the Program (or any work based on the
Program), the recipient automatically receives a license from the
original licensor to copy, distribute or modify the Program subject to
these terms and conditions.  You may not impose any further
restrictions on the recipients' exercise of the rights granted herein.
You are not responsible for enforcing compliance by third parties to
this License.

  7. If, as a consequence of a court judgment or allegation of patent
infringement or for any other reason (not limited to patent issues),
conditions are imposed on you (whether by court order, agreement or
otherwise) that contradict the conditions of this License, they do not
excuse you from the conditions of this License.  If you cannot
distribute so as to satisfy simultaneously your obligations under this
License and any other pertinent obligations, then as a consequence you
may not distribute the Program at all.  For example, if a patent
license would not permit royalty-free redistribution of the Program by
all those who receive copies directly or indirectly through you, then
the only way you could satisfy both it and this License would be to
refrain entirely from distribution of the Program.

If any portion of this section is held invalid or unenforceable under
any particular circumstance, the balance of the section is intended to
apply and the section as a whole is intended to apply in other
circumstances.

It is not the purpose of this section to induce you to infringe any
patents or other property right claims or to contest validity of any
such claims; this section has the sole purpose of protecting the
integrity of the free software distribution system, which is
implemented by public license practices.  Many people have made
generous contributions to the wide range of software distributed
through that system in reliance on consistent application of that
system; it is up to the author/donor to decide if he or she is willing
to distribute software through any other system and a licensee cannot
impose that choice.

This section is intended to make thoroughly clear what is believed to
be a consequence of the rest of this License.

  8. If the distribution and/or use of the Program is restricted in
certain countries either by patents or by copyrighted interfaces, the
original copyright holder who places the Program under this License
may add an explicit geographical distribution limitation excluding
those countries, so that distribution is permitted only in or among
countries not thus excluded.  In such case, this License incorporates
the limitation as if written in the body of this License.

  9. The Free Software Foundation may publish revised and/or new versions
of the General Public License from time to time.  Such new versions will
be similar in spirit to the present version, but may differ in detail to
address new problems or concerns.

Each version is given a distinguishing version number.  If the Program
specifies a version number of this License which applies to it and "any
later version", you have the option of following the terms and conditions
either of that version or of any later version published by the Free
Software Foundation.  If the Program does not specify a version number of
this License, you may choose any version ever published by the Free Software
Foundation.

  10. If you wish to incorporate parts of the Program into other free
programs whose distribution conditions are different, write to the author
to ask for permission.  For software which is copyrighted by the Free
Software Foundation, write to the Free Software Foundation; we sometimes
make exceptions for this.  Our decision will be guided by the two goals
of preserving the free status of all derivatives of our free software and
of promoting the sharing and reuse of software generally.

			    NO WARRANTY

  11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW.  EXCEPT WHEN
OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.  THE ENTIRE RISK AS
TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU.  SHOULD THE
PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
REPAIR OR CORRECTION.

  12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
POSSIBILITY OF SUCH DAMAGES.

		     END OF TERMS AND CONDITIONS

	    How to Apply These Terms to Your New Programs

  If you develop a new program, and you want it to be of the greatest
possible use to the public, the best way to achieve this is to make it
free software which everyone can redistribute and change under these terms.

  To do so, attach the following notices to the program.  It is safest
to attach them to the start of each source file to most effectively
convey the exclusion of warranty; and each file should have at least
the "copyright" line and a pointer to where the full notice is found.

    <one line to give the program's name and a brief idea of what it does.>
    Copyright (C) <year>  <name of author>

    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation; either version 2 of the License, or
    (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License along
    with this program; if not, write to the Free Software Foundation, Inc.,
    51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.

Also add information on how to contact you by electronic and paper mail.

If the program is interactive, make it output a short notice like this
when it starts in an interactive mode:

    Gnomovision version 69, Copyright (C) year name of author
    Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
    This is free software, and you are welcome to redistribute it
    under certain conditions; type `show c' for details.

The hypothetical commands `show w' and `show c' should show the appropriate
parts of the General Public License.  Of course, the commands you use may
be called something other than `show w' and `show c'; they could even be
mouse-clicks or menu items--whatever suits your program.

You should also get your employer (if you work as a programmer) or your
school, if any, to sign a "copyright disclaimer" for the program, if
necessary.  Here is a sample; alter the names:

  Yoyodyne, Inc., hereby disclaims all copyright interest in the program
  `Gnomovision' (which makes passes at compilers) written by James Hacker.

  <signature of Ty Coon>, 1 April 1989
  Ty Coon, President of Vice

This General Public License does not permit incorporating your program into
proprietary programs.  If your program is a subroutine library, you may
consider it more useful to permit linking proprietary applications with the
library.  If this is what you want to do, use the GNU Lesser General
Public License instead of this License.

Quality checks

We run a couple of automated scans to help you assess a module’s quality. Each module is given a score based on how well the author has formatted their code and documentation and select modules are also checked for malware using VirusTotal.

Please note, the information below is for guidance only and neither of these methods should be considered an endorsement by Puppet.

Malware scan results

Scan Result

Passed

The malware detection service on Puppet Forge is an automated process that identifies known malware in module releases before they’re published. It is not intended to replace your own virus scanning solution.

Learn more about malware scans

Scan Detail

Module name:: puppetlabs-lvm
Module version:: 3.0.0
Scan initiated:: December 16th 2024, 7:14:10

Detections:

0 / 61

Scan stats:

61 undetected
0 harmless
0 failures
0 timeouts
0 malicious
0 suspicious
15 unsupported

Scan report:

View the detailed scan report

Modules

Discover

Contribute

Puppet

Premium features

Downloads

Resources

About Forge

Getting Started

lvm

Version information

This version is compatible with:

Tasks:

Plans:

Start using this module

Documentation

Puppet LVM Module

Usage Examples

Optional Values

Tasks

Plans

Limitations

Namespacing

Removing Physical Volumes

Resizing Logical Volumes

Deprecation Notice

License

Contributors

Reference

Table of Contents

Classes

Defined types

Resource types

Functions

Tasks

Plans

Classes

lvm

Parameters

package_ensure

manage_pkg

volume_groups

Defined types

lvm::logical_volume

Parameters

volume_group

size

initial_size

ensure

options

pass

dump

fs_type

mkfs_options

mountpath

mountpath_require

mounted

createfs

extents

stripes

stripesize

readahead

range

size_is_minsize

type

thinpool

poolmetadatasize

mirror

mirrorlog

no_sync

region_size

alloc

yes_flag

lvm::physical_volume

Parameters

ensure

force

unless_vg

lvm::volume

Examples

`lvm`

`package_ensure`

`manage_pkg`

`volume_groups`

`lvm::logical_volume`

`volume_group`

`size`

`initial_size`

`ensure`

`options`

`pass`

`dump`

`fs_type`

`mkfs_options`

`mountpath`

`mountpath_require`

`mounted`

`createfs`

`extents`

`stripes`

`stripesize`

`readahead`

`range`

`size_is_minsize`

`type`

`thinpool`

`poolmetadatasize`

`mirror`

`mirrorlog`

`no_sync`

`region_size`

`alloc`

`yes_flag`

`lvm::physical_volume`

`ensure`

`force`

`unless_vg`

`lvm::volume`

`ensure`

`fstype`

`pv`

`vg`

`size`

`extents`

`initial_size`

`lvm::volume_group`

`physical_volumes`

`createonly`

`ensure`

`logical_volumes`

`followsymlinks`

`filesystem`

`ensure`

`size`

`accounting`

`ag_size`

`agblksize`

`atboot`

`compress`

`device`

`encrypted`

`extended_attributes`

`frag`

`fs_type`

`initial_size`

`isnapshot`

`large_files`

`log_partitions`

`logname`

`logsize`

`maxext`

`mkfs_cmd`

`mount_options`

`mountgroup`

`mountguard`

`name`

`nbpi`

`nodename`

`options`

`perms`