NetAppDocs-Lite PowerShell Module

Overview

This PowerShell module provides a set of functions that automates NetApp site design documentation. It can output both Microsoft Word and Microsoft Excel files. The data contained in the output files can be sanitized for use in sites where the data may be sensitive.


Getting Started

Once the module is installed to an appropriate location you only need to begin a script or PowerShell session with:

PS C:\> Import-Module -Name NetAppDocs-Lite

To learn about which functions are available, try 'Show-NtapDocsHelp' after importing the module. Also, full help with examples is available for every cmdlet using PowerShell's built-in 'Get-Help' cmdlet.


System Requirements

  • Windows:
    • Windows PowerShell 5.1 (with Microsoft .NET Framework 4.7.2+) and PowerShell 7.0.3+
  • MAC/Linux:
    • PowerShell 7.0.3+
  • ONTAP: NetApp.ONTAP PowerShell module (included in the install package).

PowerShell Execution Policy (Windows-Only)

The PowerShell execution policy must be set to anything other than the default setting of 'Restricted', as this setting does not allow scripts to run. The files within this module are digitally signed and will run whether the policy is set to 'Unrestricted', 'RemoteSigned' or 'AllSigned'. To do this, right click on PowerShell and select 'Run as Administrator'. Then run the following command:

PS C:\> Set-ExecutionPolicy -ExecutionPolicy RemoteSigned

Install Guide

The installation scripts contained within the ZIP file are the preferred method for installing this module on all platforms. This uses native PowerShell commands to install the module to the appropriate user location and does not require administrative rights. You can also copy the module folder manually using this same ZIP file.

Please see the NetAppDocs User Guide for additional installation information.

Windows

If a previous version of the module was installed via the Windows Installer (MSI) package, it is recommended to remove all previous versions using the 'Apps & features' or the 'Add or remove programs' application in the System Settings area.

To install the module, unzip the contents of the ZIP file to a temp folder and run the .BAT script to automate the installation.

MAC/Linux

MAC and Linux clients require the installation of Microsoft PowerShell. Unzip the contents of the ZIP file to a temp folder and run the .SH script to automate the installation. Prior to running the .SH script it will need to be set as executable by using the following command:

chmod +x mac_linux-install.sh

Uninstall Guide

If the installation script within the ZIP file was used, you can use the Uninstall-Module cmdlet to remove the module. If the ZIP file was used to manually copy the files, you can manually delete the folder.


Statistics Tracking

By default, NetAppDocs will submit statistics back to a database in order for us to track usage and to help drive future development efforts. No user information is collected. The following table lists the properties that are sent back to the database.

Module/Function Info Client Details Target Details Output Details
ModuleName MachineGuid SystemUid BaseTypeName
ModuleVersion Platform SystemType DataSetName
ModuleSessionGuid Version SystemVersion
PipelineSessionGuid Architecture
CallingFunctionName Caption
FunctionName PowerShellVersion
CallDate CountryCode
ElapsedTicks
PipelinePosition
PipelineLength
ParameterNames
ParameterValues

While we request that you leave the statistics uploading enabled to help us with future development, if you do need to disable this functionality you may do so by setting a variable within the PowerShell session. To make this permanent you can add this variable into your PowerShell profile.

PS> Set-Variable -Name NetAppDocs_SkipStatsUpload -Value 1 -Scope Global

Update Notifications

As of NetAppDocs v4.1.0, you will now be notified to check for the latest updates every 14 days. This check queries the update server for both new module versions as well as any updated module and/or resource files. To disable this notification, you can set a variable within the PowerShell session. And, just like with the statistics variable above, adding this line to your PowerShell profile will disable the notification permanently.

PS> Set-Variable -Name NetAppDocs_DisableUpdateNotification -Value 1 -Scope Global

Additional Information

Usage examples and other additional information can be found in the webhelp folder of the module, or by typing 'Show-NtapDocsHelp' within PowerShell after importing the module. The NetAppDocs User Guide is also available on the NetApp Tools Download Site or the NetAppDocs Community Site.