storcli
Version information
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, 2019.8.x
- Puppet >= 6.21.0 < 9.0.0
- , , , , , , ,
Start using this module
Add this module to your Puppetfile:
mod 'trunet-storcli', '1.1.0'Learn more about managing modules with a PuppetfileDocumentation
puppet-storcli
Puppet module to generate facts with types and providers to manage LSI MegaRAID controllers.
Table of Contents
- puppet-storcli
- [Table of Contents](#table-of-contents)
Description
This puppet module generate facts and provides types and providers to manage LSI MegaRAID controllers.
Setup
Setup Requirements
This module makes use of storcli. If running on a Dell server, the module will look to use perccli instead.
The package needs to be available from some repository to be installed.
Usage
include storcli
Optionally, to skip over configuration of the card.
storcli::configure_settings: false
Reference
Items not covered by puppet strings are provided below.
See REFERENCE for all other reference documentation.
Facts
- megaraid - structured fact
- present? - Boolean - check if
/sys/bus/pci/drivers/megaraid_sasis present? - storcli - String - location of
storcli/perccliapplication. - number_of_controllers - Integer - number of megaraid controllers found
- controllers - Hash[Controller number] - structured fact of megaraid controller informations
- product_name - String - Product name
- serial_number - String - Serial number
- fw_package_build - String - Firmware Package Build
- fw_version - String - Firmware Version
- bios_version - String - Controller BIOS Version
- virtual_drives - Hash - Drive settings per virtual drive
- Name - String - Name of Virtual Disk
- Type - String - Type of RAID
- State - String - State of Virtual Disk
- Strip Size - String - Strip Size of Virtual Disk
- Write Cache - String - Write Cache Mode of Virtual Disk
- Read Cache - String - Read Cache Mode of Virtual Disk
- IO Policy - String - IO Policy of Virtual Disk
- Physical Drive Cache - String - Physical Drive Cache Mode of Virtual Disk
- Encryption - String - Encryption Mode of Virtual Disk
- patrol_read - Hash - Patrol read information
- PR Mode - String - Mode
- PR Execution Delay - Integer - Execution delay in hours
- PR iterations completed - Integer - How many times patrol read ran?
- PR Next Start time - DateTime - Next time patrol read will run
- PR on SSD - Boolean - Run on SSDs?
- PR Current State - String - Is it running or stopped?
- PR Excluded VDs - String - VDs that will not run patrol read
- PR MaxConcurrentPd - Integer - Maximum number of concurrent PDs
- consistency_check - Hash - Consistency check information
- CC Operation Mode - String - Mode
- CC Execution Delay - Integer - Execution delay in hours
- CC Next Starttime - DateTime - Next time patrol read will run
- CC Current State - String - Is it running or stopped?
- CC Number of iterations - Integer - How many times patrol read ran?
- CC Number of VD completed - Integer - Number of VDs completed
- CC Excluded VDs - String - VDs that will not run patrol read
- present? - Boolean - check if
Limitations
For now, this module only provides a custom fact and ways to deal with patrol read and consistency check.
This module does not provide the storcli or perccli packages, you must do that yourself. If the package provider can load them, they will be installed automatically.
The card configuration has not been tested on systems with multiple MegaRAID cards. It should work, but it will set all cards to identical values.
Minimum storcli/perccli versions:
PercCli SAS Customization Utility Ver 007.2313.0000.0000 Mar 07, 2023
StorCli SAS Customization Utility Ver 007.2508.0000.0000 Feb 27, 2023
Older versions may work, but may not...
Development
Contributions are welcome through pull requests. I will only accept PRs with tests covering the parts of the code you touched.
Before sending the PR, run the tests and regenerate puppet strings references:
# pdk validate
# pdk test unit
# pdk bundle exec puppet strings generate --format markdown --out REFERENCE.md
Reference
Table of Contents
Classes
Public Classes
storcli: storcli Main class, include all other classes.storcli::configure: Make any controller settings active
Private Classes
storcli::install: This class handles storcli packages and binary link.
Classes
storcli
storcli
Main class, include all other classes.
Parameters
The following parameters are available in the storcli class:
package_managepackage_namepackage_ensurelink_storcli_toconfigure_settingscontroller_manage_rebuildcontroller_autorebuildcontroller_rebuildratesync_time_to_controllerscontroller_use_utccontroller_perfmodecontroller_ncqcontroller_cacheflushintervalcontroller_bootwithpinnedcachecontroller_manage_alarmcontroller_alarmcontroller_smartpollintervalcontroller_patrolread_modecontroller_patrolread_delaycontroller_patrolread_ratecontroller_patrolread_includessdscontroller_patrolread_uncfgareascontroller_consistencycheck_modecontroller_consistencycheck_delaycontroller_consistencycheck_rate
package_manage
Data type: Variant[Boolean, Enum['true', 'false']]
Whether to manage the storcli package. Default value: value of megaraid['present?'].
package_name
Data type: Array[String]
Specifies the storcli package to manage. Default value: ['storcli'].
package_ensure
Data type: String
Whether to install the storcli package, and what version to install. Values: 'present', 'latest', or a specific version number. Default value: 'present'.
link_storcli_to
Data type: Stdlib::Absolutepath
The official package puts the binary into /opt/MegaRAID/storcli which isn't usually in $PATH.
This module will put a link into another location so the binary is easily found.
Default value: /usr/local/sbin
configure_settings
Data type: Boolean
Should this class be able to enforce configuration settings on the controllers? If you've got multiple controllers which should have different configs, you'll want to set this to false. Default value: true
controller_manage_rebuild
Data type: Boolean
Should this class manage how the controller automatically rebuilds arrays Default value: true
controller_autorebuild
Data type: Boolean
Should this controller automatically rebuild arrays Default value: true
controller_rebuildrate
Data type: Integer[0, 100]
Percentage of IO to dedicate to rebuilding an array Default value: 60
sync_time_to_controllers
Data type: Boolean
Should controller clock be synced with the system clock? Default value: true
controller_use_utc
Data type: Boolean
Should controller clock use UTC? Default value: true
controller_perfmode
Data type: Integer[0]
Prioritize IOPS(0) or low latency(1) Set as an integer should new modes be added Default value: 0
controller_ncq
Data type: Boolean
Should Native Command Queue be enabled? Default value: true
controller_cacheflushinterval
Data type: Integer[1]
Time in seconds between cache flushes Default value: 4
controller_bootwithpinnedcache
Data type: Boolean
Continue booting with data stuck in cache? Default value: false
controller_manage_alarm
Data type: Boolean
Should this class manage the alarm on the controller Set to false if storcli cannot manage the alarm on a particular controller Default value: true
controller_alarm
Data type: Boolean
Sound alarm when a disk is bad? Datacenters with lots of hosts and noise may want to disable this. Default value: true
controller_smartpollinterval
Data type: Integer[0, 65535]
Time in seconds between polling drive SMART errors (0-65535) Default value: 60
controller_patrolread_mode
Data type: Enum['auto', 'manual', 'off']
Run patrolread either, auto, manual, or off Default value: auto
controller_patrolread_delay
Data type: Integer[0]
Set the patrolread delay to this many hours Default value: 336
controller_patrolread_rate
Data type: Integer[0, 100]
Set the patrolread IO percentage Default value: 30
controller_patrolread_includessds
Data type: Boolean
Should we patrol SSD devices Default value: false
controller_patrolread_uncfgareas
Data type: Boolean
Should we patrol unconfigured areas Default value: false
controller_consistencycheck_mode
Data type: Enum['off', 'seq', 'conc']
One of off, seq, conc Default value: conc
controller_consistencycheck_delay
Data type: Integer[0]
Set the consistencycheck delay to this many hours Default value: 672
controller_consistencycheck_rate
Data type: Integer[0, 100]
Set the consistencycheck IO percentage Default value: 30
storcli::configure
Configure the storage controllers with the specified settings
Parameters
The following parameters are available in the storcli::configure class:
configure_settingscontroller_manage_rebuildcontroller_autorebuildcontroller_rebuildratesync_time_to_controllerscontroller_use_utccontroller_perfmodecontroller_ncqcontroller_cacheflushintervalcontroller_bootwithpinnedcachecontroller_manage_alarmcontroller_alarmcontroller_smartpollintervalcontroller_patrolread_modecontroller_patrolread_delaycontroller_patrolread_ratecontroller_patrolread_includessdscontroller_patrolread_uncfgareascontroller_consistencycheck_modecontroller_consistencycheck_delaycontroller_consistencycheck_rate
configure_settings
Data type: Any
Should this class be able to enforce configuration settings on the controllers? If you've got multiple controllers which should have different configs, you'll want to set this to false. Default value: true
Default value: $storcli::configure_settings
controller_manage_rebuild
Data type: Any
Should this class manage how the controller automatically rebuilds arrays Default value: true
Default value: $storcli::controller_manage_rebuild
controller_autorebuild
Data type: Any
Should this controller automatically rebuild arrays Default value: true
Default value: $storcli::controller_autorebuild
controller_rebuildrate
Data type: Any
Percentage of IO to dedicate to rebuilding an array Default value: 60
Default value: $storcli::controller_rebuildrate
sync_time_to_controllers
Data type: Any
Should controller clock be synced with the system clock? Default value: true
Default value: $storcli::sync_time_to_controllers
controller_use_utc
Data type: Any
Should controller clock use UTC? Default value: true
Default value: $storcli::controller_use_utc
controller_perfmode
Data type: Any
Prioritize IOPS(0) or low latency(1) Set as an integer should new modes be added Default value: 0
Default value: $storcli::controller_perfmode
controller_ncq
Data type: Any
Should Native Command Queue be enabled? Default value: true
Default value: $storcli::controller_ncq
controller_cacheflushinterval
Data type: Any
Time in seconds between cache flushes Default value: 4
Default value: $storcli::controller_cacheflushinterval
controller_bootwithpinnedcache
Data type: Any
Continue booting with data stuck in cache? Default value: false
Default value: $storcli::controller_bootwithpinnedcache
controller_manage_alarm
Data type: Any
Should this class manage the alarm on the controller Set to false if storcli cannot manage the alarm on a particular controller Default value: true
Default value: $storcli::controller_manage_alarm
controller_alarm
Data type: Any
Sound alarm when a disk is bad? Datacenters with lots of hosts and noise may want to disable this. Default value: true
Default value: $storcli::controller_alarm
controller_smartpollinterval
Data type: Any
Time in seconds between polling drive SMART errors (0-65535) Default value: 60
Default value: $storcli::controller_smartpollinterval
controller_patrolread_mode
Data type: Any
Run patrolread either, auto, manual, or off Default value: auto
Default value: $storcli::controller_patrolread_mode
controller_patrolread_delay
Data type: Any
Set the patrolread delay to this many hours Default value: 336
Default value: $storcli::controller_patrolread_delay
controller_patrolread_rate
Data type: Any
Set the patrolread IO percentage Default value: 30
Default value: $storcli::controller_patrolread_rate
controller_patrolread_includessds
Data type: Any
Should we patrol SSD devices Default value: false
Default value: $storcli::controller_patrolread_includessds
controller_patrolread_uncfgareas
Data type: Any
Should we patrol unconfigured areas Default value: false
Default value: $storcli::controller_patrolread_uncfgareas
controller_consistencycheck_mode
Data type: Any
One of off, seq, conc Default value: conc
Default value: $storcli::controller_consistencycheck_mode
controller_consistencycheck_delay
Data type: Any
Set the consistencycheck delay to this many hours Default value: 672
Default value: $storcli::controller_consistencycheck_delay
controller_consistencycheck_rate
Data type: Any
Set the consistencycheck IO percentage Default value: 30
Default value: $storcli::controller_consistencycheck_rate
Changelog
All notable changes to this project will be documented in this file.
Release 1.1.0
Features
- Extend fact to report information about virtual drives per controller
- Note puppet8 support
Bugfixes
- Try to fix autodetection on Dell systems
Release 1.0.0
BREAKING CHANGE
- The parameter
link_storcli_tois now the full path for the created link
Features
- Correctly detect package name for Dell systems (perccli)
- Note minimum required utility versions
Bugfixes
- Graceful failure when card unsupported
Release 0.4.5
Features
- Note compatibility with stdlib 9.x.x
Release 0.4.4
Features
- Now using
nologmode forstorclicommands
Release 0.4.3
Bugfixes
- Fix a few typos for service detection
- Ignore alarm on cards without alarms
Release 0.4.2
Bugfixes
- Fix missing chdir making storcli.log files in cwd
Release 0.4.1
Bugfixes
- Smarter check for the "
usr/sbin" link
Release 0.4.0
Features
- Support for mpt3sas cards
Bugfixes
- Avoid setting unsupported parameters
Release 0.3.2
Features
- attempt to use perccli on Dell servers
- Booleans for
controller_manage_rebuildandcontroller_manage_alarm
Release 0.3.1
Bugfixes
- storcli on an EFI host doesn't support JSON mode (for some reason)
Release 0.3.0
Features
- Add ability to set configuration on card
Release 0.2.2
Features
- Updated pdk to 2.4.0
- Package is only installed by default on hosts with card detected
- Binary linked into "/usr/local/sbin" is determined from facts
Release 0.2.1
Features
- Updated pdk to 1.18
Security
- CVE-2020-10663
Release 0.2.0
Features
- Add storcli to PATH
- Updated pdk to 1.15.0
Bugfixes
- Bump excon from 0.69.1 to 0.71.0 (#1)
Release 0.1.1
Features
- Convert megaraid.controllers to a HASH
Release 0.1.0
Features
- Initial version
Bugfixes
Known Issues
Dependencies
- puppetlabs/stdlib (>= 5.0.0 < 10.0.0)
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
1. Definitions.
"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.
"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.
"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.
"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.
"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.
"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.
"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).
"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.
"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."
"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.
2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.
3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.
4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:
(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and
(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and
(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and
(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.
You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.
5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.
6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.
7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.
8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.
9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.
END OF TERMS AND CONDITIONS
APPENDIX: How to apply the Apache License to your work.
To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.
Copyright 2019 Wagner Sartori Junior <wsartori@wsartori.com>
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.