diff --git a/Install/Archive/v1.5/.DS_Store b/Install/Archive/v1.5/.DS_Store new file mode 100644 index 0000000..3e46375 Binary files /dev/null and b/Install/Archive/v1.5/.DS_Store differ diff --git a/Install/NetApp_SolidFire_PowerShell_Tools _v1.5_Release_Notes.pdf b/Install/Archive/v1.5/NetApp_SolidFire_PowerShell_Tools _v1.5_Release_Notes.pdf similarity index 100% rename from Install/NetApp_SolidFire_PowerShell_Tools _v1.5_Release_Notes.pdf rename to Install/Archive/v1.5/NetApp_SolidFire_PowerShell_Tools _v1.5_Release_Notes.pdf diff --git a/Install/NetApp_SolidFire_PowerShell_Tools_v1.5_User_Guide.pdf b/Install/Archive/v1.5/NetApp_SolidFire_PowerShell_Tools_v1.5_User_Guide.pdf similarity index 100% rename from Install/NetApp_SolidFire_PowerShell_Tools_v1.5_User_Guide.pdf rename to Install/Archive/v1.5/NetApp_SolidFire_PowerShell_Tools_v1.5_User_Guide.pdf diff --git a/Install/NetApp_SolidFire_PowerShell_Tools_v1.5.1_Release_Notes.pdf b/Install/NetApp_SolidFire_PowerShell_Tools_v1.5.1_Release_Notes.pdf new file mode 100644 index 0000000..3915aef Binary files /dev/null and b/Install/NetApp_SolidFire_PowerShell_Tools_v1.5.1_Release_Notes.pdf differ diff --git a/Install/NetApp_SolidFire_PowerShell_Tools_v1.5.1_User_Guide.pdf b/Install/NetApp_SolidFire_PowerShell_Tools_v1.5.1_User_Guide.pdf new file mode 100644 index 0000000..1704aa1 Binary files /dev/null and b/Install/NetApp_SolidFire_PowerShell_Tools_v1.5.1_User_Guide.pdf differ diff --git a/README.md b/README.md index f7000d6..98cbbe7 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ -# SolidFire PowerShell Tools +# NetApp SolidFire PowerShell Tools -### Version 1.5 +### Version 1.5.1 ![logo](Install/product.png) @@ -12,12 +12,6 @@ Any user with a SolidFire storage system and Windows PowerShell can take advanta ## Installation -The **preferred** way to install SolidFire PowerShell Tools is to download it from [PowerShell Gallery](powershellgallery.com) with the following command: - - PS> Install-Module -Name SolidFire - -**-- or --** - The SolidFire Powershell Module can be installed directly on multiple systems by following these instructions: | System | Installation | @@ -29,6 +23,6 @@ The SolidFire Powershell Module can be installed directly on multiple systems by ## Release Notes -[Click here to download latest release notes](https://github.com/solidfire/PowerShell/blob/master/Install/NetApp_SolidFire_PowerShell_Tools%20_v1.5_Release_Notes.pdf) +[Click here to download latest release notes](Install/NetApp_SolidFire_PowerShell_Tools_v1.5.1_Release_Notes.pdf) -User guides are available for each system in the installation instruction pages. +[Click here to download User Guide Doc](Install/NetApp_SolidFire_PowerShell_Tools_v1.5.1_User_Guide.pdf) diff --git a/docs/docker/README.md b/docs/docker/README.md index 36672a9..8a8d097 100644 --- a/docs/docker/README.md +++ b/docs/docker/README.md @@ -1,8 +1,8 @@ -# To install SolidFire Powershell as Docker container: +# To install NetApp SolidFire Powershell as Docker container: ![solidfire-powershell-logo](../../Install/product.png) ![docker-logo](docker-logo-small.png) -### Prerequisite: +##### Prerequisite: You must have Docker engine installed and running on your host machine. [Install the latest docker engine](https://www.docker.com/products/overview) @@ -10,17 +10,17 @@ You must have Docker engine installed and running on your host machine. [Instal Using a terminal, pull and run the latest SolidFire PowerShell image from our public Docker repo with this command: - docker run -it -v $(pwd):/scripts --rm netapp/solidfire-powershell + docker run -it netapp/solidfire-powershell -This will download that SolidFire Docker image, start a new container, and enter it in a bash shell from your terminal. Once there, run the command: +Or, run it with a mounted volume so you can access local scripts. - powershell + docker run -it -v $(pwd):/scripts netapp/solidfire-powershell -Then you will be in a PowerShell shell with the SolidFire module loaded and ready. +This will download that SolidFire Docker image, start a new container, and open a PowerShell shell from your terminal with the SolidFire module loaded and ready. **NOTE:** Any scripts in your host's pwd* will be available at `/scripts` once you are in the PowerShell shell. -*Present Working Directory +*`Present Working Directory` **ProTip:** You can change the mounted directory for `/scripts` by modifying the left side of the ':'. Use " " when a space exists in the path. diff --git a/docs/linux/README.md b/docs/linux/README.md index 925a830..27156a7 100644 --- a/docs/linux/README.md +++ b/docs/linux/README.md @@ -1 +1,42 @@ -# Install SolidFire PowerShell on Linux ![solidfire-powershell-logo](../../Install/product.png) ![linux-logo](linux-logo-small.png) The commands should be run in a terminal session on the machine you want to install on. You don't have to be in a specific directory to execute any of these commands. You will need sudo access. ## Uninstall Old Version of SolidFire If you previously installed SolidFire 1.4, you should uninstall it before installing SolidFire 1.5. 1. Remove the old SolidFire module files: $ sudo rm -rf /usr/local/share/powershell/Modules/SolidFire 1. If you created a PowerShell profile file to initialize the SolidFire module on PowerShell startup, remove that file : $ sudo rm /opt/microsoft/powershell/6.0.0-beta.2/profile.ps1 1. If you will be upgrading to the latest PowerShell, you can also remove the directory where that profile file was located: $ sudo rm -rf /opt/microsoft/powershell/6.0.0-beta.2 ## Install or Upgrade PowerShell bits Follow the detailed instructions on the [PowerShell for Linux installation page](https://github.com/PowerShell/PowerShell/blob/master/docs/installation/linux.md). ## Install SolidFire bits 1. Start a PowerShell shell: $ pwsh 1. Inside the PowerShell shell, install SolidFire PowerShell Tools by downloading it from the [PowerShell Gallery](powershellgallery.com) with the following command: PS> Install-Module -Name SolidFire.Linux 1. Then, import the SolidFire module with the following command: PS> Import-Module SolidFire.Linux 1. To see a list of available commands, use: PS> Get-Command -Module SolidFire.Linux ## Paths * `$PSHOME` is `/opt/microsoft/powershell/[version]/` * User profiles will be read from `~/.config/powershell/profile.ps1` * Default profiles will be read from `$PSHOME/profile.ps1` * User modules will be read from `~/.local/share/powershell/Modules` * Shared modules will be read from `/usr/local/share/powershell/Modules` * Default modules will be read from `$PSHOME/Modules` * PSReadLine history will be recorded to `~/.local/share/powershell/PSReadLine/ConsoleHost_history.txt` The profiles respect PowerShell's per-host configuration, so the default host-specific profiles exists at `Microsoft.PowerShell_profile.ps1` in the same locations. On Linux and macOS, the [XDG Base Directory Specification][xdg-bds] is respected. [xdg-bds]: https://specifications.freedesktop.org/basedir-spec/basedir-spec-latest.html \ No newline at end of file +# Install NetApp SolidFire PowerShell Tools on Linux + +![solidfire-powershell-logo](../../Install/product.png) ![linux-logo](linux-logo-small.png) + +The commands should be run in a terminal session on the machine you want to install on. You don't have to be in a specific directory to execute any of these commands. You will need sudo access. + +## First, Install PowerShell bits + +Follow the detailed instructions on the [PowerShell for Linux installation page](https://github.com/PowerShell/PowerShell/blob/master/docs/installation/linux.md). + +## Next, Install SolidFire bits + +1. Once inside the PowerShell shell, install SolidFire PowerShell Tools for dotnet core by downloading it from the [PowerShell Gallery](powershellgallery.com) with the following command: + + PS> Install-Module -Name SolidFire.Core + +1. Then, import the SolidFire module with the following command: + + PS> Import-Module SolidFire.Core + +1. To see a list of available commands, use: + + PS> Get-Command -Module SolidFire.Core + +**NOTE:** This module used to be called `SolidFire.Linux`. That name has been deprecated and it is now `SolidFire.Core` + +## Paths + +* `$PSHOME` is `/opt/microsoft/powershell/[version]/` +* User profiles will be read from `~/.config/powershell/profile.ps1` +* Default profiles will be read from `$PSHOME/profile.ps1` +* User modules will be read from `~/.local/share/powershell/Modules` +* Shared modules will be read from `/usr/local/share/powershell/Modules` +* Default modules will be read from `$PSHOME/Modules` +* PSReadLine history will be recorded to `~/.local/share/powershell/PSReadLine/ConsoleHost_history.txt` + +The profiles respect PowerShell's per-host configuration, +so the default host-specific profiles exists at `Microsoft.PowerShell_profile.ps1` in the same locations. + +On Linux and macOS, the [XDG Base Directory Specification][xdg-bds] is respected. + +[xdg-bds]: https://specifications.freedesktop.org/basedir-spec/basedir-spec-latest.html diff --git a/docs/mac/README.md b/docs/mac/README.md index d861f3e..e29c150 100644 --- a/docs/mac/README.md +++ b/docs/mac/README.md @@ -1,4 +1,4 @@ -# Install SolidFire PowerShell on Mac OS 10.11 +# Install NetApp SolidFire PowerShell Tools on Mac OS ![solidfire-powershell-logo](../../Install/product.png) ![apple-logo](apple-logo-small.png) @@ -12,17 +12,17 @@ Follow the detailed instructions on the [PowerShell for Mac installation page](h ### Next, Install SolidFire bits -1. Once inside the PowerShell shell, install SolidFire PowerShell Tools by downloading it from the [PowerShell Gallery](https://powershellgallery.com) with the following command: +1. Once inside the PowerShell shell, install SolidFire PowerShell Tools by downloading it from the [PowerShell Gallery](powershellgallery.com) with the following command: - PS> Install-Module -Name SolidFire + PS> Install-Module -Name SolidFire.Core 1. Then, import the SolidFire module with the following command: - PS> Import-Module SolidFire + PS> Import-Module SolidFire.Core 1. To see a list of available commands, use: - PS> Get-Command -Module SolidFire + PS> Get-Command -Module SolidFire.Core ## Paths @@ -39,3 +39,7 @@ so the default host-specific profiles exists at `Microsoft.PowerShell_profile.ps `$PSHOME` is `/usr/local/microsoft/powershell/[version]/`, and the symlink is placed at `/usr/local/bin/powershell`. + +On Linux and macOS, the [XDG Base Directory Specification][xdg-bds] is respected. + +[xdg-bds]: https://specifications.freedesktop.org/basedir-spec/basedir-spec-latest.html diff --git a/docs/windows/README.md b/docs/windows/README.md index e72e019..97dca0d 100644 --- a/docs/windows/README.md +++ b/docs/windows/README.md @@ -1,10 +1,54 @@ -# To install SolidFire Powershell on Windows: +# To install NetApp SolidFire Powershell on Windows: -![solidfire-powershell-logo](../../Install/product.png) ![windows-logo](windows-logo-small.png) +![solidfire-powershell-logo](../../Install/product.png) ![windows-logo](windows10-logo-small.png) -This page has instructions for installing the SolidFire PowerShell tools module on a Windows client. +This page has instructions for installing the SolidFire PowerShell tools module on a Windows client. -## Prerequisites +There are two different versions. One for PowerShell 5.1, and one for PowerShell 6. With it being able to run on many types of systems with very few dependencies, we recommend you choose the PowerShell 6 version if possible. + +## Powershell 6.0 + +##### Prerequisites + +| Component | Version | +|----------------------|------------------| +| PowerShell | 6.0 or later | +| SolidFire Element OS | 7 through 10.0 | + +### Installation Instructions + +1. Once inside the PowerShell shell, install SolidFire PowerShell Tools by downloading it from the [PowerShell Gallery](powershellgallery.com) with the following command: + + PS> Install-Module -Name SolidFire.Core + +1. Then, import the SolidFire module with the following command: + + PS> Import-Module SolidFire.Core + +1. To see a list of available commands, use: + + PS> Get-Command -Module SolidFire.Core + +##### Supported Microsoft Operating Systems + +The following versions of Microsoft operating systems are supported, and have had the module tested on them. + +| Version | +|------------------------| +| Windows Server 2016 | +| Mac 10.13 | +| CentOS 7.3 | +| Ubuntu 16.04 | + +PowerShell 6 supports many more platforms, but extensive module testing has not been done. More than likely they work fine, but no guarantees are given. + +You can find that list here at [PowerShell Core 6.0](https://blogs.msdn.microsoft.com/powershell/2018/01/10/powershell-core-6-0-generally-available-ga-and-supported/). + + + +## PowerShell 5.1 and below + +##### Prerequisites | Component | Version | |----------------------|------------------| @@ -12,7 +56,24 @@ This page has instructions for installing the SolidFire PowerShell tools module | SolidFire Element OS | 7 through 10.0 | | .NET Framework | 4.5.1 or later | -## Installation Instructions +### Installation Instructions - Two methods are available + +#### PowerShell Gallery (Preferred Method) + +1. Once inside the PowerShell shell, install SolidFire PowerShell Tools by downloading it from the [PowerShell Gallery](powershellgallery.com) with the following command: + + PS> Install-Module -Name SolidFire + +1. Then, import the SolidFire module with the following command: + + PS> Import-Module SolidFire + +1. To see a list of available commands, use: + + PS> Get-Command -Module SolidFire + + +#### MSI Installer Download and launch the installer .msi file then follow the instructions in the install wizard. @@ -20,7 +81,7 @@ Download and launch the installer .msi file then follow the instructions in the ** Additional installation details can be found in the SolidFire PowerShell [User Guide Doc](https://github.com/solidfire/PowerShell/blob/master/Install/NetApp_SolidFire_PowerShell_Tools_v1.5_User_Guide.pdf) -## Supported Microsoft Operating Systems +##### Supported Microsoft Operating Systems The following versions of Microsoft operating systems are supported and can run the SolidFire PowerShell tools. diff --git a/docs/windows/windows10-logo-small.png b/docs/windows/windows10-logo-small.png new file mode 100644 index 0000000..8cad95b Binary files /dev/null and b/docs/windows/windows10-logo-small.png differ