Version information
Start using this module
Add this module to your Puppetfile:
mod 'bobtfish-ethtool', '0.0.6'
Learn more about managing modules with a PuppetfileDocumentation
####Table of Contents
- Overview
- Module Description - What the module does and why it is useful
- Setup - The basics of getting started with ethtool
- [What ethtool affects](#what-<%= metadata.name %>-affects)
- Setup requirements
- [Beginning with ethtool](#beginning-with-<%= metadata.name %>)
- Usage - Configuration options and additional functionality
- Limitations - OS compatibility, etc.
- Development - Guide for contributing to the module
##Overview
This module enables you to set settings on your ethernet interfaces using the ethtool command.
##Setup
You must turn pluginsync on to use this module as it is implemented as a custom type and provider
###What ethtool affects
-
This module will only call the ethtool utility, so will only affect settings on already configured network interfaces. It will not adjust the settings which interfaces are brought up with.
-
This can be DANGEROUS you can use this module to break the networking on your servers.
###Beginning with ethtool
ethtool { 'eth0': .. put options here .. }
Type Usage
Example usage with the most commonly used options:
ethtool { 'eth0': speed => '100', duplex => 'full', tso => 'disabled', autonegotiate_tx => 'disabled', autonegotiate_rx => 'disabled', }
Class Usage
You can use the puppet class to (optionally) install ethtool for your, and enforce ordering so that the ethtool type is only used after the ethtool package is available:
include ethtool
For when you don't want it to install ethtool for you:
class { 'ethtool': ensure_installed => false }
All supported properties
Note that not all interfaces support the querying or setting of all of these properties! Which settings and properties are available will depend on your ethernet card and driver!
speed
The speed of the interface: auto/10/100/1000. Note that not all speeds are supported on every interface
duplex
If duplex transmission should be enabled on the interface. Possible values are full half or auto.
tso
If TCP segment offload is enabled or disabled for this interface
lro
Specifies whether large receive offload should be enabled or disabled
ufo
Specifies whether UDP fragmentation offload should be enabled or disabled
gso
Specifies whether generic segmentation offload should be enabled
gro
Specifies whether generic receive offload should be enabled
sg
Specifies whether scatter_gather should be enabled
checksum_rx
Specifies whether RX checksumming should be enabled
checksum_tx
Specifies whether TX checksumming should be enabled
autonegotiate
If autonegotiation (PAUSE frames) are enabled or disabled
autonegotiate_tx
If autonegotiation is enabled or disabled for transmitting
autonegotiate_rx
If autonegotiation is enabled or disabled for receiving
ignore_unknown
This defaults to true. If your ethernet card doesn't appear to support a setting then we don't try to set it, which means that you can set the settings you want generally, but they'll be ignored on NICs which don't support those settings.
If you'd like puppet to try to set settings which can't be read anyway (and throw an error if this fails), then you can set this parameter to true.
##Limitations
Only works on Linux.
Currently only manages a subset of the whole ethtool functionality.
Doesn't support puppet resource querying of resource state.
Doesn't cache properties or use the flush interface, so makes one call to ethtool per property..
##Development
This module works for what it does, but will not fulfil everyone's needs.
Please feel free to patch and send pull requests
Types in this module release
2014-09-16 Release 0.0.6
- Fix facts to work if ethtool isn't installed
2014-08-13 Release 0.0.5
- Support 10G ethernet cards
- Fix issue #5, if your ethernet card dosn't support the requested operation, by default we won't try to perform it (avoiding errors). You can re-enable the previous behaviour by passing ignore_unknown => true to the type
- Add a fact for the maximum ethernet speed that each card supports
- Fix speed and duplex both in the same command, so that we don't take two runs to converge, fixing #8
2014-04-27 Release 0.0.4
- Tided up documentation and naming.
- MOVED THE GITHUB REPOSITORY to be consistently named.
2014-04-27 Release 0.0.3
- Added ethtool class to install ethtool
- Make the interface speed check not spit out errors when ethtool is not available
2014-04-08 Release 0.0.2
- First forge release
- Support a bunch of new options like speed and duplex
2014-02-18 Release 0.0.1
- initial version with Just TSO
Dependencies
- puppetlabs/stdlib (0.0.1)
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 [yyyy] [name of copyright owner] 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.