Version information
Start using this module
Add this module to your Puppetfile:
mod 'fatmcgav-netapp', '0.5.0'
Learn more about managing modules with a PuppetfileDocumentation
NetApp network device module
N.B. Please note that this module is no longer being maintained.
For the supported version, please see the Puppetlabs-NetApp
Table of Contents
Overview
The NetApp network device module is designed to add support for managing NetApp filer configuration using Puppet and its Network Device functionality.
The Netapp network device module has been written and tested against NetApp ONTAP 8.0.4 7-mode and NetApp ONTAP 8.2 C-Mode However it may well be compatible with other ONTAP versions.
Features
The following items are supported:
- Creation, modification and deletion of volumes, including auto-increment, snapshot schedules and volume options.
- Creation, modification and deletion of QTrees.
- Creation, modification and deletion of NFS Exports, including NFS export security.
- Creation, modification and deletion of users, groups and roles.
- Creation, modification and deletion of Quotas.
- Creation of snapmirror relationships.
- Creation of snapmirror schedules.
Requirements
Since we can not directly install a puppet agent on the NetApp filers, it can either be managed from the Puppet Master server, or through an intermediate proxy system running a puppet agent. The requirement for the proxy system:
- Puppet 2.7.+
- NetApp Manageability SDK Ruby libraries
NetApp Manageability SDK
The NetApp Ruby libraries are contained within the NetApp Manageability SDK, currently at v5.0, which is available to download directly from NetApp. Please note you need a NetApp NOW account in order to be able to download the SDK.
Once you have downloaded and extracted the SDK, the following files need to be copied onto your Puppet Master:
../lib/ruby/NetApp > [module dir]/netapp/lib/puppet/util/network_device/netapp/
Once the files have been copied into place on your Puppet Master, a patch needs to be applied to NaServer.rb and NaElement.rb.
The patches can be found under the files
directory.
To apply, change into the netapp
module root directory and run:
patch lib/puppet/util/network_device/netapp/NaServer.rb < files/NaServer.patch
patch lib/puppet/util/network_device/netapp/NaElement.rb < files/NaElement.patch
This should apply the patch without any errors, as below:
$ patch lib/puppet/util/network_device/netapp/NaServer.rb < files/NaServer.patch
patching file lib/puppet/util/network_device/netapp/NaServer.rb
$ patch lib/puppet/util/network_device/netapp/NaElement.rb < files/NaElement.patch
patching file lib/puppet/util/network_device/netapp/NaElement.rb
$
Usage
Device Setup
In order to configure a NetApp network device, the device type should be netapp
.
You can either configure the device within /etc/puppet/device.conf or, preferrably, create an individual config file for each device within a subfolder.
This is preferred as it allows you to run puppet against individual devices, rather than all devices configured...
In order to run puppet against a single device, you can use the following command:
puppet device --deviceconfig /etc/puppet/device/[device].conf
Example configuration /etc/puppet/device/pfiler01.example.com.conf
:
[pfiler01.example.com]
type netapp
url https://root:secret@pfiler01.example.com
You can also specify a virtual filer or vserver you want to operate on: Simply
provide the connection information for your physical filer and specify
an optional path that represents the name of your virtual filer. Example
configuration /etc/puppet/device/vfiler01.example.com.conf
:
[vfiler01.example.com]
type netapp
url https://root:secret@pfiler01.example.com/vfiler01
NetApp operations
As part of this module, there is a defined type called 'netapp::vqe', which can be used to create a volume, add a qtree and create an NFS export. An example of this is:
netapp::vqe { 'volume_name':
ensure => present,
size => '1t',
aggr => 'aggr2',
spaceres => 'volume',
snapresv => 20,
autoincrement => true,
persistent => true
}
This will create a NetApp volume called v_volume_name
with a qtree called q_volume_name
.
The volume will have an initial size of 1 Terabyte in Aggregate aggr2.
The space reservation mode will be set to volume, and snapshot space reserve will be set to 20%.
The volume will be able to auto increment, and the NFS export will be persistent.
You can also use any of the types individually, or create new defined types as required.
Type/Provider Support
This module supports both NetApp filers operating in both 7-Mode and Cluster-Mode. The table below outlines what modes are supported by what types/providers.
Resource | 7-Mode supported | CMode supported |
---|---|---|
netapp_aggregate | No | Yes |
netapp_cluster_id | No | Yes |
netapp_cluster_peer | No | Yes |
netapp_export_policy | No | Yes |
netapp_group | Yes | No |
netapp_igroup | No | Yes |
netapp_license | No | Yes |
netapp_lif | No | Yes |
netapp_lun | No | Yes |
netapp_lun_map | No | Yes |
netapp_nfs_export | Yes | No |
netapp_notify | Yes | Yes |
netapp_qtree | Yes | Yes |
netapp_quota | Yes | Yes |
netapp_role | Yes | No |
netapp_snapmirror | Yes | Yes |
netapp_user | Yes | No |
netapp_volume | Yes | Yes |
netapp_vserver | No | Yes |
netapp_vserver_option | No | Yes |
Contributors
Thanks to the following people who have helped with this module:
- Stefan Schulte
TODO
The following items are yet to be implemented:
- Data Fabric Manager support
- Support adding/deleting/modifying cifs shares
- LDAP and/or AD configuration
- ???
Development
The following section applies to developers of this module only.
Testing
You will need to install the NetApp Manageability SDK Ruby libraries for most of the tests to work. How to obtain these files is detailed in the NetApp Manageability SDK section above.
Types in this module release
0.5.0 2015-09-14 Gavin Williams fatmcgav@gmail.com Module deprecated. Supported module is puppetlabs/netapp
0.4.0 2013-09-30 Gavin Williams fatmcgav@gmail.com Feature release incorporating multiple changes. Many thanks to Stefan Schulte for a large amount of the changes. Noteworthy changes:
- (#41) Added the netapp_quota type/provider.
- (#43) Remove the need for a special configuration file - Instead get username and password from connection string.
- Simplify calling of netapp commands by using netapp_commands function.
- Loads more tests, with some new integration/unit tests.
- Various types will auto-require any appropriate resources that they should depend on. E.g. Netapp_export will auto-require the appropriate netapp_volume or netapp_qtree. Netapp_user will auto-require the appropriate netapp_group.
- Some improvements to facts being returned.
0.3.0 2013-04-09 Gavin Williams fatmcgav@gmail.com Feature release incorporating 2 enhancements.
- (#18) Improved device facts Now gives more meaningful fact data.
- (#20) Convert to Prefetch/Flush style providers.
Large performance improvement by converting to a prefetch/flush model for providers.
Also improved Readme, and correct various typos and incorrect code comments.
0.2.4 2013-03-28 Gavin Williams fatmcgav@gmail.com
- (#27) Updated netapp_volume autoincrement= to convert volume size into MB before calculating autoincrement sizes.
0.2.3 2013-03-22 Gavin Williams fatmcgav@gmail.com
- (#13) Updated Netapp_volume to adjust the auto-increment settings when resizing a volume.
0.2.2 2013-03-15 Gavin Williams fatmcgav@gmail.com
- (#24) Updated Netapp_export provider to fix a destroy bug.
0.2.1 2013-03-07 Gavin Williams fatmcgav@gmail.com
- (#22) Updated Netapp_Export type to not default :path to :name, as causes OnTap API call to fail.
0.2.0 2013-03-06 Gavin Williams fatmcgav@gmail.com
- (#19) Fix Netapp_qtree handling of missing volume.
- (#12) Add support for NetApp NFS export security.
0.1.2 2013-02-06 Gavin Williams fatmcgav@gmail.com
- (#14) Fix Snapschedule bug with which-days and nil versus 0
0.1.1 2013-01-30 Gavin Williams fatmcgav@gmail.com
- (#9) Updated netapp_user, netapp_group and netapp_role name input validation to support '-'.
- (#10) Updated netapp_volume type/provider to fix snapschedule property bug.
0.1.0 2013-01-12 Gavin Williams fatmcgav@gmail.com
- Initial release.
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.