NetApp PowerShell Toolkit 101: Getting Started

The NetApp PowerShell Toolkit (NPTK) is a great way to get started administering your NetApp resources, both 7-mode and clustered Data ONTAP (cDOT), in a more efficient and scalable manner.

Getting the Toolkit

The download (version 3.2 at the time of this writing) is available from the NetApp Communities in the Microsoft Cloud and Virtualization board.

From the download page are two links to some great resources: the Getting Started presentation, and Making the Most of the NetApp PowerShell Toolkit. Both of these are excellent reads if you want some starting hints.

Getting Help

  • The NetApp Communities: The communities are a great place to get help quickly for any question you might have. I recommend that you use the Microsoft Cloud and Virtualization Discussions board, however the SDK and API board will infrequently have questions as well.You can also send me a message using the NetApp Communities. My username is asulliva, and I’m happy to respond to questions directly through the Communities messaging system.
  • From the NPTK itself: One of the less known features of the Toolkit is that it has help built in. Yes, you can use the standard Get-Help cmdlet, but there’s a hidden treasure: Show-NcHelp.This cmdlet will generate an HTML version of the cmdlet help and open your default browser to display it.

    2015-02-13 18_52_42-

    From here you can dig through the cmdlets and view all of the information you want to know about them quickly and easily.

A Few Basics To Get Started

Now that you have the toolkit and have installed it, it’s time to use it. Let’s look at a couple of basic tasks.

Note: I will be using the cDOT cmdlets, however nearly all of the commands have an equivalent available for 7-mode.

Connecting to a controller
Connecting to your cluster is extremely easy. You can specify the cluster management IP address, or any of the node management IPs as well. If you do not provide credentials as a part of the command invocation, it will prompt for them.

Getting Information
Now that we’re connected to the cluster, let’s take a look at some of the information that can be gathered:

Onward to Automation

There are a number of “PowerShell Toolkit 101” posts that introduce some of the possibilities. Be sure to read through these other posts:

This doesn’t even begin to scratch the surface of the NetApp PowerShell Toolkit. Anything that can be done from the command line can be done using the toolkit. If you’re interested in seeing specific examples, need help, or just have questions, please let me know in the comments!

4 thoughts on “NetApp PowerShell Toolkit 101: Getting Started”

  1. am using csv import as data sources for LIFs , SVMs volumes at moment , but tieing them into one script to build a svm , with correct lifs , snapmirrors in place if needed , root vol protection , what would you use if you had to create , lots of config , any tips would be great ,

    • Hi Mark,

      Thanks for reading!

      I tend to favor XML for describing configuration, it’s easy to read and modify by hand if needed, and the PowerShell cmdlets for XML are really easy to use. That being said, use whatever you’re most comfortable with. If CSVs are getting the job done, then there’s nothing that says you can’t continue to use them.


  2. Hi, I am just starting to have fun trying to complete all my work for Netapp via the toolkit and wondered what is the closest way to show the below performance counters for Clustermode:
    qos statistics volume performance show
    qos statistics volume characteristics show
    qos statistics volume latency show
    qos statistics volume resource cpu show
    qos statistics volume resource disk show

    Is Invoke-NcSysstat and its parameters the closest to getting the above readings.
    Thanks for your time

    • Hi Tony,

      Thanks for reading!

      Unfortunately, the qos statistics set of CLI commands do not have an API equivalent. The easiest way to get the data is going to be using the Invoke-NcSsh cmdlet, particularly if you’re going to capture the output to send it in an email report or something similar since it will have the CLI formatting.

      SysStat is going to have a lot of extra information to dig through to find what you want. You can also query the information from the perf API looking at the workload category of counters.

      Hope that helps.



Leave a Reply